一、簡(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)求
3.1 基本流程
對(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.1Origin:http://api.bob.comHost:api.alice.comAccept-Language:en-USConnection:keep-aliveUser-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.comAccess-Control-Allow-Credentials:trueAccess-Control-Expose-Headers:FooBarContent-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字段的值。
3.2 withCredentials 屬性
上面說到笔链,CORS請(qǐng)求默認(rèn)不發(fā)送Cookie和HTTP認(rèn)證信息段只。如果要把Cookie發(fā)到服務(wù)器,一方面要服務(wù)器同意鉴扫,指定Access-Control-Allow-Credentials字段赞枕。
Access-Control-Allow-Credentials:true
另一方面,開發(fā)者必須在AJAX請(qǐng)求中打開withCredentials屬性。
varxhr=newXMLHttpRequest();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)求
4.1 預(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腳本鸯乃。
varurl='http://api.alice.com/cors';varxhr=newXMLHttpRequest();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.1Origin:http://api.bob.comAccess-Control-Request-Method:PUTAccess-Control-Request-Headers:X-Custom-HeaderHost:api.alice.comAccept-Language:en-USConnection:keep-aliveUser-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博敬。
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 OKDate:Mon, 01 Dec 2008 01:15:39 GMTServer:Apache/2.0.61 (Unix)Access-Control-Allow-Origin:http://api.bob.comAccess-Control-Allow-Methods:GET, POST, PUTAccess-Control-Allow-Headers:X-Custom-HeaderContent-Type:text/html; charset=utf-8Content-Encoding:gzipContent-Length:0Keep-Alive:timeout=2, max=100Connection:Keep-AliveContent-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)已骇,但是沒有任何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, PUTAccess-Control-Allow-Headers:X-Custom-HeaderAccess-Control-Allow-Credentials:trueAccess-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)求。
4.3 瀏覽器的正常請(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.1Origin:http://api.bob.comHost:api.alice.comX-Custom-Header:valueAccept-Language:en-USConnection:keep-aliveUser-Agent:Mozilla/5.0...
上面頭信息的Origin字段是瀏覽器自動(dòng)添加的。
下面是服務(wù)器正常的回應(yīng)阁危。
Access-Control-Allow-Origin:http://api.bob.comContent-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ù)浙宜。
摘自:http://www.ruanyifeng.com/blog/2016/04/cors.html