Spring Boot 解決跨域問題的 3 種方案

前後端分離大勢所趨，跨域問題更是老生常談，隨便用標題去 google 或百度一下，能搜出一大片解決方案，那麼爲啥又要寫一遍呢，不急往下看。

問題背景：

Same Origin Policy，譯爲 “同源策略”。它是對於客戶端腳本（尤其是 JavaScript）的重要安全度量標準，其目的在於防止某個文檔或者腳本從多個不同 “origin”（源）裝載。

它認爲自任何站點裝載的信賴內容是不安全的。當被瀏覽器半信半疑的腳本運行在沙箱時，它們應該只被允許訪問來自同一站點的資源，而不是那些來自其它站點可能懷有惡意的資源。

注：具有相同的 Origin，也即是擁有相同的協議、主機地址以及端口。一旦這三項數據中有一項不同，那麼該資源就將被認爲是從不同的 Origin 得來的，進而不被允許訪問。

CORS 就是爲了解決 SOP 問題而生的，當然 CORS 不是唯一的解決方案，不過這裏不贅述其他解決辦法了。

CORS 簡介:

CORS 是一個 W3C 標準，全稱是 " 跨域資源共享”（Cross-origin resource sharing）。它允許瀏覽器向跨源 (協議 + 域名 + 端口) 服務器，發出 XMLHttpRequest 請求，從而克服了 AJAX 只能同源使用的限制。CORS 需要瀏覽器和服務器同時支持。它的通信過程，都是瀏覽器自動完成，不需要用戶參與。

對於開發者來說，CORS 通信與同源的 AJAX/Fetch 通信沒有差別，代碼完全一樣。瀏覽器一旦發現請求跨源，就會自動添加一些附加的頭信息，有時還會多出一次附加的請求，但用戶不會有感覺。因此，實現 CORS 通信的關鍵是服務器。只要服務器實現了 CORS 接口，就可以跨源通信。

瀏覽器將 CORS 請求分成兩類：簡單請求（simple request）和非簡單請求（not-so-simple request）。

瀏覽器發出 CORS 簡單請求，只需要在頭信息之中增加一個 Origin 字段。

瀏覽器發出 CORS 非簡單請求，會在正式通信之前，增加一次 OPTIONS 查詢請求，稱爲 "預檢" 請求（preflight）。瀏覽器先詢問服務器，當前網頁所在的域名是否在服務器的許可名單之中，以及可以使用哪些 HTTP 動詞和頭信息字段。只有得到肯定答覆，瀏覽器纔會發出正式的 XMLHttpRequest 請求，否則就報錯。

簡單請求就是 HEAD、GET、POST 請求，並且 HTTP 的頭信息不超出以下幾種字段 Accept、Accept-Language、Content-Language、Last-Event-ID、Content-Type 注：Content-Type：只限於三個值 application/x-www-form-urlencoded、multipart/form-data、text/plain

反之，就是非簡單請求。

其實實現 CORS 很簡單，就是在服務端加一些響應頭，並且這樣做對前端來說是無感知的，很方便。

詳解響應頭：

Access-Control-Allow-Origin 該字段必填。它的值要麼是請求時 Origin 字段的具體值，要麼是一個 *，表示接受任意域名的請求。
Access-Control-Allow-Methods 該字段必填。它的值是逗號分隔的一個具體的字符串或者 *，表明服務器支持的所有跨域請求的方法。注意，返回的是所有支持的方法，而不單是瀏覽器請求的那個方法。這是爲了避免多次 "預檢" 請求。
Access-Control-Expose-Headers 該字段可選。CORS 請求時，XMLHttpRequest 對象的 getResponseHeader() 方法只能拿到 6 個基本字段：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他字段，就必須在 Access-Control-Expose-Headers 裏面指定。
Access-Control-Allow-Credentials 該字段可選。它的值是一個布爾值，表示是否允許發送 Cookie. 默認情況下，不發生 Cookie，即：false。對服務器有特殊要求的請求，比如請求方法是 PUT 或 DELETE，或者 Content-Type 字段的類型是 application/json，這個值只能設爲 true。如果服務器不要瀏覽器發送 Cookie，刪除該字段即可。
Access-Control-Max-Age 該字段可選，用來指定本次預檢請求的有效期，單位爲秒。在有效期間，不用發出另一條預檢請求。

順便提一下，如果在開發中，發現每次發起請求都是兩條，一次 OPTIONS，一次正常請求，注意是每次，那麼就需要配置 Access-Control-Max-Age，避免每次都發出預檢請求。

解決辦法：

解決辦法有三種：

第一種辦法:

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.CorsRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
public class CorsConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS")
                .allowCredentials(true)
                .maxAge(3600)
                .allowedHeaders("*");
    }
}

這種方式是全局配置的，網上也大都是這種解決辦法，但是很多都是基於舊的 spring 版本，比如：

https://blog.csdn.net/tiangongkaiwu152368/article/details/81099169

文中 WebMvcConfigurerAdapter 在 spring5.0 已經被標記爲 Deprecated，點開源碼可以看到：

/**
 * An implementation of {@link WebMvcConfigurer} with empty methods allowing
 * subclasses to override only the methods they're interested in.
 *
 * @author Rossen Stoyanchev
 * @since 3.1
 * @deprecated as of 5.0 {@link WebMvcConfigurer} has default methods (made
 * possible by a Java 8 baseline) and can be implemented directly without the
 * need for this adapter
 */
@Deprecated
public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {}

像這種過時的類或者方法，spring 的作者們一定會在註解上面說明原因，並告訴你新的該用哪個，這是非常優秀的編碼習慣，點贊！

spring5 最低支持到 jdk1.8，所以註釋中明確表明，你可以直接實現 WebMvcConfigurer 接口，無需再用這個適配器，因爲 jdk1.8 支持接口中存在 default-method。

第二種辦法:

import org.springframework.context.annotation.Configuration;
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@WebFilter(filterName = "CorsFilter ")
@Configuration
public class CorsFilter implements Filter {
    @Override
    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-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "POST, GET, PATCH, DELETE, PUT");
        response.setHeader("Access-Control-Max-Age", "3600");
        response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
        chain.doFilter(req, res);
    }
}

這種辦法，是基於過濾器的方式，方式簡單明瞭，就是在 response 中寫入這些響應頭，好多文章都是第一種和第二種方式都叫你配置，其實這是沒有必要的，只需要一種即可。

這裏也吐槽一下，大家不求甚解的精神。

第三種辦法：

public class GoodsController {
    @CrossOrigin(origins = "http://localhost:4000")
    @GetMapping("goods-url")
    public Response queryGoodsWithGoodsUrl(@RequestParam String goodsUrl) throws Exception {}
}

沒錯就是 @CrossOrigin 註解，點開註解

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

從元註解 @Target 可以看出，註解可以放在 method、class 等上面，類似 RequestMapping，也就是說，整個 controller 下面的方法可以都受控制，也可以單個方法受控制。

也可以得知，這個是最小粒度的 cors 控制辦法了，精確到單個請求級別。

以上三種方法都可以解決問題，最常用的應該是第一種、第二種，控制在自家幾個域名範圍下足以，一般沒必要搞得太細。

這三種配置方式都用了的話，誰生效呢，類似 css 中樣式，就近原則，懂了吧。所以在開發新項目時，不需要等聯調時候，讓前端來找你了，我早就解決了跨域問題。

作者：telami

www.telami.cn/2019/springboot-resolve-cors/

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/wu6MyPLXgCUsqMpmuVdNYQ