跨域資源共享 CORS 詳解2018-09-27

CORS是一個(gè)W3C標(biāo)準(zhǔn),全稱(chēng)是"跨域資源共享"(Cross-origin resource sharing)遵堵。

它允許瀏覽器向跨源服務(wù)器晚伙,發(fā)出XMLHttpRequest請(qǐng)求位隶,從而克服了AJAX只能同源使用的限制拷窜。

本文詳細(xì)介紹CORS的內(nèi)部機(jī)制。

一钓试、簡(jiǎn)介

CORS需要瀏覽器和服務(wù)器同時(shí)支持装黑。目前副瀑,所有瀏覽器都支持該功能弓熏,IE瀏覽器不能低于IE10。

整個(gè)CORS通信過(guò)程糠睡,都是瀏覽器自動(dòng)完成挽鞠,不需要用戶(hù)參與。對(duì)于開(kāi)發(fā)者來(lái)說(shuō)狈孔,CORS通信與同源的AJAX通信沒(méi)有差別信认,代碼完全一樣。瀏覽器一旦發(fā)現(xiàn)AJAX請(qǐng)求跨源均抽,就會(huì)自動(dòng)添加一些附加的頭信息嫁赏,有時(shí)還會(huì)多出一次附加的請(qǐng)求,但用戶(hù)不會(huì)有感覺(jué)油挥。

因此潦蝇,實(shí)現(xiàn)CORS通信的關(guān)鍵是服務(wù)器。只要服務(wù)器實(shí)現(xiàn)了CORS接口深寥,就可以跨源通信攘乒。

二、兩種請(qǐng)求

瀏覽器將CORS請(qǐng)求分成兩類(lèi):簡(jiǎn)單請(qǐng)求(simple request)和非簡(jiǎn)單請(qǐng)求(not-so-simple request)惋鹅。

只要同時(shí)滿(mǎn)足以下兩大條件则酝,就屬于簡(jiǎn)單請(qǐng)求。

(1) 請(qǐng)求方法是以下三種方法之一:
HEAD
GET
POST

(2)HTTP的頭信息不超出以下幾種字段:
Accept
Accept-Language
Content-Language
Last-Event-ID
Content-Type:只限于三個(gè)值application/x-www-form-urlencoded闰集、multipart/form-data沽讹、text/plain

凡是不同時(shí)滿(mǎn)足上面兩個(gè)條件般卑,就屬于非簡(jiǎn)單請(qǐng)求。

瀏覽器對(duì)這兩種請(qǐng)求的處理爽雄,是不一樣的椭微。

三、簡(jiǎn)單請(qǐng)求
3.1 基本流程

對(duì)于簡(jiǎn)單請(qǐng)求盲链,瀏覽器直接發(fā)出CORS請(qǐng)求蝇率。具體來(lái)說(shuō),就是在頭信息之中刽沾,增加一個(gè)Origin字段本慕。

下面是一個(gè)例子,瀏覽器發(fā)現(xiàn)這次跨源AJAX請(qǐng)求是簡(jiǎn)單請(qǐng)求侧漓,就自動(dòng)在頭信息之中锅尘,添加一個(gè)Origin字段。

GET /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...

上面的頭信息中布蔗,Origin字段用來(lái)說(shuō)明藤违,本次請(qǐng)求來(lái)自哪個(gè)源(協(xié)議 + 域名 + 端口)。服務(wù)器根據(jù)這個(gè)值纵揍,決定是否同意這次請(qǐng)求顿乒。

如果Origin指定的源,不在許可范圍內(nèi)泽谨,服務(wù)器會(huì)返回一個(gè)正常的HTTP回應(yīng)璧榄。瀏覽器發(fā)現(xiàn),這個(gè)回應(yīng)的頭信息沒(méi)有包含Access-Control-Allow-Origin字段(詳見(jiàn)下文)吧雹,就知道出錯(cuò)了骨杂,從而拋出一個(gè)錯(cuò)誤,被XMLHttpRequest的onerror回調(diào)函數(shù)捕獲雄卷。注意搓蚪,這種錯(cuò)誤無(wú)法通過(guò)狀態(tài)碼識(shí)別,因?yàn)镠TTP回應(yīng)的狀態(tài)碼有可能是200丁鹉。

如果Origin指定的域名在許可范圍內(nèi)妒潭,服務(wù)器返回的響應(yīng),會(huì)多出幾個(gè)頭信息字段鳄炉。

Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
上面的頭信息之中杜耙,有三個(gè)與CORS請(qǐng)求相關(guān)的字段,都以Access-Control-開(kāi)頭拂盯。

  • (1)Access-Control-Allow-Origin

該字段是必須的佑女。它的值要么是請(qǐng)求時(shí)Origin字段的值,要么是一個(gè)*,表示接受任意域名的請(qǐng)求团驱。

  • (2)Access-Control-Allow-Credentials

該字段可選摸吠。它的值是一個(gè)布爾值,表示是否允許發(fā)送Cookie嚎花。默認(rèn)情況下寸痢,Cookie不包括在CORS請(qǐng)求之中。設(shè)為true紊选,即表示服務(wù)器明確許可啼止,Cookie可以包含在請(qǐng)求中,一起發(fā)給服務(wù)器兵罢。這個(gè)值也只能設(shè)為true献烦,如果服務(wù)器不要瀏覽器發(fā)送Cookie,刪除該字段即可卖词。

  • (3)Access-Control-Expose-Headers

該字段可選巩那。CORS請(qǐng)求時(shí),XMLHttpRequest對(duì)象的getResponseHeader()方法只能拿到6個(gè)基本字段:Cache-Control此蜈、Content-Language即横、Content-Type、Expires裆赵、Last-Modified东囚、Pragma。如果想拿到其他字段顾瞪,就必須在Access-Control-Expose-Headers里面指定舔庶。上面的例子指定抛蚁,getResponseHeader('FooBar')可以返回FooBar字段的值陈醒。

3.2 withCredentials 屬性

上面說(shuō)到,CORS請(qǐng)求默認(rèn)不發(fā)送CookieHTTP認(rèn)證信息瞧甩。如果要把Cookie發(fā)到服務(wù)器钉跷,一方面要服務(wù)器同意,指定Access-Control-Allow-Credentials字段肚逸。

Access-Control-Allow-Credentials: true
另一方面爷辙,開(kāi)發(fā)者必須在AJAX請(qǐng)求中打開(kāi)withCredentials屬性。
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

否則朦促,即使服務(wù)器同意發(fā)送Cookie膝晾,瀏覽器也不會(huì)發(fā)送∥衩幔或者血当,服務(wù)器要求設(shè)置Cookie,瀏覽器也不會(huì)處理。

但是臊旭,如果省略withCredentials設(shè)置落恼,有的瀏覽器還是會(huì)一起發(fā)送Cookie。這時(shí)离熏,可以顯式關(guān)閉withCredentials佳谦。

xhr.withCredentials = false;

需要注意的是,如果要發(fā)送Cookie滋戳,Access-Control-Allow-Origin就不能設(shè)為星號(hào)钻蔑,必須指定明確的、與請(qǐng)求網(wǎng)頁(yè)一致的域名奸鸯。同時(shí)矢棚,Cookie依然遵循同源政策,只有用服務(wù)器域名設(shè)置的Cookie才會(huì)上傳府喳,其他域名的Cookie并不會(huì)上傳蒲肋,且(跨源)原網(wǎng)頁(yè)代碼中的document.cookie也無(wú)法讀取服務(wù)器域名下的Cookie。

四钝满、非簡(jiǎn)單請(qǐng)求
4.1 預(yù)檢請(qǐng)求

非簡(jiǎn)單請(qǐng)求是那種對(duì)服務(wù)器有特殊要求的請(qǐng)求兜粘,比如請(qǐng)求方法是PUTDELETE,或者Content-Type字段的類(lèi)型是application/json弯蚜。

非簡(jiǎn)單請(qǐng)求的CORS請(qǐng)求孔轴,會(huì)在正式通信之前,增加一次HTTP查詢(xún)請(qǐng)求碎捺,稱(chēng)為"預(yù)檢"請(qǐng)求(preflight)路鹰。

瀏覽器先詢(xún)問(wèn)服務(wù)器,當(dāng)前網(wǎng)頁(yè)所在的域名是否在服務(wù)器的許可名單之中收厨,以及可以使用哪些HTTP動(dòng)詞和頭信息字段晋柱。只有得到肯定答復(fù),瀏覽器才會(huì)發(fā)出正式的XMLHttpRequest請(qǐng)求诵叁,否則就報(bào)錯(cuò)雁竞。

下面是一段瀏覽器的JavaScript腳本。

var url = 'http://api.alice.com/cors';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();

上面代碼中拧额,HTTP請(qǐng)求的方法是PUT碑诉,并且發(fā)送一個(gè)自定義頭信息X-Custom-Header

瀏覽器發(fā)現(xiàn)侥锦,這是一個(gè)非簡(jiǎn)單請(qǐng)求进栽,就自動(dòng)發(fā)出一個(gè)"預(yù)檢"請(qǐng)求,要求服務(wù)器確認(rèn)可以這樣請(qǐng)求恭垦。下面是這個(gè)"預(yù)檢"請(qǐng)求的HTTP頭信息快毛。

OPTIONS /cors HTTP/1.1
Origin: http://api.bob.com
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-Header
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...

"預(yù)檢"請(qǐng)求用的請(qǐng)求方法是OPTIONS盲厌,表示這個(gè)請(qǐng)求是用來(lái)詢(xún)問(wèn)的。頭信息里面祸泪,關(guān)鍵字段是Origin吗浩,表示請(qǐng)求來(lái)自哪個(gè)源。

除了Origin字段没隘,"預(yù)檢"請(qǐng)求的頭信息包括兩個(gè)特殊字段懂扼。

  • (1)Access-Control-Request-Method

該字段是必須的,用來(lái)列出瀏覽器的CORS請(qǐng)求會(huì)用到哪些HTTP方法右蒲,上例是PUT阀湿。

  • (2)Access-Control-Request-Headers

該字段是一個(gè)逗號(hào)分隔的字符串,指定瀏覽器CORS請(qǐng)求會(huì)額外發(fā)送的頭信息字段瑰妄,上例是X-Custom-Header陷嘴。

4.2 預(yù)檢請(qǐng)求的回應(yīng)

服務(wù)器收到"預(yù)檢"請(qǐng)求以后,檢查了Origin间坐、Access-Control-Request-Method和Access-Control-Request-Headers字段以后灾挨,確認(rèn)允許跨源請(qǐng)求,就可以做出回應(yīng)竹宋。

HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Content-Type: text/html; charset=utf-8
Content-Encoding: gzip
Content-Length: 0
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Content-Type: text/plain

上面的HTTP回應(yīng)中劳澄,關(guān)鍵的是Access-Control-Allow-Origin字段,表示http://api.bob.com可以請(qǐng)求數(shù)據(jù)蜈七。該字段也可以設(shè)為星號(hào)秒拔,表示同意任意跨源請(qǐng)求。

Access-Control-Allow-Origin: *

如果瀏覽器否定了"預(yù)檢"請(qǐng)求飒硅,會(huì)返回一個(gè)正常的HTTP回應(yīng)砂缩,但是沒(méi)有任何CORS相關(guān)的頭信息字段。這時(shí)三娩,瀏覽器就會(huì)認(rèn)定庵芭,服務(wù)器不同意預(yù)檢請(qǐng)求,因此觸發(fā)一個(gè)錯(cuò)誤尽棕,被XMLHttpRequest對(duì)象的onerror回調(diào)函數(shù)捕獲喳挑。控制臺(tái)會(huì)打印出如下的報(bào)錯(cuò)信息滔悉。

XMLHttpRequest cannot load http://api.alice.com.
Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin.

服務(wù)器回應(yīng)的其他CORS相關(guān)字段如下。

Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000

  • (1)Access-Control-Allow-Methods

該字段必需单绑,它的值是逗號(hào)分隔的一個(gè)字符串回官,表明服務(wù)器支持的所有跨域請(qǐng)求的方法。注意搂橙,返回的是所有支持的方法歉提,而不單是瀏覽器請(qǐng)求的那個(gè)方法。這是為了避免多次"預(yù)檢"請(qǐng)求。

  • (2)Access-Control-Allow-Headers

如果瀏覽器請(qǐng)求包括Access-Control-Request-Headers字段苔巨,則Access-Control-Allow-Headers字段是必需的版扩。它也是一個(gè)逗號(hào)分隔的字符串,表明服務(wù)器支持的所有頭信息字段侄泽,不限于瀏覽器在"預(yù)檢"中請(qǐng)求的字段礁芦。

  • (3)Access-Control-Allow-Credentials

該字段與簡(jiǎn)單請(qǐng)求時(shí)的含義相同。

  • (4)Access-Control-Max-Age

該字段可選悼尾,用來(lái)指定本次預(yù)檢請(qǐng)求的有效期柿扣,單位為秒。上面結(jié)果中闺魏,有效期是20天(1728000秒)未状,即允許緩存該條回應(yīng)1728000秒(即20天),在此期間析桥,不用發(fā)出另一條預(yù)檢請(qǐng)求司草。

4.3 瀏覽器的正常請(qǐng)求和回應(yīng)

一旦服務(wù)器通過(guò)了"預(yù)檢"請(qǐng)求,以后每次瀏覽器正常的CORS請(qǐng)求泡仗,就都跟簡(jiǎn)單請(qǐng)求一樣翻伺,會(huì)有一個(gè)Origin頭信息字段。服務(wù)器的回應(yīng)吨岭,也都會(huì)有一個(gè)Access-Control-Allow-Origin頭信息字段峦树。

下面是"預(yù)檢"請(qǐng)求之后魁巩,瀏覽器的正常CORS請(qǐng)求。

PUT /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
X-Custom-Header: value
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...

上面頭信息的Origin字段是瀏覽器自動(dòng)添加的葬馋。

下面是服務(wù)器正常的回應(yīng)畴嘶。

Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8

上面頭信息中集晚,Access-Control-Allow-Origin字段是每次回應(yīng)都必定包含的。

五蒋院、與JSONP的比較

CORS與JSONP的使用目的相同,但是比JSONP更強(qiáng)大姑丑。

JSONP只支持GET請(qǐng)求栅哀,CORS支持所有類(lèi)型的HTTP請(qǐng)求踏枣。JSONP的優(yōu)勢(shì)在于支持老式瀏覽器茵瀑,以及可以向不支持CORS的網(wǎng)站請(qǐng)求數(shù)據(jù)马昨。

(完)

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市屹篓,隨后出現(xiàn)的幾起案子堆巧,更是在濱河造成了極大的恐慌谍肤,老刑警劉巖哗伯,帶你破解...
    沈念sama閱讀 218,941評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件系任,死亡現(xiàn)場(chǎng)離奇詭異虐块,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)举农,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)颁糟,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)棱貌,“玉大人婚脱,你說(shuō)我怎么就攤上這事障贸∫骰拢” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,345評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)蜗侈。 經(jīng)常有香客問(wèn)我,道長(zhǎng)枷颊,這世上最難降的妖魔是什么该面? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,851評(píng)論 1 295
  • 正文 為了忘掉前任吆倦,我火速辦了婚禮蚕泽,結(jié)果婚禮上须妻,老公的妹妹穿的比我還像新娘。我一直安慰自己敛惊,他們只是感情好瞧挤,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布特恬。 她就那樣靜靜地躺著,像睡著了一般役首。 火紅的嫁衣襯著肌膚如雪衡奥。 梳的紋絲不亂的頭發(fā)上远荠,一...
    開(kāi)封第一講書(shū)人閱讀 51,688評(píng)論 1 305
  • 那天乏屯,我揣著相機(jī)與錄音辰晕,去河邊找鬼含友。 笑死校辩,一個(gè)胖子當(dāng)著我的面吹牛宜咒,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播儿咱,決...
    沈念sama閱讀 40,414評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼混埠,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼钳宪!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起搔体,我...
    開(kāi)封第一講書(shū)人閱讀 39,319評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤嫉柴,失蹤者是張志新(化名)和其女友劉穎奉呛,沒(méi)想到半個(gè)月后瞧壮,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體匙握,經(jīng)...
    沈念sama閱讀 45,775評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡秦忿,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了胎许。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片罗售。...
    茶點(diǎn)故事閱讀 40,096評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡辜窑,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出寨躁,到底是詐尸還是另有隱情穆碎,我是刑警寧澤,帶...
    沈念sama閱讀 35,789評(píng)論 5 346
  • 正文 年R本政府宣布职恳,位于F島的核電站所禀,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏话肖。R本人自食惡果不足惜北秽,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望最筒。 院中可真熱鬧贺氓,春花似錦、人聲如沸蔑水。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,993評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春赏壹,著一層夾襖步出監(jiān)牢的瞬間俐巴,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,107評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工糟把, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人聪舒。 一個(gè)月前我還...
    沈念sama閱讀 48,308評(píng)論 3 372
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像敷待,于是被迫代替她去往敵國(guó)和親抗蠢。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容