SpringBoot開發技巧之如何處理跨域請求CORS

Posted on by

在前後分離的架構下，我們經常會遇到跨域CORS問題，在瀏覽器上的表現就是出現如下一段錯誤提示：

No ‘Access-Control-Allow-Origin’ header is present on the requested resource.

下面看一下如何讓你的SpringBoot項目支持CORS跨域。

SpringBoot處理跨域

在SpringBoot後端處理跨域比較簡單，隻需要在項目中添加如下一個配置類即可：

/**
 * Spring Boot 2.0 解決跨域問題
 * @Author javadaily
 */
@Configuration
public class WebMvcConfiguration implements WebMvcConfigurer { 
 @Bean
 public CorsFilter corsFilter() {
  final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();
  final CorsConfiguration corsConfiguration = new CorsConfiguration();
  /* 是否允許請求帶有驗證信息 */
  corsConfiguration.setAllowCredentials(true);
  /* 允許訪問的客戶端域名 */
  corsConfiguration.addAllowedOrigin("*");
  /* 允許服務端訪問的客戶端請求頭 */
  corsConfiguration.addAllowedHeader("*");
  /* 允許訪問的方法名,GET POST等 */
  corsConfiguration.addAllowedMethod("*");
  urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);
  return new CorsFilter(urlBasedCorsConfigurationSource);
 } 
}

這裡我們在配置類中註入瞭 CorsFilter並重寫瞭相關配置，大傢可以根據自己的業務需求請裡面的 * 改成具體的屬性值。

通過上面的配置我們基本可以解決後端跨域問題，但是在一些特定情況下還是還出現跨域。

特殊情況

當項目中還有一個自定義過濾器，並且在過濾器中通過 response.getWriter().print()直接向客戶端輸出返回信息：

在這種情況下是不會繼續執行後面的過濾器鏈的。

而在SpringBoot中自定義過濾器的優先級高於WebMvcConfigurer中定義的過濾器，所以此時由於未經過CORS過濾器的處理還是會出現跨域現象。

這種時候我們就需要改寫CorsFilter的寫法，讓其在自定義過濾器之前執行。

解決方法

自定義Cors過濾器

public class CustomerCorsFilter extends CorsFilter {
     public CustomerCorsFilter() {
        super(configurationSource());
    }
     private static UrlBasedCorsConfigurationSource configurationSource() {
        // CORS授權
        CorsConfiguration config = new CorsConfiguration();
        config.setAllowCredentials(true);
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        config.addAllowedMethod("*");
        config.addExposedHeader(HttpHeaders.SET_COOKIE);
        config.setMaxAge(3600L);
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", config);
                return source;
    } 
}

通過配置類指定過濾器的優先級

@Configuration
public class FilterConfig {
 
    @Bean
    public Filter authFilter(){
        return new AuthFilter();
    } 
    /**
     * WARNING ：跨域過濾器，註意執行順序，必須要在AuthFilter過濾器之後
     * @return
     */
    @Bean
    public FilterRegistrationBean corsFilterRegistration() {
         FilterRegistrationBean registration = new FilterRegistrationBean();
        //添加過濾器
        registration.setFilter(new CustomerCorsFilter());
        List<String> urlList = new ArrayList<>();
        urlList.add("/*");
        //設置過濾路徑，/*所有路徑
        registration.setUrlPatterns(urlList);
        //添加默認參數
        registration.setName("CorsFilter");
        //設置優先級
        registration.setOrder(-1);
        return registration;
    } 
    @Bean
    public FilterRegistrationBean authFilterRegistration() {
         FilterRegistrationBean registration = new FilterRegistrationBean();
        //添加過濾器
        registration.setFilter(authFilter());
        List<String> urlList = new ArrayList<>();
        urlList.add("/*");
        //設置過濾路徑，/*所有路徑
        registration.setUrlPatterns(urlList);
        //添加默認參數
        registration.setName("authFilter");
        //設置優先級
        registration.setOrder(1);
        return registration;
    }
 
}

通過setOrder()方法指定過濾器的執行順序，用以保證CORS過濾器先入自定義過濾器執行。

註意：order的順序越小優先級越高。

以上就是SpringBoot開發技巧之如何處理跨域請求CORS的詳細內容，更多關於SpringBoot開發處理跨域請求CORS的資料請關註WalkonNet其它相關文章！

推薦閱讀：