20. CORS 支持

20.1 简介

出于安全考虑,浏览器禁止AJAX调用驻留在当前来源之外的资源。 例如,当您在一个标签中检查您的银行帐户时,您可以在另一个标签中打开evil.com网站。 evil.com的脚本不能使用您的凭据向您的银行API发出AJAX请求(例如,从您的帐户中提款)!

Cross-origin resource sharing(CORS) 是 大多数浏览器实现的W3C规范,允许您以灵活的方式指定什么样的跨域请求被授权,而不是使用一些较不安全和不太强大的黑客工具(如IFRAME或JSONP)。

从Spring Framework 4.2开始,CORS支持开箱即用。. CORS 请求(including preflight ones with anOPTIONSmethod) 被自动调度到各种已注册的HandlerMappings. 由于CorsProcessor的实现(默认为DefaultCorsProcessor),为了根据您提供的CORS配置添加相关的CORS响应头(如Access-Control-Allow-Origin),它们处理CORS预检请求并拦截CORS简单实际的请求。

20.2 Controller 方法CORS 配置

你如果想使用CORS ,可以在@RequestMapping上增加@CrossOrigin注解. 默认情况下@CrossOrigin允许@RequestMapping注释中指定的所有起始点和HTTP方法:

  1. @RestController
  2. @RequestMapping("/account")
  3. public class AccountController {
  4. @CrossOrigin
  5. @RequestMapping("/{id}")
  6. public Account retrieve(@PathVariable Long id) {
  7. // ...
  8. }
  9. @RequestMapping(method = RequestMethod.DELETE, path = "/{id}")
  10. public void remove(@PathVariable Long id) {
  11. // ...
  12. }
  13. }

对于整个 controller的CORS 的支持:

  1. @CrossOrigin(origins = "http://domain2.com", maxAge = 3600)
  2. @RestController
  3. @RequestMapping("/account")
  4. public class AccountController {
  5. @RequestMapping("/{id}")
  6. public Account retrieve(@PathVariable Long id) {
  7. // ...
  8. }
  9. @RequestMapping(method = RequestMethod.DELETE, path = "/{id}")
  10. public void remove(@PathVariable Long id) {
  11. // ...
  12. }
  13. }

在上面的例子中,retrieve()remove()对实现了对CORS 的支持,因此你可以使用@CrossOrigin 属性对自已的程序进行自定义的CORS 配置。

您甚至可以同时使用控制器级和方法级的CORS配置; 然后,Spring将组合两个注释的属性以创建合并的CORS配置。

  1. @CrossOrigin(maxAge = 3600)
  2. @RestController
  3. @RequestMapping("/account")
  4. public class AccountController {
  5. @CrossOrigin("http://domain2.com")
  6. @RequestMapping("/{id}")
  7. public Account retrieve(@PathVariable Long id) {
  8. // ...
  9. }
  10. @RequestMapping(method = RequestMethod.DELETE, path = "/{id}")
  11. public void remove(@PathVariable Long id) {
  12. // ...
  13. }
  14. }

20.3 全局CORS 配置

除了细粒度,基于注释的配置,您也可能想要定义一些全局CORS配置。 这与使用过滤器类似,但可以在Spring MVC中声明,并结合细粒度的@CrossOrigin配置。 默认情况下,所有起始点和GET,HEAD和POST方法都是允许的。

20.3.1 JavaConfig

配置全局CORS 如下所示:

  1. @Configuration
  2. @EnableWebMvc
  3. public class WebConfig extends WebMvcConfigurerAdapter {
  4. @Override
  5. public void addCorsMappings(CorsRegistry registry) {
  6. registry.addMapping("/**");
  7. }
  8. }

你也可以轻易的改变任意属性,以及仅将此CORS配置应用于特定路径模式:

  1. @Configuration
  2. @EnableWebMvc
  3. public class WebConfig extends WebMvcConfigurerAdapter {
  4. @Override
  5. public void addCorsMappings(CorsRegistry registry) {
  6. registry.addMapping("/api/**")
  7. .allowedOrigins("http://domain2.com")
  8. .allowedMethods("PUT", "DELETE")
  9. .allowedHeaders("header1", "header2", "header3")
  10. .exposedHeaders("header1", "header2")
  11. .allowCredentials(false).maxAge(3600);
  12. }
  13. }

20.3.2 XML 命名空间

以下最小的XML配置为/ **路径模式启用CORS,具有与上述JavaConfig示例相同的默认属性:

  1. <mvc:cors>
  2. <mvc:mapping path="/**" />
  3. </mvc:cors>

也可以使用自定义属性声明几个CORS映射:

  1. <mvc:cors>
  2. <mvc:mapping path="/api/**"
  3. allowed-origins="http://domain1.com, http://domain2.com"
  4. allowed-methods="GET, PUT"
  5. allowed-headers="header1, header2, header3"
  6. exposed-headers="header1, header2" allow-credentials="false"
  7. max-age="123" />
  8. <mvc:mapping path="/resources/**"
  9. allowed-origins="http://domain1.com" />
  10. </mvc:cors>

20.4 高级自定义

CorsConfiguration 允许你定义CORS 请求怎样被处理: 允许origins, headers, methods, 如.:他可以使用以下几种方式处理:

20.5 基于 CORS 支持的过滤

为了支持基于过滤器的安全框架(如Spring Security)的CORS,或者与其他不支持本地CORS的库一起支持CORS,Spring Framework还提供了一个 CorsFilter. 而不是使用@CrossOrigin或WebMvcConfigurer#addCorsMappings(CorsRegistry),您需要注册一个自定义过滤器,如下所示:

  1. import org.springframework.web.cors.CorsConfiguration;
  2. import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
  3. import org.springframework.web.filter.CorsFilter;
  4. public class MyCorsFilter extends CorsFilter {
  5. public MyCorsFilter() {
  6. super(configurationSource());
  7. }
  8. private static UrlBasedCorsConfigurationSource configurationSource() {
  9. CorsConfiguration config = new CorsConfiguration();
  10. config.setAllowCredentials(true);
  11. config.addAllowedOrigin("http://domain1.com");
  12. config.addAllowedHeader("*");
  13. config.addAllowedMethod("*");
  14. UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
  15. source.registerCorsConfiguration("/**", config);
  16. return source;
  17. }
  18. }

您需要确保CorsFilter在其他过滤器之前过滤, 请参考this blog post ,了解如何配置Spring Boot。