CORS是一個W3C標準谅海,全稱是"跨域資源共享"(Cross-origin resource sharing)。
它允許瀏覽器向跨源服務器流码,發(fā)出
XMLHttpRequest
請求裸扶,從而克服了AJAX只能同源使用的限制。
一确丢、簡介
CORS
需要瀏覽器和服務器同時支持。目前吐限,所有瀏覽器都支持該功能鲜侥,IE瀏覽器不能低于IE10。
整個CORS通信過程诸典,都是瀏覽器自動完成描函,不需要用戶參與。對于開發(fā)者來說,CORS通信與同源的AJAX通信沒有差別舀寓,代碼完全一樣胆数。瀏覽器一旦發(fā)現(xiàn)AJAX請求跨源,就會自動添加一些附加的頭信息互墓,有時還會多出一次附加的請求必尼,但用戶不會有感覺。
因此篡撵,實現(xiàn)CORS通信的關鍵是服務器胰伍。只要服務器實現(xiàn)了CORS接口,就可以跨源通信酸休。
二骂租、兩種請求
瀏覽器將CORS請求分成兩類:簡單請求(simple request) 和 非簡單請求(not-so-simple request)。
只要同時滿足以下兩大條件斑司,就屬于簡單請求渗饮。
1、 請求方法是以下三種方法之一:
- HEAD
- GET
- POST
HTTP的頭信息不超出以下幾種字段:
- Accept
- Accept-Language
- Content-Language
- Last-Event-ID
- Content-Type:只限于三個值
application/x-www-form-urlencoded
宿刮、multipart/form-data
互站、text/plain
凡是不同時滿足上面兩個條件,就屬于非簡單請求僵缺。瀏覽器對這兩種請求的處理胡桃,是不一樣的。
三磕潮、簡單請求
基本流程
對于簡單請求翠胰,瀏覽器直接發(fā)出CORS請求。就是在頭信息之中自脯,增加一個Origin字段之景。
eg: 跨源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é)議 + 域名 + 端口)焕参。服務器根據這個值轻纪,決定是否同意這次請求。
如果Origin指定的源叠纷,不在許可范圍內刻帚,服務器會返回一個正常的HTTP回應。瀏覽器發(fā)現(xiàn)讲岁,這個回應的頭信息沒有包含Access-Control-Allow-Origin字段(詳見下文)我擂,就知道出錯了,從而拋出一個錯誤缓艳,被XMLHttpRequest的onerror回調函數捕獲校摩。注意,這種錯誤無法通過狀態(tài)碼識別阶淘,因為HTTP回應的狀態(tài)碼有可能是200衙吩。
如果Origin指定的域名在許可范圍內,服務器返回的響應溪窒,會多出幾個頭信息字段坤塞。
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請求相關的字段澈蚌,都以Access-Control-開頭摹芙。
- 1、
Access-Control-Allow-Origin
該字段是必須的宛瞄。它的值要么是請求時Origin字段的值浮禾,要么是一個*,表示接受任意域名的請求份汗。
- 2
Access-Control-Allow-Credentials
該字段可選盈电。它的值是一個布爾值,表示是否允許發(fā)送Cookie杯活。默認情況下匆帚,Cookie不包括在CORS請求之中。設為true旁钧,即表示服務器明確許可吸重,Cookie可以包含在請求中,一起發(fā)給服務器歪今。這個值也只能設為true晤锹,如果服務器不要瀏覽器發(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字段的值。
withCredentials 屬性
- 上面說到剪况,CORS請求默認不發(fā)送Cookie和HTTP認證信息教沾。如果要把Cookie發(fā)到服務器,一方面要服務器同意译断,指定Access-Control-Allow-Credentials字段授翻。
Access-Control-Allow-Credentials: true
- 另一方面,開發(fā)者必須在AJAX請求中打開withCredentials屬性孙咪。
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
否則堪唐,即使服務器同意發(fā)送Cookie,瀏覽器也不會發(fā)送翎蹈』床ぃ或者,服務器要求設置Cookie荤堪,瀏覽器也不會處理兜材。
但是,如果省略withCredentials設置逞力,有的瀏覽器還是會一起發(fā)送Cookie曙寡。這時,可以顯式關閉withCredentials寇荧。
xhr.withCredentials = false;
需要注意的是举庶,如果要發(fā)送Cookie
,Access-Control-Allow-Origin
就不能設為星號揩抡,必須指定明確的户侥、與請求網頁一致的域名。同時峦嗤,Cookie依然遵循同源政策蕊唐,只有用服務器域名設置的Cookie才會上傳,其他域名的Cookie并不會上傳烁设,且(跨源)原網頁代碼中的document.cookie
也無法讀取服務器域名下的Cookie替梨。
四、非簡單請求
1 預檢請求
非簡單請求是那種對服務器有特殊要求的請求装黑,比如請求方法是PUT
或DELETE
副瀑,或者Content-Type
字段的類型是application/json
。
非簡單請求的CORS請求恋谭,會在正式通信之前糠睡,增加一次HTTP查詢請求,稱為"預檢"請求(preflight)疚颊。
瀏覽器先詢問服務器狈孔,當前網頁所在的域名是否在服務器的許可名單之中信认,以及可以使用哪些HTTP動詞和頭信息字段。只有得到肯定答復均抽,瀏覽器才會發(fā)出正式的XMLHttpRequest
請求嫁赏,否則就報錯。
下面是一段瀏覽器的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請求的方法是PUT
清寇,并且發(fā)送一個自定義頭信息X-Custom-Header
喘漏。
瀏覽器發(fā)現(xiàn),這是一個非簡單請求华烟,就自動發(fā)出一個"預檢"請求翩迈,要求服務器確認可以這樣請求。下面是這個"預檢"請求的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...
"預檢"請求用的請求方法是OPTIONS
负饲,表示這個請求是用來詢問的。頭信息里面喂链,關鍵字段是Origin
返十,表示請求來自哪個源。
除了Origin
字段椭微,"預檢"請求的頭信息包括兩個特殊字段洞坑。
(1)Access-Control-Request-Method
該字段是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法蝇率,上例是PUT
迟杂。
(2)Access-Control-Request-Headers
該字段是一個逗號分隔的字符串,指定瀏覽器CORS請求會額外發(fā)送的頭信息字段本慕,上例是X-Custom-Header
排拷。
4.2 預檢請求的回應
服務器收到"預檢"請求以后,檢查了Origin
锅尘、Access-Control-Request-Method
和Access-Control-Request-Headers
字段以后监氢,確認允許跨源請求,就可以做出回應藤违。
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回應中忙菠,關鍵的是Access-Control-Allow-Origin
字段,表示http://api.bob.com
可以請求數據纺弊。該字段也可以設為星號牛欢,表示同意任意跨源請求。
Access-Control-Allow-Origin: *
如果瀏覽器否定了"預檢"請求淆游,會返回一個正常的HTTP回應傍睹,但是沒有任何CORS相關的頭信息字段隔盛。這時,瀏覽器就會認定拾稳,服務器不同意預檢請求吮炕,因此觸發(fā)一個錯誤,被XMLHttpRequest
對象的onerror
回調函數捕獲访得×祝控制臺會打印出如下的報錯信息。
XMLHttpRequest cannot load http://api.alice.com. Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin.
服務器回應的其他CORS相關字段如下悍抑。
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
該字段必需鳄炉,它的值是逗號分隔的一個字符串,表明服務器支持的所有跨域請求的方法搜骡。注意拂盯,返回的是所有支持的方法,而不單是瀏覽器請求的那個方法记靡。這是為了避免多次"預檢"請求谈竿。
(2)Access-Control-Allow-Headers
如果瀏覽器請求包括Access-Control-Request-Headers
字段,則Access-Control-Allow-Headers
字段是必需的摸吠。它也是一個逗號分隔的字符串空凸,表明服務器支持的所有頭信息字段,不限于瀏覽器在"預檢"中請求的字段寸痢。
(3)Access-Control-Allow-Credentials
該字段與簡單請求時的含義相同劫恒。
(4)Access-Control-Max-Age
該字段可選,用來指定本次預檢請求的有效期轿腺,單位為秒两嘴。上面結果中椿息,有效期是20天(1728000秒)嘱支,即允許緩存該條回應1728000秒(即20天)蒜焊,在此期間京痢,不用發(fā)出另一條預檢請求些椒。
2 瀏覽器的正常請求和回應
一旦服務器通過了"預檢"請求朱躺,以后每次瀏覽器正常的CORS請求怎抛,就都跟簡單請求一樣揍拆,會有一個Origin
頭信息字段拢操。服務器的回應锦亦,也都會有一個Access-Control-Allow-Origin
頭信息字段。
下面是"預檢"請求之后令境,瀏覽器的正常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
字段是瀏覽器自動添加的。
下面是服務器正常的回應舔庶。
Access-Control-Allow-Origin: http://api.bob.com Content-Type: text/html; charset=utf-8
上面頭信息中抛蚁,Access-Control-Allow-Origin
字段是每次回應都必定包含的陈醒。
五、與JSONP的比較
CORS與JSONP的使用目的相同瞧甩,但是比JSONP更強大钉跷。
JSONP只支持GET
請求,CORS支持所有類型的HTTP請求肚逸。JSONP的優(yōu)勢在于支持老式瀏覽器爷辙,以及可以向不支持CORS的網站請求數據。