Spring Boot配置Cors解决跨域请求问题

同源策略简介

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

什么是源

[origin]就是协议、域名和端口号。例如:http://www.baidu.com:80这个URL。

什么是同源

若地址里面的协议、域名和端口号均相同则属于同源。

是否是同源的判断

例如判断下面的URL是否与http://www.a.com/test/index.html同源

  • http://www.a.com/dir/page.html 同源
  • http://www.child.a.com/test/index.html 不同源,域名不相同
  • https://www.a.com/test/index.html 不同源,协议不相同
  • http://www.a.com:8080/test/index.html 不同源,端口号不相同

哪些操作不受同源策略限制

  • 页面中的链接,重定向以及表单提交是不会受到同源策略限制的;
  • 跨域资源的引入是可以的。但是JS不能读写加载的内容。如嵌入到页面中的<script src="..."></script><img><link><iframe>等。

跨域

受前面所讲的浏览器同源策略的影响,不是同源的脚本不能操作其他源下面的对象。想要操作另一个源下的对象就需要跨域。
在同源策略的限制下,非同源的网站之间不能发送AJAX请求。

如何跨域

  • 降域

可以通过设置document.damain='a.com',浏览器就会认为它们都是同一个源。想要实现以上任意两个页面之间的通信,两个页面必须都设置document.damain='a.com'

  • JSONP跨域

  • CORS跨域

CORS 简介

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

CORS做到了如下两点:

  • 不破坏即有规则
  • 服务器实现了CORS接口,就可以跨源通信

基于这两点,CORS将请求分为两类:简单请求和非简单请求。

简单请求

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

  • Accept
  • Accept-Language
  • Content-Language
  • Last-Event-ID
  • Content-Type只限于 [application/x-www-form-urlencodedmultipart/form-datatext/plain] 类型

一个简单的请求例子:

1
2
3
4
5
GET /test HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate, sdch, br
Origin: http://www.examples.com
Host: www.examples.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

非简单请求

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

例如一个DELETE请求:

1
2
3
4
5
OPTIONS /test HTTP/1.1
Origin: http://www.examples.com
Access-Control-Request-Method: DELETE
Access-Control-Request-Headers: X-Custom-Header
Host: www.examples.com

CORS相关的字段有:

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

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

1
2
3
4
5
Access-Control-Allow-Origin: http://www.examples.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

使用@CrossOrigin注解实现

(1)如果想要对某一接口配置 CORS,可以在方法上添加@CrossOrigin注解 :

1
2
3
4
5
@CrossOrigin(origins = {"http://localhost:9000", "null"})
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String greetings() {
return "{\"project\":\"just a test\"}";
}

(2)如果想对一系列接口添加 CORS 配置,可以在类上添加注解,对该类声明所有接口都有效:

1
2
3
4
5
6
@CrossOrigin(origins = {"http://localhost:9000", "null"})
@RestController
@SpringBootApplication
public class SpringBootCorsTestApplication {

}

(3)如果想添加全局配置,则需要添加一个配置类 :

1
2
3
4
5
6
7
8
9
10
11
12
@Configuration
public class WebMvcConfig extends WebMvcConfigurer {

@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")
.maxAge(3600)
.allowCredentials(true);
}
}

或者在Application.java文件添加CorsRegistry配置

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@EnableConfigurationProperties({Config.class})
@EnableEurekaClient
@EnableFeignClients
@SpringBootApplication
public class AuthorityCenterApplication {

public static void main(String[] args) {
SpringApplication.run(AuthorityCenterApplication.class, args);
}

//全局配置跨域
@Bean
public WebMvcConfigurer corsConfigurer() {
return new WebMvcConfigurerAdapter() {
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/users/*").allowedOrigins("http://localhost:9527");
}
};
}
}

(4)另外,还可以通过添加Filter的方式,配置CORS规则,并手动指定对哪些接口有效。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Bean
public FilterRegistrationBean corsFilter() {
UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
CorsConfiguration config = new CorsConfiguration();
config.setAllowCredentials(true);
config.addAllowedOrigin("http://localhost:9000");
config.addAllowedOrigin("null");
config.addAllowedHeader("*");
config.addAllowedMethod("*");
source.registerCorsConfiguration("/**", config); // CORS 配置对所有接口都有效
FilterRegistrationBean bean = newFilterRegistrationBean(new CorsFilter(source));
bean.setOrder(0);
return bean;
}

原理剖析

无论是通过哪种方式配置CORS,其实都是在构造CorsConfiguration。 一个CORS配置用一个CorsConfiguration类来表示,它的定义如下:

1
2
3
4
5
6
7
8
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处理过程如下:

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

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

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

Powered by AppBlog.CN     浙ICP备14037229号

Copyright © 2012 - 2021 APP开发技术博客 All Rights Reserved.

访客数 : | 访问量 :