轉(zhuǎn)載自:http://www.ruanyifeng.com/blog/2016/04/cors.html
可參考:http://blog.csdn.net/hfahe/article/details/7730944
一、簡介##
CORS需要瀏覽器和服務(wù)器同時(shí)支持。目前仍律,所有瀏覽器都支持該功能,IE瀏覽器不能低于IE10锋爪。
整個(gè)CORS通信過程丙曙,都是瀏覽器自動(dòng)完成,不需要用戶參與几缭。對于開發(fā)者來說河泳,CORS通信與同源的AJAX通信沒有差別,代碼完全一樣年栓。瀏覽器一旦發(fā)現(xiàn)AJAX請求跨源拆挥,就會(huì)自動(dòng)添加一些附加的頭信息,有時(shí)還會(huì)多出一次附加的請求某抓,但用戶不會(huì)有感覺纸兔。
因此,實(shí)現(xiàn)CORS通信的關(guān)鍵是服務(wù)器否副。只要服務(wù)器實(shí)現(xiàn)了CORS接口汉矿,就可以跨源通信。
二备禀、兩種請求##
瀏覽器將CORS請求分成兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)洲拇。
只要同時(shí)滿足以下兩大條件,就屬于簡單請求曲尸。
(1) 請求方法是以下三種方法之一:
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è)條件另患,就屬于非簡單請求纽乱。
瀏覽器對這兩種請求的處理,是不一樣的昆箕。
三鸦列、簡單請求##
3.1 基本流程###
對于簡單請求,瀏覽器直接發(fā)出CORS
請求鹏倘。具體來說薯嗤,就是在頭信息之中,增加一個(gè)Origin
字段纤泵。
下面是一個(gè)例子应民,瀏覽器發(fā)現(xiàn)這次跨源AJAX請求是簡單請求,就自動(dòng)在頭信息之中夕吻,添加一個(gè)Origin
字段。
GET /cors HTTP/1.1
Origin: [http://api.bob.com](http://api.bob.com/)
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
上面的頭信息中繁仁,Origin
字段用來說明涉馅,本次請求來自哪個(gè)源(協(xié)議 + 域名 + 端口)。服務(wù)器根據(jù)這個(gè)值黄虱,決定是否同意這次請求稚矿。
如果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](http://api.bob.com/)
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
上面的頭信息之中池户,有三個(gè)與CORS請求相關(guān)的字段咏雌,都以Access-Control-
開頭。
(1)Access-Control-Allow-Origin
該字段是必須的校焦。它的值要么是請求時(shí)Origin
字段的值赊抖,要么是一個(gè)*
,表示接受任意域名的請求斟湃。
(2)Access-Control-Allow-Credentials
該字段可選熏迹。它的值是一個(gè)布爾值,表示是否允許發(fā)送Cookie凝赛。默認(rèn)情況下注暗,Cookie不包括在CORS請求之中。設(shè)為true
墓猎,即表示服務(wù)器明確許可捆昏,Cookie可以包含在請求中,一起發(fā)給服務(wù)器毙沾。這個(gè)值也只能設(shè)為true
骗卜,如果服務(wù)器不要瀏覽器發(fā)送Cookie,刪除該字段即可左胞。
(3)Access-Control-Expose-Headers
該字段可選寇仓。CORS請求時(shí),XMLHttpRequest
對象的getResponseHeader()
方法只能拿到6個(gè)基本字段:Cache-Control
烤宙、Content-Language
遍烦、Content-Type
,Expires
躺枕、Last-Modified
服猪、Pragma
供填。如果想拿到其他字段,就必須在Access-Control-Expose-Headers
里面指定罢猪。上面的例子指getResponseHeader('FooBar')
可以返回FooBar字段的值近她。
3.2 withCredentials 屬性###
上面說到,CORS請求默認(rèn)不發(fā)送Cookie和HTTP認(rèn)證信息膳帕。如果要把Cookie發(fā)到服務(wù)器粘捎,一方面要服務(wù)器同意,指定Access-Control-Allow-Credentials
字段备闲。
Access-Control-Allow-Credentials: true
另一方面晌端,開發(fā)者必須在AJAX請求中打開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),必須指定明確的兆沙、與請求網(wǎng)頁一致的域名欧芽。同時(shí),Cookie依然遵循同源政策葛圃,只有用服務(wù)器域名設(shè)置的Cookie才會(huì)上傳千扔,其他域名的Cookie并不會(huì)上傳,且(跨源)原網(wǎng)頁代碼中的document.cookie
也無法讀取服務(wù)器域名下的Cookie库正。
四曲楚、非簡單請求##
4.1 預(yù)檢請求###
非簡單請求是那種對服務(wù)器有特殊要求的請求,比如請求方法是PUT
或DELETE
褥符,或者Content-Type
字段的類型是application/json
洞渤。
非簡單請求的CORS請求,會(huì)在正式通信之前属瓣,增加一次HTTP查詢請求载迄,稱為"預(yù)檢"請求(preflight)。
瀏覽器先詢問服務(wù)器抡蛙,當(dāng)前網(wǎng)頁所在的域名是否在服務(wù)器的許可名單之中护昧,以及可以使用哪些HTTP動(dòng)詞和頭信息字段。只有得到肯定答復(fù)粗截,瀏覽器才會(huì)發(fā)出正式的XMLHttpRequest
請求惋耙,否則就報(bào)錯(cuò)。
下面是一段瀏覽器的JavaScript腳本熊昌。
var url = '[http://api.alice.com/cors](http://api.alice.com/cors)';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();
上面代碼中绽榛,HTTP請求的方法是PUT
,并且發(fā)送一個(gè)自定義頭信息X-Custom-Header婿屹。
瀏覽器發(fā)現(xiàn)灭美,這是一個(gè)非簡單請求,就自動(dòng)發(fā)出一個(gè)"預(yù)檢"請求昂利,要求服務(wù)器確認(rèn)可以這樣請求届腐。下面是這個(gè)"預(yù)檢"請求的HTTP頭信息。
OPTIONS /cors HTTP/1.1
Origin: [http://api.bob.com](http://api.bob.com/)
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-HeaderHost: api.alice.com
Accept-Language: en-USConnection: keep-alive
User-Agent: Mozilla/5.0...
"預(yù)檢"請求用的請求方法是OPTIONS
蜂奸,表示這個(gè)請求是用來詢問的犁苏。頭信息里面,關(guān)鍵字段是Origin
扩所,表示請求來自哪個(gè)源围详。
除了Origin
字段,"預(yù)檢"請求的頭信息包括兩個(gè)特殊字段祖屏。
(1)Access-Control-Request-Method
該字段是必須的助赞,用來列出瀏覽器的CORS請求會(huì)用到哪些HTTP方法,上例是PUT
赐劣。
(2)Access-Control-Request-Headers
該字段是一個(gè)逗號(hào)分隔的字符串嫉拐,指定瀏覽器CORS請求會(huì)額外發(fā)送的頭信息字段,上例是X-Custom-Header
魁兼。
4.2 預(yù)檢請求的回應(yīng)###
服務(wù)器收到"預(yù)檢"請求以后婉徘,檢查了Origin
、Access-Control-Request-Method
和Access-Control-Request-Headers
字段以后咐汞,確認(rèn)允許跨源請求盖呼,就可以做出回應(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](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
可以請求數(shù)據(jù)。該字段也可以設(shè)為星號(hào)植阴,表示同意任意跨源求蟹瘾。
Access-Control-Allow-Origin: *
如果瀏覽器否定了"預(yù)檢"請求圾浅,會(huì)返回一個(gè)正常的HTTP回應(yīng),但是沒有任何CORS相關(guān)的頭信息字段憾朴。這時(shí)狸捕,瀏覽器就會(huì)認(rèn)定,服務(wù)器不同意預(yù)檢請求众雷,因此觸發(fā)一個(gè)錯(cuò)誤灸拍,被XMLHttpRequest
對象的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ù)器支持的所有跨域請求的方法轩性。注意,返回的是所有支持的方法翻诉,而不單是瀏覽器請求的那個(gè)方法炮姨。這是為了避免多次"預(yù)檢"請求。
(2)Access-Control-Allow-Headers
如果瀏覽器請求包括Access-Control-Request-Headers
字段碰煌,則Access-Control-Allow-Headers
字段是必需的舒岸。它也是一個(gè)逗號(hào)分隔的字符串,表明服務(wù)器支持的所有頭信息字段芦圾,不限于瀏覽器在"預(yù)檢"中請求的字段蛾派。
(3)Access-Control-Allow-Credentials
該字段與簡單請求時(shí)的含義相同。
(4)Access-Control-Max-Age
該字段可選个少,用來指定本次預(yù)檢請求的有效期洪乍,單位為秒。上面結(jié)果中夜焦,有效期是20天(1728000秒)壳澳,即允許緩存該條回應(yīng)1728000秒(即20天),在此期間茫经,不用發(fā)出另一條預(yù)檢請求巷波。
4.3 瀏覽器的正常請求和回應(yīng)###
一旦服務(wù)器通過了"預(yù)檢"請求,以后每次瀏覽器正常的CORS請求卸伞,就都跟簡單請求一樣抹镊,會(huì)有一個(gè)Origin
頭信息字段。服務(wù)器的回應(yīng)荤傲,也都會(huì)有一個(gè)Access-Control-Allow-Origin
頭信息字段垮耳。
下面是"預(yù)檢"請求之后,瀏覽器的正常CORS請求。
PUT /cors HTTP/1.1
Origin: [http://api.bob.com](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](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
請求,CORS支持所有類型的HTTP請求唬党。JSONP的優(yōu)勢在于支持老式瀏覽器鹃共,以及可以向不支持CORS的網(wǎng)站請求數(shù)據(jù)。