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版本,比如 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 基礎就不介紹了,看下這個教程太全了:
第二種辦法:
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中寫入這些響應頭,好多文章都是第一種和第二種方式都叫你配置,其實這是沒有必要的,只需要一種即可。
這裡也吐槽一下,大家不求甚解的精神。另外,關注公眾號Java技術棧,在後臺回覆:面試,可以獲取我整理的 Spring Boot 面試題和答案。
第三種辦法:
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中樣式,就近原則,懂了吧。
所以在開發新專案時,不需要等聯調時候,讓前端來找你了,我早就解決了跨域問題。另外,關注公眾號Java技術棧,在後臺回覆:面試,可以獲取我整理的 Spring Boot 面試題和答案。
作者:telami
來源:https://www.telami.cn/2019/springboot-resolve-cors/
近期熱文推薦:
1.Java 15 正式釋出, 14 個新特性,重新整理你的認知!!
2.終於靠開源專案弄到 IntelliJ IDEA 啟用碼了,真香!
3.我用 Java 8 寫了一段邏輯,同事直呼看不懂,你試試看。。
覺得不錯,別忘了隨手點贊+轉發哦!