注解@CrossOrigin

出于安全原因，瀏覽器禁止Ajax調(diào)用駐留在當(dāng)前原點(diǎn)之外的資源。例如，當(dāng)你在一個(gè)標(biāo)簽中檢查你的銀行賬戶(hù)時(shí)，你可以在另一個(gè)選項(xiàng)卡上擁有EVILL網(wǎng)站。來(lái)自EVILL的腳本不能夠?qū)δ愕你y行API做出Ajax請(qǐng)求（從你的帳戶(hù)中取出錢(qián)?。┦褂媚膽{據(jù)。

跨源資源共享（CORS）是由大多數(shù)瀏覽器實(shí)現(xiàn)的W3C規(guī)范，允許您靈活地指定什么樣的跨域請(qǐng)求被授權(quán)，而不是使用一些不太安全和不太強(qiáng)大的策略，如IFRAME或JSONP。

一、跨域(CORS)支持：

Spring Framework 4.2 GA為CORS提供了第一類(lèi)支持，使您比通常的基于過(guò)濾器的解決方案更容易和更強(qiáng)大地配置它。所以springMVC的版本要在4.2或以上版本才支持@CrossOrigin

二、使用方法：

1、controller配置CORS

1.1、controller方法的CORS配置，您可以向@RequestMapping注解處理程序方法添加一個(gè)@CrossOrigin注解，以便啟用CORS（默認(rèn)情況下，@CrossOrigin允許在@RequestMapping注解中指定的所有源和HTTP方法）：

@RestController
@RequestMapping("/account") public class AccountController {

 @CrossOrigin
 @GetMapping("/{id}") public Account retrieve(@PathVariable Long id) { // ...
 }

 @DeleteMapping("/{id}") public void remove(@PathVariable Long id) { // ...
 }
}

其中@CrossOrigin中的2個(gè)參數(shù)：

origins ： 允許可訪問(wèn)的域列表

maxAge：準(zhǔn)備響應(yīng)前的緩存持續(xù)的最大時(shí)間（以秒為單位）。

1.2、為整個(gè)controller啟用@CrossOrigin

@CrossOrigin(origins = "http://domain2.com", maxAge = 3600)
@RestController
@RequestMapping("/account") public class AccountController {

 @GetMapping("/{id}") public Account retrieve(@PathVariable Long id) { // ...
 }

 @DeleteMapping("/{id}") public void remove(@PathVariable Long id) { // ...
 }
}

在這個(gè)例子中，對(duì)于retrieve()和remove()處理方法都啟用了跨域支持，還可以看到如何使用@CrossOrigin屬性定制CORS配置。

1.3、同時(shí)使用controller和方法級(jí)別的CORS配置，Spring將合并兩個(gè)注釋屬性以創(chuàng)建合并的CORS配置。

@CrossOrigin(maxAge = 3600)
@RestController
@RequestMapping("/account") public class AccountController {

 @CrossOrigin(origins = "http://domain2.com")
 @GetMapping("/{id}") public Account retrieve(@PathVariable Long id) { // ...
 }

 @DeleteMapping("/{id}") public void remove(@PathVariable Long id) { // ...
 }
}

1.4、如果您正在使用Spring Security，請(qǐng)確保在Spring安全級(jí)別啟用CORS，并允許它利用Spring MVC級(jí)別定義的配置。

@EnableWebSecurity public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

 @Override protected void configure(HttpSecurity http) throws Exception {
 http.cors().and()...
 }
}

2、全局CORS配置

除了細(xì)粒度、基于注釋的配置之外，您還可能需要定義一些全局CORS配置。這類(lèi)似于使用篩選器，但可以聲明為Spring MVC并結(jié)合細(xì)粒度@CrossOrigin配置。默認(rèn)情況下，所有origins and GET, HEAD and POST methods是允許的。

JavaConfig

使整個(gè)應(yīng)用程序的CORS簡(jiǎn)化為：

@Configuration
@EnableWebMvc public class WebConfig extends WebMvcConfigurerAdapter {

 @Override public void addCorsMappings(CorsRegistry registry) {
 registry.addMapping("/**");
 }
}

如果您正在使用Spring Boot，建議將WebMvcConfigurer bean聲明如下：

@Configuration public class MyConfiguration {

 @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurerAdapter() {
 @Override public void addCorsMappings(CorsRegistry registry) {
 registry.addMapping("/**");
 }
 };
 }
}

您可以輕松地更改任何屬性，以及僅將此CORS配置應(yīng)用到特定的路徑模式：

@Override public void addCorsMappings(CorsRegistry registry) {
 registry.addMapping("/api/**")
 .allowedOrigins("http://domain2.com")
 .allowedMethods("PUT", "DELETE")
 .allowedHeaders("header1", "header2", "header3")
 .exposedHeaders("header1", "header2")
 .allowCredentials(false).maxAge(3600);
}

如果您正在使用Spring Security，請(qǐng)確保在Spring安全級(jí)別啟用CORS，并允許它利用Spring MVC級(jí)別定義的配置。

3、XML命名空間

還可以將CORS與MVC XML命名空間配置。

a、如果整個(gè)項(xiàng)目所有方法都可以訪問(wèn)，則可以這樣配置；此最小XML配置使CORS在/**路徑模式具有與JavaConfig相同的缺省屬性：

<mvc:cors>
 <mvc:mapping path="/**" />
</mvc:cors>

其中 表示匹配到下一層；***** 表示后面不管有多少層，都能匹配。**

如：

<mvc:cors> 
 <mvc:mapping path="/api/*"/> 
</mvc:cors> 

這個(gè)可以匹配到的路徑有：

/api/aaa

/api/bbbb

不能匹配的：

/api/aaa/bbb

因?yàn)? 只能匹配到下一層路徑，如果想后面不管多少層都可以匹配，配置如下：

<mvc:cors> 
 <mvc:mapping path="/api/**"/> 
</mvc:cors>

注：其實(shí)就是一個(gè)(*)變成兩個(gè)(**)

b、也可以用定制屬性聲明幾個(gè)CORS映射：

<mvc:cors>
<mvc:mapping path="/api/**" allowed-origins="http://domain1.com, http://domain2.com" allowed-methods="GET, PUT" allowed-headers="header1, header2, header3" exposed-headers="header1, header2" allow-credentials="false" max-age="123" />
<mvc:mapping path="/resources/**" allowed-origins="http://domain1.com" />
</mvc:cors>

請(qǐng)求路徑有/api/，方法示例如下：

@RequestMapping("/api/crossDomain") 
@ResponseBody public String crossDomain(HttpServletRequest req, HttpServletResponse res, String name){ 
 …… 
 …… 
} 

c、如果使用Spring Security，不要忘記在Spring安全級(jí)別啟用CORS：

<http>
<!-- Default to Spring MVC's CORS configuration -->
<cors /> ... </http>

4、How does it work?

CORS請(qǐng)求（包括預(yù)選的帶有選項(xiàng)方法）被自動(dòng)發(fā)送到注冊(cè)的各種HandlerMapping 。它們處理CORS準(zhǔn)備請(qǐng)求并攔截CORS簡(jiǎn)單和實(shí)際請(qǐng)求，這得益于CorsProcessor實(shí)現(xiàn)（默認(rèn)情況下默認(rèn)DefaultCorsProcessor處理器），以便添加相關(guān)的CORS響應(yīng)頭（如Access-Control-Allow-Origin）。 CorsConfiguration 允許您指定CORS請(qǐng)求應(yīng)該如何處理：允許origins, headers, methods等。

a、AbstractHandlerMapping#setCorsConfiguration() 允許指定一個(gè)映射，其中有幾個(gè)CorsConfiguration 映射在路徑模式上，比如/api/**。

b、子類(lèi)可以通過(guò)重寫(xiě)AbstractHandlerMapping類(lèi)的getCorsConfiguration(Object, HttpServletRequest)方法來(lái)提供自己的CorsConfiguration。

c、處理程序可以實(shí)現(xiàn) CorsConfigurationSource接口（如ResourceHttpRequestHandler），以便為每個(gè)請(qǐng)求提供一個(gè)CorsConfiguration。

5、基于過(guò)濾器的CORS支持

作為上述其他方法的替代，Spring框架還提供了CorsFilter。在這種情況下，不用使用@CrossOrigin或 WebMvcConfigurer#addCorsMappings(CorsRegistry)，例如，可以在Spring Boot應(yīng)用程序中聲明如下的過(guò)濾器：

@Configuration public class MyConfiguration {

 @Bean public FilterRegistrationBean corsFilter() {
 UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
 CorsConfiguration config = new CorsConfiguration();
 config.setAllowCredentials(true);
 config.addAllowedOrigin("http://domain1.com");
 config.addAllowedHeader("*");
 config.addAllowedMethod("*");
 source.registerCorsConfiguration("/**", config);
 FilterRegistrationBean bean = new FilterRegistrationBean(new CorsFilter(source));
 bean.setOrder(0); return bean;
 }
}

三、spring注解@CrossOrigin不起作用的原因

1、是springMVC的版本要在4.2或以上版本才支持@CrossOrigin

2、非@CrossOrigin沒(méi)有解決跨域請(qǐng)求問(wèn)題，而是不正確的請(qǐng)求導(dǎo)致無(wú)法得到預(yù)期的響應(yīng)，導(dǎo)致瀏覽器端提示跨域問(wèn)題。

3、在Controller注解上方添加@CrossOrigin注解后，仍然出現(xiàn)跨域問(wèn)題，解決方案之一就是：

在@RequestMapping注解中沒(méi)有指定Get、Post方式，具體指定后，問(wèn)題解決。

類(lèi)似代碼如下：

@CrossOrigin
@RestController public class person{ 
 @RequestMapping(method = RequestMethod.GET) public String add() { // 若干代碼
 }
}

以上這篇注解@CrossOrigin解決跨域的問(wèn)題就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論