CORS是一個(gè)W3C標(biāo)準(zhǔn)围小,全稱是“跨域資源共享”(Cross-origin resource sharing)让网。
它允許瀏覽器向跨源服務(wù)器芝硬,發(fā)出XMLHttpRequest
請(qǐng)求对碌,從而克服了AJAX只能同源使用的限制事期。
本文詳細(xì)介紹CORS的內(nèi)部機(jī)制滥壕。
簡(jiǎn)介
CORS需要瀏覽器和服務(wù)器同時(shí)支持。目前兽泣,所有瀏覽器都支持該功能绎橘,IE瀏覽器不能低于IE10。
整個(gè)CORS通信過程,都是瀏覽器自動(dòng)完成称鳞,不需要用戶參與涮较。對(duì)于開發(fā)者來說,CORS通信與同源的AJAX通信沒有差別冈止,代碼完全一樣狂票。瀏覽器一旦發(fā)現(xiàn)AJAX請(qǐng)求跨源,就會(huì)自動(dòng)添加一些附加的頭信息熙暴,有時(shí)還會(huì)多出一次附加的請(qǐng)求闺属,但用戶不會(huì)有感覺。
因此周霉,實(shí)現(xiàn)CORS通信的關(guān)鍵是服務(wù)器掂器。只要服務(wù)器實(shí)現(xiàn)了CORS接口,就可以跨源通信俱箱。
兩種請(qǐng)求
瀏覽器將CORS請(qǐng)求分成兩類:簡(jiǎn)單請(qǐng)求(simple request)和非簡(jiǎn)單請(qǐng)求(not-so-simple request)唉匾。
只要同時(shí)滿足以下兩大條件,就屬于簡(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í)滿足上面兩個(gè)條件璃饱,就屬于非簡(jiǎn)單請(qǐng)求与斤。
瀏覽器對(duì)這兩種請(qǐng)求的處理,是不一樣的荚恶。
簡(jiǎn)單請(qǐng)求
基本流程
對(duì)于簡(jiǎn)單請(qǐng)求撩穿,瀏覽器直接發(fā)出CORS請(qǐng)求。具體來說谒撼,就是在頭信息之中食寡,增加一個(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
字段用來說明,本次請(qǐng)求來自哪個(gè)源(協(xié)議 + 域名 + 端口)悼院。服務(wù)器根據(jù)這個(gè)值伤为,決定是否同意這次請(qǐng)求。
如果Origin
指定的源据途,不在許可范圍內(nèi)绞愚,服務(wù)器會(huì)返回一個(gè)正常的HTTP回應(yīng)叙甸。瀏覽器發(fā)現(xiàn),這個(gè)回應(yīng)的頭信息沒有包含Access-Control-Allow-Origin
字段(詳見下文)爽醋,就知道出錯(cuò)了蚁署,從而拋出一個(gè)錯(cuò)誤,被XMLHttpRequest
的onerror
回調(diào)函數(shù)捕獲蚂四。注意光戈,這種錯(cuò)誤無法通過狀態(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-
開頭抑诸。
(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
字段的值奋单。
withCredentials 屬性
上面說到锉试,CORS請(qǐng)求默認(rèn)不包含Cookie信息(以及HTTP認(rèn)證信息等)。如果需要包含Cookie信息览濒,一方面要服務(wù)器同意呆盖,指定Access-Control-Allow-Credentials
字段。
Access-Control-Allow-Credentials: true
另一方面贷笛,開發(fā)者必須在AJAX請(qǐng)求中打開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ù)器域名下的Cookie挠羔。
非簡(jiǎn)單請(qǐng)求
預(yù)檢請(qǐng)求
非簡(jiǎn)單請(qǐng)求是那種對(duì)服務(wù)器有特殊要求的請(qǐng)求井仰,比如請(qǐng)求方法是PUT
或DELETE
,或者Content-Type
字段的類型是application/json
破加。
非簡(jiǎn)單請(qǐng)求的CORS請(qǐng)求俱恶,會(huì)在正式通信之前,增加一次HTTP查詢請(qǐng)求,稱為“預(yù)檢”請(qǐng)求(preflight)合是。
瀏覽器先詢問服務(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)求是用來詢問的。頭信息里面稚机,關(guān)鍵字段是Origin
幕帆,表示請(qǐng)求來自哪個(gè)源。
除了Origin
字段赖条,“預(yù)檢”請(qǐng)求的頭信息包括兩個(gè)特殊字段失乾。
(1)Access-Control-Request-Method
該字段是必須的,用來列出瀏覽器的CORS請(qǐng)求會(huì)用到哪些HTTP方法纬乍,上例是PUT
碱茁。
(2)Access-Control-Request-Headers
該字段是一個(gè)逗號(hào)分隔的字符串,指定瀏覽器CORS請(qǐng)求會(huì)額外發(fā)送的頭信息字段仿贬,上例是X-Custom-Header
纽竣。
預(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](http://api.bob.com/)
可以請(qǐng)求數(shù)據(jù)嗜侮。該字段也可以設(shè)為星號(hào)刀荒,表示同意任意跨源請(qǐng)求代嗤。
Access-Control-Allow-Origin: *
如果服務(wù)器否定了“預(yù)檢”請(qǐng)求,會(huì)返回一個(gè)正常的HTTP回應(yīng)缠借,但是沒有任何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
該字段可選,用來指定本次預(yù)檢請(qǐng)求的有效期枪萄,單位為秒隐岛。上面結(jié)果中,有效期是20天(1728000秒)呻引,即允許緩存該條回應(yīng)1728000秒(即20天),在此期間吐咳,不用發(fā)出另一條預(yù)檢請(qǐng)求逻悠。
瀏覽器的正常請(qǐng)求和回應(yīng)
一旦服務(wù)器通過了“預(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支持所有類型的HTTP請(qǐng)求驰贷。JSONP的優(yōu)勢(shì)在于支持老式瀏覽器,以及可以向不支持CORS的網(wǎng)站請(qǐng)求數(shù)據(jù)洛巢。
參考鏈接
- Monsur Hossain, Using CORS
- MDN, HTTP access control (CORS)