轉(zhuǎn)載于阮一峰老師的跨域資源共享 CORS 詳解
CORS是一個(gè)W3C標(biāo)準(zhǔn)救氯,全稱是"跨域資源共享"(Cross-origin resource sharing)。
它允許瀏覽器向跨源服務(wù)器椒涯,發(fā)出XMLHttpRequest
請(qǐng)求,從而克服了AJAX只能同源使用的限制回梧。
一废岂、簡(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.1 Origin: [http://api.bob.com](http://api.bob.com/)Host: 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)?em>HTTP回應(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: 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屬性簸呈。
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)頁一致的域名功茴。同時(shí),Cookie依然遵循同源政策孽亲,只有用服務(wù)器域名設(shè)置的Cookie才會(huì)上傳坎穿,其他域名的Cookie并不會(huì)上傳,且(跨源)原網(wǎng)頁代碼中的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)頁所在的域名是否在服務(wù)器的許可名單之中犬钢,以及可以使用哪些HTTP動(dòng)詞和頭信息字段苍鲜。只有得到肯定答復(fù),瀏覽器才會(huì)發(fā)出正式的XMLHttpRequest請(qǐng)求玷犹,否則就報(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請(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.com](http://api.bob.com/)Access-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.com](http://api.bob.com/)Access-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, 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)求靠闭。
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.com](http://api.bob.com/)Host: 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.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請(qǐng)求,CORS支持所有類型的HTTP請(qǐng)求唯袄。JSONP的優(yōu)勢(shì)在于支持老式瀏覽器弯屈,以及可以向不支持CORS的網(wǎng)站請(qǐng)求數(shù)據(jù)。