註解@CrossOrigin解決跨域問題

---

原文連接：https://www.mmzsblog.cn/articles/2019/08/23/1566526598886.html

註解@CrossOrigin

　　出於安全緣由，瀏覽器禁止Ajax調用駐留在當前原點以外的資源。例如，當你在一個標籤中檢查你的銀行帳戶時，你能夠在另外一個選項卡上擁有EVILL網站。來自EVILL的腳本不可以對你的銀行API作出Ajax請求（從你的賬戶中取出錢！）使用您的憑據。

　　跨源資源共享（CORS）是由大多數瀏覽器實現的W3C規範，容許您靈活地指定什麼樣的跨域請求被受權，而不是使用一些不太安全和不太強大的策略，如IFRAME或JSONP。

1、跨域(CORS)支持：

　　Spring Framework 4.2 GA爲CORS提供了第一類支持，使您比一般的基於過濾器的解決方案更容易和更強大地配置它。因此springMVC的版本要在4.2或以上版本才支持@CrossOrigin

2、使用方法：

一、controller配置CORS

1.一、controller方法的CORS配置，您能夠向@RequestMapping註解處理程序方法添加一個@CrossOrigin註解，以便啓用CORS（默認狀況下，@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個參數：

origins  ： 容許可訪問的域列表

maxAge：準備響應前的緩存持續的最大時間（以秒爲單位）。

1.二、爲整個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) {
        // ...
    }
}

在這個例子中，對於retrieve()和remove()處理方法都啓用了跨域支持，還能夠看到如何使用@CrossOrigin屬性定製CORS配置。

1.三、同時使用controller和方法級別的CORS配置，Spring將合併兩個註釋屬性以建立合併的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.四、若是您正在使用Spring Security，請確保在Spring安全級別啓用CORS，並容許它利用Spring MVC級別定義的配置。

@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

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

二、全局CORS配置

　　除了細粒度、基於註釋的配置以外，您還可能須要定義一些全局CORS配置。這相似於使用篩選器，但能夠聲明爲Spring MVC並結合細粒度@CrossOrigin配置。默認狀況下，全部origins and GET, HEAD and POST methods是容許的。

JavaConfig

使整個應用程序的CORS簡化爲：

@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配置應用到特定的路徑模式：

@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，請確保在Spring安全級別啓用CORS，並容許它利用Spring MVC級別定義的配置。

三、XML命名空間

還能夠將CORS與MVC XML命名空間配置。

a、若是整個項目全部方法均可以訪問，則能夠這樣配置；此最小XML配置使CORS在/**路徑模式具備與JavaConfig相同的缺省屬性：

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

其中* 表示匹配到下一層；** 表示後面無論有多少層，都能匹配。

如：

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

這個能夠匹配到的路徑有：

/api/aaa

/api/bbbb

不能匹配的：

/api/aaa/bbb

由於* 只能匹配到下一層路徑，若是想後面無論多少層均可以匹配，配置以下：

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

注：其實就是一個(*)變成兩個(**)

b、也能夠用定製屬性聲明幾個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>

請求路徑有/api/，方法示例以下：

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

c、若是使用Spring Security，不要忘記在Spring安全級別啓用CORS：

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

四、How does it work?

　　CORS請求（包括預選的帶有選項方法）被自動發送到註冊的各類HandlerMapping 。它們處理CORS準備請求並攔截CORS簡單和實際請求，這得益於CorsProcessor實現（默認狀況下默認DefaultCorsProcessor處理器），以便添加相關的CORS響應頭（如Access-Control-Allow-Origin）。 CorsConfiguration 容許您指定CORS請求應該如何處理：容許origins, headers, methods等。

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

b、子類能夠經過重寫AbstractHandlerMapping類的getCorsConfiguration(Object, HttpServletRequest)方法來提供本身的CorsConfiguration。

c、處理程序能夠實現 CorsConfigurationSource接口（如ResourceHttpRequestHandler），以便爲每一個請求提供一個CorsConfiguration。

五、基於過濾器的CORS支持

　　做爲上述其餘方法的替代，Spring框架還提供了CorsFilter。在這種狀況下，不用使用@CrossOrigin或WebMvcConfigurer#addCorsMappings(CorsRegistry),，例如，能夠在Spring Boot應用程序中聲明以下的過濾器：

@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;
    }
}

3、spring註解@CrossOrigin不起做用的緣由

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

二、非@CrossOrigin沒有解決跨域請求問題，而是不正確的請求致使沒法獲得預期的響應，致使瀏覽器端提示跨域問題。

三、在Controller註解上方添加@CrossOrigin註解後，仍然出現跨域問題，解決方案之一就是：

在@RequestMapping註解中沒有指定Get、Post方式，具體指定後，問題解決。

相似代碼以下：

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

4、參考文章：

一、官方文檔https://spring.io/blog/2015/06/08/cors-support-in-spring-framework

二、http://fanshuyao.iteye.com/blog/2384189

二、https://blog.csdn.net/taiyangnimeide/article/details/78305131

三、https://blog.csdn.net/snowin1994/article/details/53035433