CORS是一個W3C標(biāo)準(zhǔn)缭保,全稱是"跨域資源共享"(Cross-origin resource sharing)。
它允許瀏覽器向跨源服務(wù)器蝙茶,發(fā)出XMLHttpRequest請求艺骂,從而克服了AJAX只能同源使用的限制。
本文詳細介紹CORS的內(nèi)部機制隆夯。
一钳恕、簡介
CORS需要瀏覽器和服務(wù)器同時支持。目前蹄衷,所有瀏覽器都支持該功能苞尝,IE瀏覽器不能低于IE10。
整個CORS通信過程宦芦,都是瀏覽器自動完成宙址,不需要用戶參與。對于開發(fā)者來說调卑,CORS通信與同源的AJAX通信沒有差別减俏,代碼完全一樣。瀏覽器一旦發(fā)現(xiàn)AJAX請求跨源咆霜,就會自動添加一些附加的頭信息舶沿,有時還會多出一次附加的請求,但用戶不會有感覺溯捆。
因此丑搔,實現(xiàn)CORS通信的關(guān)鍵是服務(wù)器厦瓢。只要服務(wù)器實現(xiàn)了CORS接口,就可以跨源通信啤月。
二煮仇、兩種請求
瀏覽器將CORS請求分成兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)。
只要同時滿足以下兩大條件谎仲,就屬于簡單請求浙垫。
(1) 請求方法是以下三種方法之一:
HEAD
GET
POST
(2)HTTP的頭信息不超出以下幾種字段:
Accept
Accept-Language
Content-Language
Last-Event-ID
Content-Type:只限于三個值application/x-www-form-urlencoded、multipart/form-data郑诺、text/plain
凡是不同時滿足上面兩個條件夹姥,就屬于非簡單請求。
瀏覽器對這兩種請求的處理辙诞,是不一樣的辙售。
三、簡單請求
3.1 基本流程
對于簡單請求飞涂,瀏覽器直接發(fā)出CORS請求旦部。具體來說,就是在頭信息之中封拧,增加一個Origin字段志鹃。
下面是一個例子,瀏覽器發(fā)現(xiàn)這次跨源AJAX請求是簡單請求泽西,就自動在頭信息之中曹铃,添加一個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字段用來說明陕见,本次請求來自哪個源(協(xié)議 + 域名 + 端口)。服務(wù)器根據(jù)這個值味抖,決定是否同意這次請求评甜。
如果Origin指定的源,不在許可范圍內(nèi)仔涩,服務(wù)器會返回一個正常的HTTP回應(yīng)忍坷。瀏覽器發(fā)現(xiàn),這個回應(yīng)的頭信息沒有包含Access-Control-Allow-Origin字段(詳見下文)熔脂,就知道出錯了佩研,從而拋出一個錯誤,被XMLHttpRequest的onerror回調(diào)函數(shù)捕獲霞揉。注意旬薯,這種錯誤無法通過狀態(tài)碼識別,因為HTTP回應(yīng)的狀態(tài)碼有可能是200适秩。
如果Origin指定的域名在許可范圍內(nèi)绊序,服務(wù)器返回的響應(yīng)硕舆,會多出幾個頭信息字段。
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
上面的頭信息之中骤公,有三個與CORS請求相關(guān)的字段抚官,都以Access-Control-開頭。
(1)Access-Control-Allow-Origin
該字段是必須的淋样。它的值要么是請求時Origin字段的值耗式,要么是一個*胁住,表示接受任意域名的請求趁猴。
(2)Access-Control-Allow-Credentials
該字段可選。它的值是一個布爾值彪见,表示是否允許發(fā)送Cookie儡司。默認(rèn)情況下,Cookie不包括在CORS請求之中余指。設(shè)為true捕犬,即表示服務(wù)器明確許可,Cookie可以包含在請求中酵镜,一起發(fā)給服務(wù)器碉碉。這個值也只能設(shè)為true,如果服務(wù)器不要瀏覽器發(fā)送Cookie淮韭,刪除該字段即可垢粮。
(3)Access-Control-Expose-Headers
該字段可選。CORS請求時靠粪,XMLHttpRequest對象的getResponseHeader()方法只能拿到6個基本字段: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=newXMLHttpRequest();
xhr.withCredentials=true;
否則,即使服務(wù)器同意發(fā)送Cookie硫眯,瀏覽器也不會發(fā)送蕴侧。或者两入,服務(wù)器要求設(shè)置Cookie净宵,瀏覽器也不會處理。
但是裹纳,如果省略withCredentials設(shè)置择葡,有的瀏覽器還是會一起發(fā)送Cookie。這時剃氧,可以顯式關(guān)閉withCredentials敏储。
xhr.withCredentials=false;
需要注意的是,如果要發(fā)送Cookie朋鞍,Access-Control-Allow-Origin就不能設(shè)為星號已添,必須指定明確的、與請求網(wǎng)頁一致的域名滥酥。同時更舞,Cookie依然遵循同源政策,只有用服務(wù)器域名設(shè)置的Cookie才會上傳坎吻,其他域名的Cookie并不會上傳缆蝉,且(跨源)原網(wǎng)頁代碼中的document.cookie也無法讀取服務(wù)器域名下的Cookie。
四禾怠、非簡單請求
4.1 預(yù)檢請求
非簡單請求是那種對服務(wù)器有特殊要求的請求返奉,比如請求方法是PUT或DELETE,或者Content-Type字段的類型是application/json吗氏。
非簡單請求的CORS請求芽偏,會在正式通信之前,增加一次HTTP查詢請求弦讽,稱為"預(yù)檢"請求(preflight)污尉。
瀏覽器先詢問服務(wù)器,當(dāng)前網(wǎng)頁所在的域名是否在服務(wù)器的許可名單之中往产,以及可以使用哪些HTTP動詞和頭信息字段被碗。只有得到肯定答復(fù),瀏覽器才會發(fā)出正式的XMLHttpRequest請求仿村,否則就報錯锐朴。
下面是一段瀏覽器的JavaScript腳本。
var url='http://api.alice.com/cors';
var xhr=newXMLHttpRequest();
xhr.open('PUT',url,true);
xhr.setRequestHeader('X-Custom-Header','value');
xhr.send();
上面代碼中蔼囊,HTTP請求的方法是PUT焚志,并且發(fā)送一個自定義頭信息X-Custom-Header衣迷。
瀏覽器發(fā)現(xiàn),這是一個非簡單請求酱酬,就自動發(fā)出一個"預(yù)檢"請求壶谒,要求服務(wù)器確認(rèn)可以這樣請求。下面是這個"預(yù)檢"請求的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ù)檢"請求用的請求方法是OPTIONS汗菜,表示這個請求是用來詢問的。頭信息里面挑社,關(guān)鍵字段是Origin陨界,表示請求來自哪個源。
除了Origin字段滔灶,"預(yù)檢"請求的頭信息包括兩個特殊字段普碎。
(1)Access-Control-Request-Method
該字段是必須的吼肥,用來列出瀏覽器的CORS請求會用到哪些HTTP方法录平,上例是PUT。
(2)Access-Control-Request-Headers
該字段是一個逗號分隔的字符串缀皱,指定瀏覽器CORS請求會額外發(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
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è)為星號,表示同意任意跨源請求链瓦。
Access-Control-Allow-Origin:*
如果瀏覽器否定了"預(yù)檢"請求拆魏,會返回一個正常的HTTP回應(yīng),但是沒有任何CORS相關(guān)的頭信息字段慈俯。這時渤刃,瀏覽器就會認(rèn)定,服務(wù)器不同意預(yù)檢請求贴膘,因此觸發(fā)一個錯誤卖子,被XMLHttpRequest對象的onerror回調(diào)函數(shù)捕獲⌒滔浚控制臺會打印出如下的報錯信息洋闽。
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
該字段必需,它的值是逗號分隔的一個字符串喊递,表明服務(wù)器支持的所有跨域請求的方法随闪。注意,返回的是所有支持的方法骚勘,而不單是瀏覽器請求的那個方法铐伴。這是為了避免多次"預(yù)檢"請求。
(2)Access-Control-Allow-Headers
如果瀏覽器請求包括Access-Control-Request-Headers字段俏讹,則Access-Control-Allow-Headers字段是必需的当宴。它也是一個逗號分隔的字符串,表明服務(wù)器支持的所有頭信息字段泽疆,不限于瀏覽器在"預(yù)檢"中請求的字段户矢。
(3)Access-Control-Allow-Credentials
該字段與簡單請求時的含義相同。
(4)Access-Control-Max-Age
該字段可選殉疼,用來指定本次預(yù)檢請求的有效期梯浪,單位為秒。上面結(jié)果中瓢娜,有效期是20天(1728000秒)挂洛,即允許緩存該條回應(yīng)1728000秒(即20天),在此期間眠砾,不用發(fā)出另一條預(yù)檢請求虏劲。
4.3 瀏覽器的正常請求和回應(yīng)
一旦服務(wù)器通過了"預(yù)檢"請求,以后每次瀏覽器正常的CORS請求褒颈,就都跟簡單請求一樣柒巫,會有一個Origin頭信息字段。服務(wù)器的回應(yīng)谷丸,也都會有一個Access-Control-Allow-Origin頭信息字段堡掏。
下面是"預(yù)檢"請求之后,瀏覽器的正常CORS請求淤井。
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字段是瀏覽器自動添加的布疼。
下面是服務(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更強大贱案。
JSONP只支持GET請求,CORS支持所有類型的HTTP請求。JSONP的優(yōu)勢在于支持老式瀏覽器宝踪,以及可以向不支持CORS的網(wǎng)站請求數(shù)據(jù)侨糟。