前后端分離大勢所趨,跨域問題更是老生常談亿傅,隨便用標題去google或百度一下媒峡,能搜出一大片解決方案,那么為啥又要寫一遍呢葵擎,不急往下看谅阿。
一、問題背景:
Same Origin Policy,譯為“同源策略”签餐。它是對于客戶端腳本(尤其是JavaScript)的重要安全度量標準寓涨,其目的在于防止某個文檔或者腳本從多個不同“origin”(源)裝載。它認為自任何站點裝載的信賴內(nèi)容是不安全的氯檐。
當被瀏覽器半信半疑的腳本運行在沙箱時戒良,它們應該只被允許訪問來自同一站點的資源,而不是那些來自其它站點可能懷有惡意的資源男摧。
注:具有相同的Origin蔬墩,也即是擁有相同的協(xié)議、主機地址以及端口耗拓。一旦這三項數(shù)據(jù)中有一項不同拇颅,那么該資源就將被認為是從不同的Origin得來的,進而不被允許訪問乔询。
CORS就是為了解決SOP問題而生的樟插,當然CORS不是唯一的解決方案,不過這里不贅述其他解決辦法了竿刁。
二黄锤、CORS簡介:
CORS是一個W3C標準,全稱是"跨域資源共享”(Cross-origin resource sharing)食拜。它允許瀏覽器向跨源(協(xié)議 + 域名 + 端口)服務器鸵熟,發(fā)出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制负甸。CORS需要瀏覽器和服務器同時支持流强。它的通信過程,都是瀏覽器自動完成呻待,不需要用戶參與打月。
對于開發(fā)者來說,CORS通信與同源的AJAX/Fetch通信沒有差別蚕捉,代碼完全一樣奏篙。瀏覽器一旦發(fā)現(xiàn)請求跨源,就會自動添加一些附加的頭信息迫淹,有時還會多出一次附加的請求秘通,但用戶不會有感覺。因此千绪,實現(xiàn)CORS通信的關鍵是服務器充易。只要服務器實現(xiàn)了CORS接口,就可以跨源通信荸型。
瀏覽器將CORS請求分成兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)盹靴。
瀏覽器發(fā)出CORS簡單請求炸茧,只需要在頭信息之中增加一個Origin字段。
瀏覽器發(fā)出CORS非簡單請求稿静,會在正式通信之前梭冠,增加一次OPTIONS查詢請求,稱為"預檢"請求(preflight)改备。瀏覽器先詢問服務器控漠,當前網(wǎng)頁所在的域名是否在服務器的許可名單之中,以及可以使用哪些HTTP動詞和頭信息字段悬钳。只有得到肯定答復盐捷,瀏覽器才會發(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很簡單伪阶,就是在服務端加一些響應頭爸吮,并且這樣做對前端來說是無感知的,很方便望门。
三、詳解響應頭:
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 該字段可選。它的值是一個布爾值捕虽,表示是否允許發(fā)送Cookie.默認情況下慨丐,不發(fā)生Cookie,即:false薯鳍。對服務器有特殊要求的請求咖气,比如請求方法是PUT或DELETE,或者Content-Type字段的類型是application/json挖滤,這個值只能設為true崩溪。如果服務器不要瀏覽器發(fā)送Cookie,刪除該字段即可斩松。
Access-Control-Max-Age 該字段可選伶唯,用來指定本次預檢請求的有效期,單位為秒惧盹。在有效期間乳幸,不用發(fā)出另一條預檢請求。
順便提一下钧椰,如果在開發(fā)中粹断,發(fā)現(xiàn)每次發(fā)起請求都是兩條,一次OPTIONS嫡霞,一次正常請求瓶埋,注意是每次,那么就需要配置Access-Control-Max-Age诊沪,避免每次都發(fā)出預檢請求养筒。
四肉康、解決辦法:
1. 第一種辦法:
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版本衫画,比如WebMvcConfigurerAdapter在spring5.0已經(jīng)被標記為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)秀的編碼習慣,點贊剩膘!
spring5最低支持到jdk1.8衅斩,所以注釋中明確表明,你可以直接實現(xiàn)WebMvcConfigurer接口怠褐,無需再用這個適配器畏梆,因為jdk1.8支持接口中存在default-method。
2. 第二種辦法:
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中寫入這些響應頭磷杏,好多文章都是第一種和第二種方式都叫你配置溜畅,其實這是沒有必要的,只需要一種即可极祸。
3. 第三種辦法:
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控制辦法了页眯,精確到單個請求級別。
以上三種方法都可以解決問題厢呵,最常用的應該是第一種窝撵、第二種,控制在自家?guī)讉€域名范圍下足以襟铭,一般沒必要搞得太細忿族。
這三種配置方式都用了的話,誰生效呢蝌矛,類似css中樣式,就近原則错英,懂了吧入撒。
所以在開發(fā)新項目時,不需要等聯(lián)調(diào)時候椭岩,讓前端來找你了茅逮,我早就解決了跨域問題璃赡。
五、寫到最后
今天的Java知識就分享到這里献雅!點關注碉考,不迷路,關注程序員曾曾挺身,每天分享不同的Java知識侯谁,如果想要知道更多的Java基礎知識以及筆試面試資料我這邊整理了一個我自己的GitHub倉庫:Java工程師修煉手冊,大家如果有需要可以自行查看