Springboot2.0 解決跨域問題

前后端分離大勢所趨，跨域問題更是老生常談嗤放，隨便用標(biāo)題去google或百度一下，能搜出一大片解決方案壁酬，那么為啥又要寫一遍呢次酌，不急往下看。

問題背景：

Same Origin Policy舆乔，譯為“同源策略”岳服。它是對于客戶端腳本（尤其是JavaScript）的重要安全度量標(biāo)準(zhǔn)，其目的在于防止某個文檔或者腳本從多個不同“origin”（源）裝載希俩。
它認(rèn)為自任何站點裝載的信賴內(nèi)容是不安全的吊宋。當(dāng)被瀏覽器半信半疑的腳本運行在沙箱時，它們應(yīng)該只被允許訪問來自同一站點的資源颜武，而不是那些來自其它站點可能懷有惡意的資源璃搜。
注：具有相同的Origin，也即是擁有相同的協(xié)議鳞上、主機(jī)地址以及端口这吻。一旦這三項數(shù)據(jù)中有一項不同，那么該資源就將被認(rèn)為是從不同的Origin得來的篙议，進(jìn)而不被允許訪問唾糯。

CORS就是為了解決SOP問題而生的，當(dāng)然CORS不是唯一的解決方案，不過這里不贅述其他解決辦法了移怯。

CORS簡介:

CORS是一個W3C標(biāo)準(zhǔn)拒名，全稱是"跨域資源共享"（Cross-origin resource sharing）。它允許瀏覽器向跨源(協(xié)議 + 域名 + 端口)服務(wù)器芋酌，發(fā)出XMLHttpRequest請求，從而克服了AJAX只能同源使用的限制雁佳。
CORS需要瀏覽器和服務(wù)器同時支持脐帝。它的通信過程，都是瀏覽器自動完成糖权，不需要用戶參與堵腹。對于開發(fā)者來說，CORS通信與同源的AJAX/Fetch通信沒有差別星澳，代碼完全一樣疚顷。瀏覽器一旦發(fā)現(xiàn)請求跨源，就會自動添加一些附加的頭信息禁偎，有時還會多出一次附加的請求腿堤，但用戶不會有感覺。
因此如暖，實現(xiàn)CORS通信的關(guān)鍵是服務(wù)器笆檀。只要服務(wù)器實現(xiàn)了CORS接口，就可以跨源通信盒至。

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

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

瀏覽器發(fā)出CORS非簡單請求樱衷，會在正式通信之前，增加一次OPTIONS查詢請求酒唉，稱為"預(yù)檢"請求（preflight）矩桂。瀏覽器先詢問服務(wù)器，當(dāng)前網(wǎng)頁所在的域名是否在服務(wù)器的許可名單之中黔州，以及可以使用哪些HTTP動詞和頭信息字段耍鬓。只有得到肯定答復(fù)，瀏覽器才會發(fā)出正式的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

反之鸦概，就是非簡單請求。

其實實現(xiàn)CORS很簡單甩骏，就是在服務(wù)端加一些響應(yīng)頭窗市，并且這樣做對前端來說是無感知的，很方便饮笛。

詳解響應(yīng)頭：

Access-Control-Allow-Origin
該字段必填咨察。它的值要么是請求時Origin字段的具體值，要么是一個*福青，表示接受任意域名的請求摄狱。

Access-Control-Allow-Methods
該字段必填。它的值是逗號分隔的一個具體的字符串或者*无午，表明服務(wù)器支持的所有跨域請求的方法媒役。注意，返回的是所有支持的方法宪迟，而不單是瀏覽器請求的那個方法刊愚。這是為了避免多次"預(yù)檢"請求。

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
該字段可選碴里。它的值是一個布爾值，表示是否允許發(fā)送Cookie.默認(rèn)情況下上真，不發(fā)生Cookie咬腋，即：false。對服務(wù)器有特殊要求的請求睡互，比如請求方法是PUT或DELETE根竿，或者Content-Type字段的類型是application/json陵像，這個值只能設(shè)為true。如果服務(wù)器不要瀏覽器發(fā)送Cookie寇壳，刪除該字段即可醒颖。

Access-Control-Max-Age
該字段可選，用來指定本次預(yù)檢請求的有效期壳炎，單位為秒泞歉。在有效期間，不用發(fā)出另一條預(yù)檢請求匿辩。

順便提一下疏日，如果在開發(fā)中，發(fā)現(xiàn)每次發(fā)起請求都是兩條撒汉，一次OPTIONS，一次正常請求涕滋，注意是每次睬辐，那么就需要配置Access-Control-Max-Age，避免每次都發(fā)出預(yù)檢請求宾肺。

解決辦法：

解決辦法有三種：

image

第一種辦法:

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("*");
    }
}

這種方式是全局配置的溯饵，網(wǎng)上也大都是這種解決辦法，但是很多都是基于舊的spring版本锨用，比如：

Spring Boot如何解決前端的Access-Control-Allow-Origin跨域問題

文中WebMvcConfigurerAdapter在spring5.0已經(jīng)被標(biāo)記為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的作者們一定會在注解上面說明原因增拥，并告訴你新的該用哪個啄巧，這是非常優(yōu)秀的編碼習(xí)慣，點贊掌栅！

spring5最低支持到j(luò)dk1.8秩仆，所以注釋中明確表明，你可以直接實現(xiàn)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中寫入這些響應(yīng)頭磷箕，好多文章都是第一種和第二種方式都叫你配置选酗，其實這是沒有必要的，只需要一種即可岳枷。

這里也吐槽一下星掰，大家不求甚解的精神多望。

第三種辦法：

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控制辦法了，精確到單個請求級別果覆。

以上三種方法都可以解決問題颅痊，最常用的應(yīng)該是第一種、第二種局待，控制在自家?guī)讉€域名范圍下足以斑响，一般沒必要搞得太細(xì)。

這三種配置方式都用了的話钳榨，誰生效呢舰罚，類似css中樣式，就近原則薛耻，懂了吧营罢。

所以在開發(fā)新項目時，不需要等聯(lián)調(diào)時候饼齿，讓前端來找你了饲漾，我早就解決了跨域問題。