SpringBoot使用CORS解决跨域请求问题

Posted 朝雨忆轻尘

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot使用CORS解决跨域请求问题相关的知识,希望对你有一定的参考价值。

什么是跨域?

同源策略是浏览器的一个安全功能,不同源的客户端脚本在没有明确授权的情况下,不能读写对方资源。 同源策略是浏览器安全的基石。

如果一个请求地址里面的协议、域名和端口号都相同,就属于同源。

举个栗子

判断下面URL是否和 http://www.a.com/a/a.html 同源

  • http://www.a.com/b/b.html 同源
  • http://www.b.com/a/a.html 不同源,域名不相同
  • https://www.a.com/b/b.html 不同源,协议不相同
  • http://www.a.com:8080/b/b.html 不同源,端口号不相同

依据浏览器同源策略,非同源脚本不可操作其他源下面的对象。想要操作其他源下的对象就需要跨域。

综上所述,在同源策略的限制下,非同源的网站之间不能发送 AJAX 请求。如有需要,可通过降域或其他技术实现。

CORS 技术

为了解决浏览器跨域问题,W3C 提出了跨源资源共享方案,即 CORS(Cross-Origin Resource Sharing)。

CORS 可以在不破坏即有规则的情况下,通过后端服务器实现 CORS 接口,就可以实现跨域通信。

CORS 将请求分为两类:简单请求和非简单请求,分别对跨域通信提供了支持。

1、简单请求

CORS出现前,发送HTTP请求时在头信息中不能包含任何自定义字段,且 HTTP 头信息不超过以下几个字段:

  • Accept
  • Accept-Language
  • Content-Language
  • Last-Event-ID
  • Content-Type (仅限于 [application/x-www-form-urlencoded 、multipart/form-datatext/plain ] 类型)

一个简单请求的例子:

GET /test HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate, sdch, br
Origin: http://www.test.com
Host: www.test.com

对于简单请求,CORS的策略是请求时在请求头中增加一个Origin字段,服务器收到请求后,根据该字段判断是否允许该请求访问。

  • 如果允许,则在 HTTP 头信息中添加 Access-Control-Allow-Origin 字段,并返回正确的结果 ;
  • 如果不允许,则不在 HTTP 头信息中添加 Access-Control-Allow-Origin 字段 。

除了上面提到的 Access-Control-Allow-Origin ,还有几个字段用于描述 CORS 返回结果 :

  • Access-Control-Allow-Credentials: 可选,用户是否可以发送、处理 cookie
  • Access-Control-Expose-Headers:可选,可以让用户拿到的字段。有几个字段无论设置与否都可以拿到的,包括:Cache-ControlContent-LanguageContent-TypeExpiresLast-ModifiedPragma 。

2、非简单请求

对于非简单请求的跨源请求,浏览器会在真实请求发出前,增加一次OPTION请求,称为预检请求(preflight request)。预检请求将真实请求的信息,包括请求方法、自定义头字段、源信息添加到 HTTP 头信息字段中,询问服务器是否允许这样的操作。

例如一个GET请求:

OPTIONS /test HTTP/1.1
Origin: http://www.test.com
Access-Control-Request-Method: GET
Access-Control-Request-Headers: X-Custom-Header
Host: www.test.com

与 CORS 相关的字段有:

  • 请求使用的 HTTP 方法 Access-Control-Request-Method 
  • 请求中包含的自定义头字段 Access-Control-Request-Headers 

服务器收到请求时,需要分别对 OriginAccess-Control-Request-MethodAccess-Control-Request-Headers 进行验证,验证通过后,会在返回 HTTP头信息中添加 :

Access-Control-Allow-Origin: http://www.test.com
Access-Control-Allow-Methods: GET, POST, PUT, DELETE
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000

他们的含义分别是:

  • Access-Control-Allow-Methods: 真实请求允许的方法
  • Access-Control-Allow-Headers: 服务器允许使用的字段
  • Access-Control-Allow-Credentials: 是否允许用户发送、处理 cookie
  • Access-Control-Max-Age: 预检请求的有效期,单位为秒。有效期内,不会重复发送预检请求

当预检请求通过后,浏览器才会发送真实请求到服务器。这样就实现了跨域资源的请求访问。

Spring Boot CORS 实现

spring mvc 4.2版本增加了对cors的支持,通过spring boot可以非常简单的实现跨域访问。

使用@CrossOrigin 注解实现(局部)

接口方法注解 ,仅对该接口方法有效:

@CrossOrigin(origins = {"http://localhost:8088", "null"})
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String greetings() {
    return "{\\"project\\":\\"it is a test\\"}";
}

类注解,对该类声明所有接口都有效:

@CrossOrigin(origins = {"http://localhost:8088", "null"})
@RestController
@SpringBootApplication
public class SpringBootCorsTestApplication {
   ...
}

使用配置类实现(全局)

全局配置,作用全局,需要添加一个配置类 :

@Configuration
public class CorsConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")  // 允许跨域访问的路径
                .allowedOrigins("*")  // 允许跨域访问的源
                .allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")  // 允许请求方法
                .maxAge(168000)  // 预检间隔时间
                .allowCredentials(true);  // 是否发送cookie
    }
}

使用过滤器实现(全局)

全局过滤器,作用全局,需要添加一个过滤器 :

@Configuration
public class CorsConfig {
    @Bean
    public FilterRegistrationBean corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        CorsConfiguration config = new CorsConfiguration();
     // 是否发送cookie config.setAllowCredentials(
true); // 允许的网站域名,全允许则设为 * config.addAllowedOrigin("http://localhost:8088"); // 允许 HEADER 或 METHOD , * 为全部 config.addAllowedHeader("*"); config.addAllowedMethod("*"); source.registerCorsConfiguration("/**", config); FilterRegistrationBean bean = new FilterRegistrationBean(new CorsFilter(source)); // 这个顺序很重要,为避免麻烦请设置在最前 bean.setOrder(0); return bean; } }

简单原理解析

无论是通过哪种方式配置 CORS,其实都是在构造 CorsConfiguration

一个 CORS 配置用一个 CorsConfiguration类来表示,它的定义如下:

public class CorsConfiguration {
    private List<String> allowedOrigins;
    private List<String> allowedMethods;
    private List<String> allowedHeaders;
    private List<String> exposedHeaders;
    private Boolean allowCredentials;
    private Long maxAge;
}

Spring 中对 CORS 规则的校验,都是通过委托给 DefaultCorsProcessor实现的。

DefaultCorsProcessor 处理过程如下:

  1. 判断依据是 Header中是否包含 Origin。如果包含则说明为 CORS请求,转到 2;否则,说明不是 CORS 请求,不作任何处理。
  2. 判断 response 的 Header 是否已经包含 Access-Control-Allow-Origin,如果包含,证明已经被处理过了, 转到 3,否则不再处理。
  3. 判断是否同源,如果是则转交给负责该请求的类处理
  4. 是否配置了 CORS 规则,如果没有配置,且是预检请求,则拒绝该请求,如果没有配置,且不是预检请求,则交给负责该请求的类处理。如果配置了,则对该请求进行校验。

校验就是根据 CorsConfiguration 这个类的配置进行判断:

  1. 判断 origin 是否合法
  2. 判断 method 是否合法
  3. 判断 header是否合法
  4. 如果全部合法,则在 response header中添加响应的字段,并交给负责该请求的类处理,如果不合法,则拒绝该请求。

作者:朝雨忆轻尘
出处:https://www.cnblogs.com/xifengxiaoma/ 
版权所有,欢迎转载,转载请注明原文作者及出处。

以上是关于SpringBoot使用CORS解决跨域请求问题的主要内容,如果未能解决你的问题,请参考以下文章

springboot解决跨域问题跨域

使用CORS解决跨域问题

如何用CORS来解决JS中跨域的问题

实战,SpringBoot中如何解决CORS跨域问题~(文末送书)

springboot解决跨域问题(Cors)

实战,SpringBoot中如何解决CORS跨域问题~(文末送书)