http://www.ruanyifeng.com/blog/2016/04/cors.html
CORS是一個(gè)W3C標(biāo)準(zhǔn),全稱是"跨域資源共享"(Cross-origin resource sharing)涮雷。
它允許瀏覽器向跨源服務(wù)器馁害,發(fā)出XMLHttpRequest
請(qǐng)求痕届,從而克服了AJAX只能同源使用的限制。
【注2】[XMLHttpRequest]是一個(gè)瀏覽器接口凳忙,使得Javascript可以進(jìn)行HTTP(S)通信宫补。
【注2】同源:最初,它的含義是指碎节,A網(wǎng)頁(yè)設(shè)置的 Cookie捧搞,B網(wǎng)頁(yè)不能打開(kāi),除非這兩個(gè)網(wǎng)頁(yè)"同源"狮荔。所謂"同源"指的是"三個(gè)相同"胎撇。
1.協(xié)議相同
2.域名相同
3.端口相同
舉例來(lái)說(shuō),http://www.example.com/dir/page.html這個(gè)網(wǎng)址殖氏,協(xié)議是http://晚树,域名是www.example.com,端口是80(默認(rèn)端口可以省略)雅采。它的同源情況如下爵憎。
http://www.example.com/dir2/other.html:同源
http://example.com/dir/other.html:不同源(域名不同)
http://v2.www.example.com/dir/other.html:不同源(域名不同)
http://www.example.com:81/dir/other.html:不同源(端口不同)
本文詳細(xì)介紹CORS的內(nèi)部機(jī)制。
一婚瓜、簡(jiǎn)介
CORS需要瀏覽器和服務(wù)器同時(shí)支持宝鼓。目前,所有瀏覽器都支持該功能巴刻,IE瀏覽器不能低于IE10愚铡。
整個(gè)CORS通信過(guò)程,都是瀏覽器自動(dòng)完成胡陪,不需要用戶參與沥寥。對(duì)于開(kāi)發(fā)者來(lái)說(shuō),CORS通信與同源的AJAX通信沒(méi)有差別柠座,代碼完全一樣邑雅。瀏覽器一旦發(fā)現(xiàn)AJAX請(qǐng)求跨源,就會(huì)自動(dòng)添加一些附加的頭信息愚隧,有時(shí)還會(huì)多出一次附加的請(qǐng)求,但用戶不會(huì)有感覺(jué)锻全。
因此狂塘,實(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)求瘪吏。具體來(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ā)送Cookie和HTTP認(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)求方法是PUT
或DELETE
淆两,或者Content-Type
字段的類型是application/json
断箫。
非簡(jiǎn)單請(qǐng)求的CORS請(qǐng)求,會(huì)在正式通信之前秋冰,增加一次HTTP查詢請(qǐng)求仲义,稱為"預(yù)檢"請(qǐng)求(preflight)。
瀏覽器先詢問(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)詢問(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支持所有類型的HTTP請(qǐng)求侣背。JSONP的優(yōu)勢(shì)在于支持老式瀏覽器,以及可以向不支持CORS的網(wǎng)站請(qǐng)求數(shù)據(jù)慨默。