配置 CORS
出于安全原因,浏览器禁止向当前来源以外的资源发起 AJAX 调用。当处理由浏览器发起的客户端 HTTP 请求时,您可能希望启用对特定 HTTP 资源的访问。
从 2.6 版开始,Spring Data REST 通过 Spring 的 CORS 支持实现 跨域资源共享(CORS)。
存储库接口 CORS 配置
您可以向存储库接口添加 @CrossOrigin 注解,以启用整个存储库的 CORS。默认情况下,@CrossOrigin 允许所有来源和 HTTP 方法。以下示例展示了一个跨域存储库接口定义:
@CrossOrigin
interface PersonRepository extends CrudRepository<Person, Long> {}
在前面的示例中,PersonRepository 的 CORS 支持已启用。@CrossOrigin 提供用于配置 CORS 支持的属性,如下例所示:
@CrossOrigin(origins = "http://domain2.example",
methods = { RequestMethod.GET, RequestMethod.POST, RequestMethod.DELETE },
maxAge = 3600)
interface PersonRepository extends CrudRepository<Person, Long> {}
前面的示例通过提供一个来源,限制为 GET、POST 和 DELETE 方法,并将最大年龄设置为 3600 秒,为整个 PersonRepository 启用了 CORS 支持。
存储库 REST 控制器方法 CORS 配置
Spring Data REST 完全支持 Spring Web MVC 的控制器方法配置,适用于共享存储库基本路径的自定义 REST 控制器,如下例所示:
@RepositoryRestController
public class PersonController {
@CrossOrigin(maxAge = 3600)
@RequestMapping(path = "/people/xml/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_XML_VALUE)
public Person retrieve(@PathVariable Long id) {
// …
}
}
用 @RepositoryRestController 注解的控制器继承其相关存储库的 @CrossOrigin 配置。 |
全局 CORS 配置
除了细粒度的、基于注解的配置外,您可能还希望定义一些全局 CORS 配置。这类似于 Spring Web MVC 的 CORS 配置,但可以在 Spring Data REST 中声明,并与细粒度的 @CrossOrigin 配置结合使用。默认情况下,允许所有来源和 GET、HEAD 和 POST 方法。
| 现有的 Spring Web MVC CORS 配置不适用于 Spring Data REST。 |
以下示例设置了允许的来源,添加了 PUT 和 DELETE HTTP 方法,添加并公开了一些头信息,并将最大年龄设置为一小时:
@Component
public class SpringDataRestCustomization implements RepositoryRestConfigurer {
@Override
public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config, CorsRegistry cors) {
cors.addMapping("/person/**")
.allowedOrigins("http://domain2.example")
.allowedMethods("PUT", "DELETE")
.allowedHeaders("header1", "header2", "header3")
.exposedHeaders("header1", "header2")
.allowCredentials(false).maxAge(3600);
}
}