1. 程式人生 > 其它 >SpringBoot 中實現跨域的方式

SpringBoot 中實現跨域的方式

SpringBoot 中實現跨域的方式

1、為什麼會出現跨域問題

當一個請求url的協議、域名、埠三者之間任意一個與當前頁面url不同即為跨域

出於瀏覽器的同源策略(Sameoriginpolicy)限制。同源策略是一種約定,它是瀏覽器最核心也最基本的安全功能,如果缺少了同源策略,則瀏覽器的正常功能可能都會受到影響。可以說Web是構建在同源策略基礎之上的,瀏覽器只是針對同源策略的一種實現。

同源策略會阻止一個域的javascript指令碼和另外一個域的內容進行互動。所謂同源(即指在同一個域)就是兩個頁面具有相同的協議(protocol),主機(host)和埠號(port)


2、實現 CORS 跨域請求的方式

對於 CORS的跨域請求,主要有以下幾種方式選擇:

  1. 返回新的CorsFilter

  2. 重寫 WebMvcConfigurer

  3. 使用註解 @CrossOrigin

  4. 手動設定響應頭 (HttpServletResponse)

  5. 自定web filter 實現跨域

注意:

  • CorFilter / WebMvConfigurer / @CrossOrigin 需要 SpringMVC 4.2以上版本才支援,對應springBoot 1.3版本以上

  • 上面前兩種方式屬於全域性 CORS 配置,後兩種屬於區域性 CORS配置。如果使用了局部跨域是會覆蓋全域性跨域的規則,所以可以通過 @CrossOrigin 註解來進行細粒度更高的跨域資源控制。

  • 其實無論哪種方案,最終目的都是修改響應頭,向響應頭中新增瀏覽器所要求的資料,進而實現跨域

2.1 CorsFilter(全域性跨域)

在任意配置類,返回一個 新的 CorsFIlter Bean ,並新增對映路徑和具體的CORS配置路徑。

@Configuration
public class GlobalCorsConfig {
    @Bean
    public CorsFilter corsFilter() {
        //1. 新增 CORS配置資訊
        CorsConfiguration config = new CorsConfiguration();
        
//放行哪些原始域 config.addAllowedOrigin("*"); //是否傳送 Cookie config.setAllowCredentials(true); //放行哪些請求方式 config.addAllowedMethod("*"); //放行哪些原始請求頭部資訊 config.addAllowedHeader("*"); //暴露哪些頭部資訊 config.addExposedHeader("*"); //2. 新增對映路徑 UrlBasedCorsConfigurationSource corsConfigurationSource = new UrlBasedCorsConfigurationSource(); corsConfigurationSource.registerCorsConfiguration("/**",config); //3. 返回新的CorsFilter return new CorsFilter(corsConfigurationSource); } }

2.2 WebMvcConfigurer(全域性跨域)

@Configuration
public class CorsConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                //是否傳送Cookie
                .allowCredentials(true)
                //放行哪些原始域
                .allowedOrigins("*")
                .allowedMethods(new String[]{"GET", "POST", "PUT", "DELETE"})
                .allowedHeaders("*")
                .exposedHeaders("*");
    }
}

2.3 使用註解 (區域性跨域)

在控制器(類上)上使用註解 @CrossOrigin:,表示該類的所有方法允許跨域。

@RestController
@CrossOrigin(origins = "*")
public class HelloController {
    @RequestMapping("/hello")
    public String hello() {
        return "hello world";
    }
}

在方法上使用註解 @CrossOrigin:

@RequestMapping("/hello")
@CrossOrigin(origins = "*")
//@CrossOrigin(value = "http://localhost:8081") //指定具體ip允許跨域
public String hello() {
  return "hello world";
}

2.4 手動設定響應頭(區域性跨域)

使用 HttpServletResponse 物件新增響應頭(Access-Control-Allow-Origin)來授權原始域,這裡 Origin的值也可以設定為 “*”,表示全部放行。

@RequestMapping("/index")
public String index(HttpServletResponse response) {
    response.addHeader("Access-Allow-Control-Origin","*");
    return "index";
}

2.5 filter實現跨域

首先編寫一個過濾器,可以起名字為MyCorsFilter.java

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;

@Component
public class MyCorsFilter implements Filter {
    
  public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOException, ServletException {
    HttpServletResponse response = (HttpServletResponse) res;
    response.setHeader("Access-Control-Allow-Origin", "*");
    response.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE");
    response.setHeader("Access-Control-Max-Age", "3600");
    response.setHeader("Access-Control-Allow-Headers", "x-requested-with,content-type");
    chain.doFilter(req, res);
  }
    
  public void init(FilterConfig filterConfig) {}
    
  public void destroy() {}
}

在web.xml中配置這個過濾器,使其生效

<!-- 跨域訪問 START-->
<filter>
    <filter-name>CorsFilter</filter-name>
    <filter-class>com.mesnac.aop.MyCorsFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>CorsFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<!-- 跨域訪問 END  -->