前后端分離大勢所趨,跨域問題更是老生常談,隨便用標題去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版本,比如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。
Spring Boot 基礎就不介紹了,看下這個教程太全了:
https://github.com/javastacks/spring-boot-best-practice
第二種辦法:
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中樣式,就近原則,懂了吧。
所以在開發新項目時,不需要等聯調時候,讓前端來找你了,我早就解決了跨域問題。