前言
從剛接觸前端開發(fā)起旋奢,跨域
這個(gè)詞就一直以很高的頻率在身邊重復(fù)出現(xiàn)迄薄,一直到現(xiàn)在,已經(jīng)調(diào)試過N個(gè)跨域相關(guān)的問題了懦冰,16年時(shí)也整理過一篇相關(guān)文章灶轰,但是感覺還是差了點(diǎn)什么,于是現(xiàn)在重新梳理了一下刷钢。
個(gè)人見識(shí)有限,如有差錯(cuò)乳附,請(qǐng)多多見諒内地,歡迎提出issue伴澄,另外看到這個(gè)標(biāo)題,請(qǐng)勿噴~
題綱
關(guān)于跨域阱缓,有N種類型非凌,本文只專注于ajax請(qǐng)求跨域
(,ajax跨域只是屬于瀏覽器"同源策略"中的一部分,其它的還有Cookie跨域iframe跨域,LocalStorage跨域等這里不做介紹),內(nèi)容大概如下:
-
什么是ajax跨域
原理
表現(xiàn)(整理了一些遇到的問題以及解決方案)
-
如何解決ajax跨域
JSONP方式
CORS方式
代理請(qǐng)求方式
-
如何分析ajax跨域
http抓包的分析
一些示例
什么是ajax跨域
ajax跨域的原理
ajax出現(xiàn)請(qǐng)求跨域錯(cuò)誤問題,主要原因就是因?yàn)闉g覽器的“同源策略”,可以參考
CORS請(qǐng)求原理
CORS是一個(gè)W3C標(biāo)準(zhǔn)荆针,全稱是"跨域資源共享"(Cross-origin resource sharing)敞嗡。它允許瀏覽器向跨源服務(wù)器,發(fā)出XMLHttpRequest請(qǐng)求航背,從而克服了AJAX只能同源使用的限制喉悴。
基本上目前所有的瀏覽器都實(shí)現(xiàn)了CORS標(biāo)準(zhǔn),其實(shí)目前幾乎所有的瀏覽器ajax請(qǐng)求都是基于CORS機(jī)制的,只不過可能平時(shí)前端開發(fā)人員并不關(guān)心而已(所以說其實(shí)現(xiàn)在CORS解決方案主要是考慮后臺(tái)該如何實(shí)現(xiàn)的問題)。
關(guān)于CORS玖媚,強(qiáng)烈推薦閱讀 跨域資源共享 CORS 詳解(阮一峰)
另外箕肃,這里也整理了一個(gè)實(shí)現(xiàn)原理圖(簡(jiǎn)化版):
如何判斷是否是簡(jiǎn)單請(qǐng)求?
瀏覽器將CORS請(qǐng)求分成兩類:簡(jiǎn)單請(qǐng)求(simple request)和非簡(jiǎn)單請(qǐng)求(not-so-simple request)。只要同時(shí)滿足以下兩大條件今魔,就屬于簡(jiǎn)單請(qǐng)求勺像。
請(qǐng)求方法是以下三種方法之一:HEAD,GET,POST
-
HTTP的頭信息不超出以下幾種字段:
Accept
Accept-Language
Content-Language
Last-Event-ID
Content-Type(只限于三個(gè)值application/x-www-form-urlencoded、 multipart/form-data错森、text/plain)
凡是不同時(shí)滿足上面兩個(gè)條件吟宦,就屬于非簡(jiǎn)單請(qǐng)求。
ajax跨域的表現(xiàn)
說實(shí)話涩维,當(dāng)初整理過一篇文章督函,然后作為了一個(gè)解決方案,但是后來發(fā)現(xiàn)仍然有很多人還是不會(huì)激挪。無奈只能耗時(shí)又耗力的調(diào)試辰狡。然而就算是我來分析,也只會(huì)根據(jù)對(duì)應(yīng)的表現(xiàn)來判斷是否是跨域垄分,因此這一點(diǎn)是很重要的宛篇。
ajax請(qǐng)求時(shí),如果存在跨域現(xiàn)象,并且沒有進(jìn)行解決,會(huì)有如下表現(xiàn):(注意,是ajax請(qǐng)求薄湿,請(qǐng)不要說為什么http請(qǐng)求可以叫倍,而ajax不行,因?yàn)閍jax是伴隨著跨域的豺瘤,所以僅僅是http請(qǐng)求ok是不行的)
注意:具體的后端跨域配置請(qǐng)看題綱位置吆倦。
第一種現(xiàn)象:No 'Access-Control-Allow-Origin' header is present on the requested resource
,并且The response had HTTP status code 404
出現(xiàn)這種情況的原因如下:
本次ajax請(qǐng)求是“非簡(jiǎn)單請(qǐng)求”,所以請(qǐng)求前會(huì)發(fā)送一次預(yù)檢請(qǐng)求(OPTIONS)
服務(wù)器端后臺(tái)接口沒有允許OPTIONS請(qǐng)求,導(dǎo)致無法找到對(duì)應(yīng)接口地址
解決方案: 后端允許options請(qǐng)求
第二種現(xiàn)象:No 'Access-Control-Allow-Origin' header is present on the requested resource
,并且The response had HTTP status code 405
這種現(xiàn)象和第一種有區(qū)別,這種情況下,后臺(tái)方法允許OPTIONS請(qǐng)求,但是一些配置文件中(如安全配置
),阻止了OPTIONS請(qǐng)求,才會(huì)導(dǎo)致這個(gè)現(xiàn)象
解決方案: 后端關(guān)閉對(duì)應(yīng)的安全配置
第三種現(xiàn)象:No 'Access-Control-Allow-Origin' header is present on the requested resource
,并且status 200
這種現(xiàn)象和第一種和第二種有區(qū)別,這種情況下坐求,服務(wù)器端后臺(tái)允許OPTIONS請(qǐng)求,并且接口也允許OPTIONS請(qǐng)求,但是頭部匹配時(shí)出現(xiàn)不匹配現(xiàn)象
比如origin頭部檢查不匹配,比如少了一些頭部的支持(如常見的X-Requested-With頭部),然后服務(wù)端就會(huì)將response返回給前端,前端檢測(cè)到這個(gè)后就觸發(fā)XHR.onerror,導(dǎo)致前端控制臺(tái)報(bào)錯(cuò)
解決方案: 后端增加對(duì)應(yīng)的頭部支持
第四種現(xiàn)象:heade contains multiple values '*,*'
表現(xiàn)現(xiàn)象是蚕泽,后臺(tái)響應(yīng)的http頭部信息有兩個(gè)Access-Control-Allow-Origin:*
說實(shí)話,這種問題出現(xiàn)的主要原因就是進(jìn)行跨域配置的人不了解原理,導(dǎo)致了重復(fù)配置须妻,如:
常見于.net后臺(tái)(一般在web.config中配置了一次origin,然后代碼中又手動(dòng)添加了一次origin(比如代碼手動(dòng)設(shè)置了返回*))
常見于.net后臺(tái)(在IIS和項(xiàng)目的webconfig中同時(shí)設(shè)置Origin:*)
解決方案(一一對(duì)應(yīng)):
建議刪除代碼中手動(dòng)添加的*仔蝌,只用項(xiàng)目配置中的即可
建議刪除IIS下的配置*,只用項(xiàng)目配置中的即可
如何解決ajax跨域
一般ajax跨域解決就是通過JSONP解決或者CORS解決,如以下:(注意荒吏,現(xiàn)在已經(jīng)幾乎不會(huì)再使用JSONP了敛惊,所以JSONP了解下即可)
JSONP方式解決跨域問題
jsonp解決跨域問題是一個(gè)比較古老的方案(實(shí)際中不推薦使用),這里做簡(jiǎn)單介紹(實(shí)際項(xiàng)目中如果要使用JSONP,一般會(huì)使用JQ等對(duì)JSONP進(jìn)行了封裝的類庫(kù)來進(jìn)行ajax請(qǐng)求)
實(shí)現(xiàn)原理
JSONP之所以能夠用來解決跨域方案,主要是因?yàn)?script
腳本擁有跨域能力,而JSONP正是利用這一點(diǎn)來實(shí)現(xiàn)。具體原理如圖
實(shí)現(xiàn)流程
JSONP的實(shí)現(xiàn)步驟大致如下(參考了來源中的文章)
-
客戶端網(wǎng)頁網(wǎng)頁通過添加一個(gè)
script
元素绰更,向服務(wù)器請(qǐng)求JSON數(shù)據(jù)瞧挤,這種做法不受同源政策限制function addScriptTag(src) { var script = document.createElement('script'); script.setAttribute("type","text/javascript"); script.src = src; document.body.appendChild(script); } window.onload = function () { addScriptTag('http://example.com/ip?callback=foo'); } function foo(data) { console.log('response data: ' + JSON.stringify(data)); }; 復(fù)制代碼
請(qǐng)求時(shí),接口地址是作為構(gòu)建出的腳本標(biāo)簽的src的,這樣,當(dāng)腳本標(biāo)簽構(gòu)建出來時(shí),最終的src是接口返回的內(nèi)容
服務(wù)端對(duì)應(yīng)的接口在返回參數(shù)外面添加函數(shù)包裹層
foo({
"test": "testData"
});
復(fù)制代碼
- 由于
script
>元素請(qǐng)求的腳本,直接作為代碼運(yùn)行儡湾。這時(shí)特恬,只要瀏覽器定義了foo函數(shù),該函數(shù)就會(huì)立即調(diào)用盒粮。作為參數(shù)的JSON數(shù)據(jù)被視為JavaScript對(duì)象鸵鸥,而不是字符串,因此避免了使用JSON.parse的步驟丹皱。
注意,一般的JSONP接口和普通接口返回?cái)?shù)據(jù)是有區(qū)別的,所以接口如果要做JSONO兼容,需要進(jìn)行判斷是否有對(duì)應(yīng)callback關(guān)鍵字參數(shù),如果有則是JSONP請(qǐng)求,返回JSONP數(shù)據(jù),否則返回普通數(shù)據(jù)
使用注意
基于JSONP的實(shí)現(xiàn)原理,所以JSONP只能是“GET”請(qǐng)求,不能進(jìn)行較為復(fù)雜的POST和其它請(qǐng)求,所以遇到那種情況,就得參考下面的CORS解決跨域了(所以如今它也基本被淘汰了)
CORS解決跨域問題
CORS的原理上文中已經(jīng)介紹了妒穴,這里主要介紹的是,實(shí)際項(xiàng)目中摊崭,后端應(yīng)該如何配置以解決問題(因?yàn)榇罅宽?xiàng)目實(shí)踐都是由后端進(jìn)行解決的)讼油,這里整理了一些常見的后端解決方案:
PHP后臺(tái)配置
PHP后臺(tái)得配置幾乎是所有后臺(tái)中最為簡(jiǎn)單的,遵循如下步驟即可:
- 第一步:配置Php 后臺(tái)允許跨域
<?php
header('Access-Control-Allow-Origin: *');
header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept');
//主要為跨域CORS配置的兩大基本信息,Origin和headers
復(fù)制代碼
- 第二步:配置Apache web服務(wù)器跨域(httpd.conf中)
原始代碼
<Directory />
AllowOverride none
Require all denied
</Directory>
復(fù)制代碼
改為以下代碼
<Directory />
Options FollowSymLinks
AllowOverride none
Order deny,allow
Allow from all
</Directory>
復(fù)制代碼
Node.js后臺(tái)配置(express框架)
Node.js的后臺(tái)也相對(duì)來說比較簡(jiǎn)單就可以進(jìn)行配置。只需用express如下配置:
app.all('*', function(req, res, next) {
res.header("Access-Control-Allow-Origin", "*");
res.header("Access-Control-Allow-Headers", "X-Requested-With");
res.header("Access-Control-Allow-Methods", "PUT,POST,GET,DELETE,OPTIONS");
res.header("X-Powered-By", ' 3.2.1')
//這段僅僅為了方便返回json而已
res.header("Content-Type", "application/json;charset=utf-8");
if(req.method == 'OPTIONS') {
//讓options請(qǐng)求快速返回
res.sendStatus(200);
} else {
next();
}
});
復(fù)制代碼
JAVA后臺(tái)配置
JAVA后臺(tái)配置只需要遵循如下步驟即可:
-
第一步:獲取依賴jar包
下載 cors-filter-1.7.jar, java-property-utils-1.9.jar 這兩個(gè)庫(kù)文件放到lib目錄下呢簸。(放到對(duì)應(yīng)項(xiàng)目的webcontent/WEB-INF/lib/下)
第二步:如果項(xiàng)目用了Maven構(gòu)建的,請(qǐng)?zhí)砑尤缦乱蕾嚨絧om.xml中:(非maven請(qǐng)忽視)
<dependency>
<groupId>com.thetransactioncompany</groupId>
<artifactId>cors-filter</artifactId>
<version>[ version ]</version>
</dependency>
復(fù)制代碼
其中版本應(yīng)該是最新的穩(wěn)定版本,CORS過濾器
- 第三步:添加CORS配置到項(xiàng)目的Web.xml中( App/WEB-INF/web.xml)
<!-- 跨域配置-->
<filter>
<!-- The CORS filter with parameters -->
<filter-name>CORS</filter-name>
<filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
<!-- Note: All parameters are options, if omitted the CORS
Filter will fall back to the respective default values.
-->
<init-param>
<param-name>cors.allowGenericHttpRequests</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>cors.allowOrigin</param-name>
<param-value>*</param-value>
</init-param>
<init-param>
<param-name>cors.allowSubdomains</param-name>
<param-value>false</param-value>
</init-param>
<init-param>
<param-name>cors.supportedMethods</param-name>
<param-value>GET, HEAD, POST, OPTIONS</param-value>
</init-param>
<init-param>
<param-name>cors.supportedHeaders</param-name>
<param-value>Accept, Origin, X-Requested-With, Content-Type, Last-Modified</param-value>
</init-param>
<init-param>
<param-name>cors.exposedHeaders</param-name>
<!--這里可以添加一些自己的暴露Headers -->
<param-value>X-Test-1, X-Test-2</param-value>
</init-param>
<init-param>
<param-name>cors.supportsCredentials</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>cors.maxAge</param-name>
<param-value>3600</param-value>
</init-param>
</filter>
<filter-mapping>
<!-- CORS Filter mapping -->
<filter-name>CORS</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
復(fù)制代碼
請(qǐng)注意,以上配置文件請(qǐng)放到web.xml的前面,作為第一個(gè)filter存在(可以有多個(gè)filter的)
- 第四步:可能的安全模塊配置錯(cuò)誤(注意矮台,某些框架中-譬如公司私人框架,有安全模塊的根时,有時(shí)候這些安全模塊配置會(huì)影響跨域配置瘦赫,這時(shí)候可以先嘗試關(guān)閉它們)
NET后臺(tái)配置
.NET后臺(tái)配置可以參考如下步驟:
- 第一步:網(wǎng)站配置
打開控制面板,選擇管理工具,選擇iis;右鍵單擊自己的網(wǎng)站蛤迎,選擇瀏覽;打開網(wǎng)站所在目錄,用記事本打開web.config文件添加下述配置信息,重啟網(wǎng)站
請(qǐng)注意,以上截圖較老,如果配置仍然出問題,可以考慮增加更多的headers允許,比如:
"Access-Control-Allow-Headers":"X-Requested-With,Content-Type,Accept,Origin"
復(fù)制代碼
-
第二步:其它更多配置,如果第一步進(jìn)行了后,仍然有跨域問題确虱,可能是:
接口中有限制死一些請(qǐng)求類型(比如寫死了POST等),這時(shí)候請(qǐng)去除限 制
接口中替裆,重復(fù)配置了
Origin:*
校辩,請(qǐng)去除即可IIS服務(wù)器中,重復(fù)配置了
Origin:*
辆童,請(qǐng)去除即可
代理請(qǐng)求方式解決接口跨域問題
注意宜咒,由于接口代理是有代價(jià)的,所以這個(gè)僅是開發(fā)過程中進(jìn)行的把鉴。
與前面的方法不同故黑,前面CORS是后端解決,而這個(gè)主要是前端對(duì)接口進(jìn)行代理,也就是:
前端ajax請(qǐng)求的是本地接口
本地接口接收到請(qǐng)求后向?qū)嶋H的接口請(qǐng)求數(shù)據(jù)倍阐,然后再將信息返回給前端
一般用node.js即可代理
關(guān)于如何實(shí)現(xiàn)代理概疆,這里就不重點(diǎn)描述了逗威,方法和多峰搪,也不難,基本都是基于node.js的凯旭。
搜索關(guān)鍵字node.js
,代理請(qǐng)求
即可找到一大票的方案概耻。
如何分析ajax跨域
上述已經(jīng)介紹了跨域的原理以及如何解決,但實(shí)際過程中罐呼,發(fā)現(xiàn)仍然有很多人對(duì)照著類似的文檔無法解決跨域問題鞠柄,主要體現(xiàn)在,前端人員不知道什么時(shí)候是跨域問題造成的嫉柴,什么時(shí)候不是厌杜,因此這里稍微介紹下如何分析一個(gè)請(qǐng)求是否跨域:
抓包請(qǐng)求數(shù)據(jù)
第一步當(dāng)然是得知道我們的ajax請(qǐng)求發(fā)送了什么數(shù)據(jù),接收了什么计螺,做到這一步并不難夯尽,也不需要fiddler
等工具把兔,僅基于Chrome
即可
Chrome
瀏覽器打開對(duì)應(yīng)發(fā)生ajax的頁面饭豹,F12
打開Dev Tools
發(fā)送ajax請(qǐng)求
右側(cè)面板->
NetWork
->XHR
燥翅,然后找到剛才的ajax請(qǐng)求斟湃,點(diǎn)進(jìn)去
示例一(正常的ajax請(qǐng)求)
上述請(qǐng)求是一個(gè)正確的請(qǐng)求收擦,為了方便敢辩,我把每一個(gè)頭域的意思都表明了兰伤,我們可以清晰的看到默赂,接口返回的響應(yīng)頭域中麦射,包括了
Access-Control-Allow-Headers: X-Requested-With,Content-Type,Accept
Access-Control-Allow-Methods: Get,Post,Put,OPTIONS
Access-Control-Allow-Origin: *
復(fù)制代碼
所以瀏覽器接收到響應(yīng)時(shí)蛾娶,判斷的是正確的請(qǐng)求,自然不會(huì)報(bào)錯(cuò)潜秋,成功的拿到了響應(yīng)數(shù)據(jù)蛔琅。
示例二(跨域錯(cuò)誤的ajax請(qǐng)求)
為了方便,我們?nèi)匀荒蒙厦娴腻e(cuò)誤表現(xiàn)示例舉例半等。
這個(gè)請(qǐng)求中揍愁,接口Allow里面沒有包括OPTIONS
,所以請(qǐng)求出現(xiàn)了跨域杀饵、
這個(gè)請(qǐng)求中莽囤,Access-Control-Allow-Origin: *
出現(xiàn)了兩次,導(dǎo)致了跨域配置沒有正確配置切距,出現(xiàn)了錯(cuò)誤朽缎。
更多跨域錯(cuò)誤基本都是類似的,就是以上三樣沒有滿足(Headers,Allow,Origin),這里不再一一贅述话肖。
示例三(與跨域無關(guān)的ajax請(qǐng)求)
當(dāng)然北秽,也并不是所有的ajax請(qǐng)求錯(cuò)誤都與跨域有關(guān),所以請(qǐng)不要混淆最筒,比如以下:
比如這個(gè)請(qǐng)求贺氓,它的跨域配置沒有一點(diǎn)問題,它出錯(cuò)僅僅是因?yàn)閞equest的Accept
和response的Content-Type
不匹配而已床蜘。
更多
基本上都是這樣去分析一個(gè)ajax請(qǐng)求辙培,通過Chrome
就可以知道了發(fā)送了什么數(shù)據(jù),收到了什么數(shù)據(jù)邢锯,然后再一一比對(duì)就知道問題何在了扬蕊。
寫在最后的話
跨域是一個(gè)老生常談的話題,網(wǎng)上也有大量跨域的資料丹擎,并且有不少精品(比如阮一峰前輩的)尾抑,但是身為一個(gè)前端人員不應(yīng)該淺嘗而止,故而才有了本文蒂培。
漫漫前端路再愈,望與諸君共勉之!