什么是跨域HTTP請(qǐng)求
現(xiàn)代瀏覽器出于安全的考慮痊项,使用 XMLHttpRequest對(duì)象發(fā)起 HTTP請(qǐng)求時(shí)必須遵守同源策略,否則就是跨域的HTTP請(qǐng)求酥诽,默認(rèn)情況下是被禁止的鞍泉。跨域HTTP請(qǐng)求是指A域上資源請(qǐng)求了B域上的資源肮帐,舉例而言咖驮,部署在A機(jī)器上Nginx上的js代碼通過ajax請(qǐng)求了部署在B機(jī)器Tomcat上的RESTful接口边器。
IP(域名)不同、或者端口不同托修,都會(huì)造成跨域問題忘巧。為了解決跨域的問題,曾經(jīng)出現(xiàn)過jsonp睦刃、代理文件等方案砚嘴,應(yīng)用場景受限,維護(hù)成本高涩拙,直到HTML5帶來了CORS協(xié)議际长。
CORS是一個(gè)W3C標(biāo)準(zhǔn),全稱是”跨域資源共享”(Cross-origin resource sharing)吃环,允許瀏覽器向跨源服務(wù)器,發(fā)出XMLHttpRequest請(qǐng)求洋幻,從而克服了AJAX只能同源使用的限制郁轻。它通過服務(wù)器增加一個(gè)特殊的Header[Access-Control-Allow-Origin]來告訴客戶端跨域的限制,如果瀏覽器支持CORS文留、并且判斷Origin通過的話好唯,就會(huì)允許XMLHttpRequest發(fā)起跨域請(qǐng)求。
一燥翅、簡介
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)求分成兩類:簡單請(qǐng)求(simple request)和非簡單請(qǐng)求(not-so-simple request)。
只要同時(shí)滿足以下兩大條件,就屬于簡單請(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è)條件绸栅,就屬于非簡單請(qǐng)求级野。
瀏覽器對(duì)這兩種請(qǐng)求的處理,是不一樣的粹胯。
三蓖柔、簡單請(qǐng)求
3.1 基本流程
對(duì)于簡單請(qǐng)求,瀏覽器直接發(fā)出CORS請(qǐng)求风纠。具體來說况鸣,就是在頭信息之中,增加一個(gè)Origin字段竹观。
下面是一個(gè)例子镐捧,瀏覽器發(fā)現(xiàn)這次跨源AJAX請(qǐng)求是簡單請(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)頁一致的域名。同時(shí)艘儒,Cookie依然遵循同源政策聋伦,只有用服務(wù)器域名設(shè)置的Cookie才會(huì)上傳,其他域名的Cookie并不會(huì)上傳界睁,且(跨源)原網(wǎng)頁代碼中的document.cookie也無法讀取服務(wù)器域名下的Cookie觉增。
四、非簡單請(qǐng)求
4.1 預(yù)檢請(qǐng)求
非簡單請(qǐng)求是那種對(duì)服務(wù)器有特殊要求的請(qǐng)求翻斟,比如請(qǐng)求方法是PUT或DELETE逾礁,或者Content-Type字段的類型是application/json。
非簡單請(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腳本配并。
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è)非簡單請(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
該字段與簡單請(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)求,就都跟簡單請(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)勢在于支持老式瀏覽器犀农,以及可以向不支持CORS的網(wǎng)站請(qǐng)求數(shù)據(jù)惰赋。