CORS(跨域資源共享 Cross-origin resource sharing)是一個w3c標(biāo)準(zhǔn).
它允許瀏覽器向跨源服務(wù)器,發(fā)出XMLHttpRequest請求,從而克服了AJAX只能向同源使用的限制。
一、CORS介紹
CORS需要瀏覽器和服務(wù)器同時支持。目前,所有瀏覽器都支持該功能,IE瀏覽器不能低于IE10.
整個CORS通信過程,都是瀏覽器自動完成,不需要用戶的參與。瀏覽器一旦發(fā)現(xiàn)ajax請求跨源,會自動添加一些附加的header頭信息,有時還會多一些附加的請求,但用戶不會有感知。
因此,實(shí)現(xiàn)cors通信的關(guān)鍵是服務(wù)器。只要服務(wù)器實(shí)現(xiàn)了cors接口,就可以跨源通信。
二、2種請求
瀏覽器將cors請求分為2類:簡單請求(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
若不能滿足以上2點(diǎn),就屬于非簡單請求。
瀏覽器對這兩種請求的處理,是不一樣的。
三、簡單請求
1、簡單請求在header頭里增加一個Origin字段
GET /cors HTTP/1.1
Origin: http://api.xxx.com
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
Origin: 本次請求來源于哪里(協(xié)議+域名+端口)。服務(wù)器根據(jù)origin的值,決定是否同意這次的請求。
Origin指定了源,不在許可范圍內(nèi),服務(wù)器會返回一個正常的http響應(yīng)。瀏覽器發(fā)現(xiàn),header的頭信息沒有包含:Access-Control-Allow-Origin 就知道出錯了,會跑出一個錯誤,然后XMLHttpRequest的onerror回調(diào)函數(shù)捕獲。注意,這種錯誤情況無法通過狀態(tài)碼識別,因?yàn)閔ttp回應(yīng)的狀態(tài)碼有可能是200.
如果Origin指定的域名在許可范圍內(nèi),服務(wù)器返回的響應(yīng),會多出幾個頭信息字段。
Access-Control-Allow-Origin: http://api.xxx.com
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
上面的頭信息之中,有三個與CORS請求相關(guān)的字段,都以Access-Control-開頭。
Access-Control-Allow-Origin字段是必須的。它的值要么是請求時Origin字段的值,要么是一個*,表示接受任意域名的請求。
Access-Control-Allow-Credentials字段可選。它的值是一個布爾值,表示是否允許發(fā)送Cookie。默認(rèn)情況下,Cookie不包括在CORS請求之中。設(shè)為true,即表示服務(wù)器明確許可,Cookie可以包含在請求中,一起發(fā)給服務(wù)器。這個值也只能設(shè)為true,如果服務(wù)器不要瀏覽器發(fā)送Cookie,刪除該字段即可。
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字段的值。
2、withCredentials 屬性
上面說到,CORS請求默認(rèn)不發(fā)送Cookie和HTTP認(rèn)證信息。如果要把Cookie發(fā)到服務(wù)器,一方面要服務(wù)器同意,指定Access-Control-Allow-Credentials字段,并設(shè)置為true。
Access-Control-Allow-Credentials: true
另一方面,前端開發(fā)者必須在AJAX請求中打開withCredentials屬性。
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
否則,即使服務(wù)器同意發(fā)送Cookie,瀏覽器也不會發(fā)送?;蛘叻?wù)器要求設(shè)置Cookie,瀏覽器也不會處理。
但是,如果省略withCredentials設(shè)置,有的瀏覽器還是會一起發(fā)送Cookie。這時,可以顯式關(guān)閉withCredentials。
var xhr = new XMLHttpRequest();
xhr.withCredentials = false;
需要注意的是,如果要發(fā)送Cookie,Access-Control-Allow-Origin就不能設(shè)為星號,必須指定明確的、與請求網(wǎng)頁一致的域名。
同時,Cookie依然遵循同源政策,只有用服務(wù)器域名設(shè)置的Cookie才會上傳,其他域名的Cookie并不會上傳,且(跨源)原網(wǎng)頁代碼中的document.cookie也無法讀取服務(wù)器域名下的Cookie。
三、非簡單請求
1、非簡單請求是那種對服務(wù)器有特殊要求的請求,比如請求方法是PUT或DELETE,或者Content-Type字段的類型是application/json。
非簡單請求的CORS請求,會在正式通信之前,增加一次HTTP查詢請求,稱為"預(yù)檢"請求(preflight)。
瀏覽器先詢問服務(wù)器,當(dāng)前網(wǎng)頁所在的域名是否在服務(wù)器的許可名單之中,以及可以使用哪些HTTP動詞和頭信息字段。只有得到肯定答復(fù),瀏覽器才會發(fā)出正式的XMLHttpRequest請求,否則就報(bào)錯。
下面是一段瀏覽器的JavaScript腳本。
var url = 'http://api.xxx.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ā)出一個"預(yù)檢"請求,要求服務(wù)器確認(rèn)可以這樣請求。下面是這個"預(yù)檢"請求的HTTP頭信息。
OPTIONS /cors HTTP/1.1
Origin: http://api.xxx.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ù)檢"請求的頭信息包括兩個特殊字段。
Access-Control-Request-Method 字段是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法,上例是PUT。
Access-Control-Request-Headers 字段是一個逗號分隔的字符串,指定瀏覽器CORS請求會額外發(fā)送的頭信息字段,上例是X-Custom-Header。
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.xxx.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.xxx.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ù)捕獲??刂婆_會打印出如下的報(bào)錯信息。
XMLHttpRequest cannot load http://api.xxx.com.
Origin http://api.xxx.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
Access-Control-Allow-Methods 字段必需,它的值是逗號分隔的一個字符串,表明服務(wù)器支持的所有跨域請求的方法。注意,返回的是所有支持的方法,而不單是瀏覽器請求的那個方法。這是為了避免多次"預(yù)檢"請求。
Access-Control-Allow-Headers : 如果瀏覽器請求包括Access-Control-Request-Headers字段,則Access-Control-Allow-Headers字段是必需的。它也是一個逗號分隔的字符串,表明服務(wù)器支持的所有頭信息字段,不限于瀏覽器在"預(yù)檢"中請求的字段。
Access-Control-Allow-Credentials:該字段與簡單請求時的含義相同。
Access-Control-Max-Age 字段可選,用來指定本次預(yù)檢請求的有效期,單位為秒。上面結(jié)果中,有效期是20天(1728000秒),即允許緩存該條回應(yīng)1728000秒(即20天),在此期間,不用發(fā)出另一條預(yù)檢請求。
3、瀏覽器的正常請求和回應(yīng)
一旦服務(wù)器通過了"預(yù)檢"請求,以后每次瀏覽器正常的CORS請求,就都跟簡單請求一樣,會有一個Origin頭信息字段。服務(wù)器的回應(yīng),也都會有一個Access-Control-Allow-Origin頭信息字段。
下面是"預(yù)檢"請求之后,瀏覽器的正常CORS請求。
PUT /cors HTTP/1.1
Origin: http://api.xxx.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.xxx.com
Content-Type: text/html; charset=utf-8
上面頭信息中,Access-Control-Allow-Origin字段是每次回應(yīng)都必定包含的。
五、與JSONP的比較
CORS與JSONP的使用目的相同,但是比JSONP更強(qiáng)大。
JSONP只支持GET請求,CORS支持所有類型的HTTP請求。JSONP的優(yōu)勢在于支持老式瀏覽器,以及可以向不支持CORS的網(wǎng)站請求數(shù)據(jù)。