SpringBoot 跨域問題的解決方案

更新時間：2019年06月11日 10:24:45 作者：啤酒就辣條

這篇文章主要介紹了SpringBoot 跨域問題的解決方案，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

什么是跨域？

定義：瀏覽器從一個域名的網(wǎng)頁取請求另一個域名下的東西。通俗點說，瀏覽器直接從A域訪問B域中的資源是不被允許的，如果想要訪問，就需要進行一步操作，這操作就叫“跨域”。例如，你從百度的頁面，點擊一個按鈕，請求了新浪的一個接口，這就進行了跨域。不單單只有域名不同就是跨域，域名、端口、協(xié)議其一不同就是不同的域，請求資源需要跨域。

為什么要跨域？

為什么需要跨域，而不直接訪問其他域下的資源呢？這是瀏覽器的限制，專業(yè)點說叫瀏覽器同源策略限制。主要是為了安全考慮?，F(xiàn)在的安全框架，一般請求的時候header中不是都存?zhèn)€token嘛，你要是用這個token去正常訪問A域下的東西是沒問題的，然后又去訪問了B域，結(jié)果陰差陽錯的還帶著這個token，那么B域，或者說B網(wǎng)站是不是就可以拿著你的token去A域下做點什么呢，這就相當危險了。所以瀏覽器加上了所謂的瀏覽器同源策略限制。但是為了我們真的需要從A域下訪問B的資源（正常訪問），就需要用到跨域，跨越這個限制了。

SpringBoot解決跨域問題

SpringBoot可以基于Cors解決跨域問題，Cors是一種機制，告訴我們的后臺，哪邊（origin ）來的請求可以訪問服務器的數(shù)據(jù)。
全局配置

配置實例如下：

@Configuration
public class CorsConfig implements WebMvcConfigurer {

  @Override
  public void addCorsMappings(CorsRegistry registry) {
    registry.addMapping("/**")
      .allowedOrigins("*")
      .allowCredentials(true)
      .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
      .maxAge(3600);
  }
}

首先實現(xiàn)了WebMvcConfigurer 接口，WebMvcConfigurer 這個接口十分強大，里面還有很多可用的方法，在SpringBoot2.0里面可以解決WebMvcConfigurerAdapter曾經(jīng)的部分任務。其中一個方法就是addCorsMappings()，是專門為開發(fā)人員解決跨域而誕生的接口。其中構(gòu)造參數(shù)為CorsRegistry。

看下CorsRegistry源碼，十分簡單：

public class CorsRegistry {

  private final List<CorsRegistration> registrations = new ArrayList<>();

  public CorsRegistration addMapping(String pathPattern) {
   CorsRegistration registration = new CorsRegistration(pathPattern);
   this.registrations.add(registration);
   return registration;
  }
  
  protected Map<String, CorsConfiguration> getCorsConfigurations() {
   Map<String, CorsConfiguration> configs = new LinkedHashMap<>(this.registrations.size());
   for (CorsRegistration registration : this.registrations) {
     configs.put(registration.getPathPattern(), registration.getCorsConfiguration());
   }
   return configs;
  }

}

可以看出CorsRegistry 有個屬性registrations ，按道理可以根據(jù)不同的項目路徑進行定制訪問行為，但是我們示例直接將pathPattern 設(shè)置為 /**，也就是說已覆蓋項目所有路徑，只需要創(chuàng)建一個CorsRegistration就好。getCorsConfigurations(),這個方法是獲取所有CorsConfiguration的Map集合，key值為傳入路徑pathPattern。

回到示例代碼CorsConfig中，registry對象addMapping()增加完傳入路徑pathPattern之后，return了一個CorsRegistration對象，是進行更多的配置，看一下CorsRegistration的代碼，看看我們能配些什么？

public class CorsRegistration {
  //傳入的路徑
  private final String pathPattern;
  //配置信息實體類
  private final CorsConfiguration config;
  //構(gòu)造方法
  public CorsRegistration(String pathPattern) {
   this.pathPattern = pathPattern;
   //原生注釋看到了一個 @CrossOrigin 這個注解，待會看看是什么
   // Same implicit default values as the @CrossOrigin annotation + allows simple methods
   this.config = new CorsConfiguration().applyPermitDefaultValues();
  }
  //允許哪些源網(wǎng)站訪問，默認所有
  public CorsRegistration allowedOrigins(String... origins) {
   this.config.setAllowedOrigins(Arrays.asList(origins));
   return this;
  }
  //允許何種方式訪問，默認簡單方式，即：GET，HEAD，POST
  public CorsRegistration allowedMethods(String... methods) {
   this.config.setAllowedMethods(Arrays.asList(methods));
   return this;
  }
  //設(shè)置訪問header，默認所有
  public CorsRegistration allowedHeaders(String... headers) {
   this.config.setAllowedHeaders(Arrays.asList(headers));
   return this;
  }
  //設(shè)置response headers，默認沒有（什么都不設(shè)置）
  public CorsRegistration exposedHeaders(String... headers) {
   this.config.setExposedHeaders(Arrays.asList(headers));
   return this;
  }
  //是否瀏覽器應該發(fā)送credentials，例如cookies Access-Control-Allow-Credentials
  public CorsRegistration allowCredentials(boolean allowCredentials) {
   this.config.setAllowCredentials(allowCredentials);
   return this;
  }
  //設(shè)置等待時間，默認1800秒
  public CorsRegistration maxAge(long maxAge) {
   this.config.setMaxAge(maxAge);
   return this;
  }

  protected String getPathPattern() {
   return this.pathPattern;
  }

  protected CorsConfiguration getCorsConfiguration() {
   return this.config;
  }

}

局部配置

剛才遇到一個@CrossOrigin這個注解，看看它是干什么的？

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CrossOrigin {

  /** @deprecated as of Spring 5.0, in favor of {@link CorsConfiguration#applyPermitDefaultValues} */
  @Deprecated
  String[] DEFAULT_ORIGINS = { "*" };

  /** @deprecated as of Spring 5.0, in favor of {@link CorsConfiguration#applyPermitDefaultValues} */
  @Deprecated
  String[] DEFAULT_ALLOWED_HEADERS = { "*" };

  /** @deprecated as of Spring 5.0, in favor of {@link CorsConfiguration#applyPermitDefaultValues} */
  @Deprecated
  boolean DEFAULT_ALLOW_CREDENTIALS = false;

  /** @deprecated as of Spring 5.0, in favor of {@link CorsConfiguration#applyPermitDefaultValues} */
  @Deprecated
  long DEFAULT_MAX_AGE = 1800

  /**
  * Alias for {@link #origins}.
  */
  @AliasFor("origins")
  String[] value() default {};

  @AliasFor("value")
  String[] origins() default {};

  String[] allowedHeaders() default {};

  String[] exposedHeaders() default {};

  RequestMethod[] methods() default {};

  String allowCredentials() default "";

  long maxAge() default -1;
}

這個注解可以作用于方法或者類上，實現(xiàn)局部跨域，你會發(fā)現(xiàn)除了設(shè)置路徑（因為沒必要了，都定位到局部了）其他的參數(shù)與全局類似。

小結(jié)

SpringBoot可以基于Cors解決跨域問題，可以設(shè)置全局跨域，也可以實現(xiàn)局部跨域，靈活配置方便使用。

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: