配置 CORS
出于安全原因,浏览器禁止对驻留在当前源之外的资源进行 AJAX 调用。在处理浏览器发出的客户端 HTTP 请求时,您希望允许访问特定的 HTTP 资源。
Spring Data REST 从 2.6 开始,通过 Spring 的 CORS 支持支持跨域资源共享 (CORS)。
存储库接口 CORS 配置
您可以添加@CrossOrigin
注解添加到您的存储库接口中,以便为整个存储库启用 CORS。默认情况下,@CrossOrigin
允许所有源和 HTTP 方法。以下示例显示了跨源存储库接口定义:
@CrossOrigin
interface PersonRepository extends CrudRepository<Person, Long> {}
在前面的示例中,为整个PersonRepository
.@CrossOrigin
提供用于配置 CORS 支持的属性,如下例所示:
@CrossOrigin(origins = "http://domain2.example",
methods = { RequestMethod.GET, RequestMethod.POST, RequestMethod.DELETE },
maxAge = 3600)
interface PersonRepository extends CrudRepository<Person, Long> {}
前面的示例为整个PersonRepository
通过提供一个源,仅限于GET
,POST
和DELETE
方法,最大存在时间为 3600 秒。
存储库 REST 控制器方法 CORS 配置
Spring Data REST 完全支持在共享存储库基本路径的自定义 REST 控制器上的 Spring Web MVC 的控制器方法配置,如下例所示:
@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 配置
除了基于 Comments 的细粒度配置之外,您可能还希望定义一些全局 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);
}
}