跨域資源共享CORS詳解

最近深入了解了CORS的相關東西，覺得阮一峰老師的文章寫得最詳細易懂了，所有轉載作為學習筆記。
原文地址：跨域資源共享 CORS 詳解

CORS是W3C的一個標準，全稱是跨域資源共享（Cross-origin resource sharing）
本文詳細介紹CORS的內部機制。

一、簡介

CORS需要瀏覽器和服務器同時支持。目前，所有瀏覽器都支持該功能，IE瀏覽器不能低于IE10。
整個CORS通信過程，都是瀏覽器自動完成，不需要用戶參與。對于開發者來說，CORS通信與AJAX通信沒有差別，代碼完全一樣。瀏覽器一旦發現AJAX請求跨域，就會自動添加一些附加的頭信息，有時還會多出一次附加的請求，但用戶不會有感覺。

因此，實現CORS通信的關鍵是服務器。只要服務器實現了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 基本流程

對于簡單請求，瀏覽器直接發出CORS請求。具體來說，就是在頭信息之中，增加一個Origin字段。

下面是一個例子，瀏覽器發現這次跨域請求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 字段用來說明，本次請求來自哪個源（協議+域名+端口號）。服務器根據這個值，決定是否同意這次請求。

如果Origin 指定的源，不在許可范圍之內，服務器返回一個正常的HTTP回應。瀏覽器發現這個回應的頭信息沒有包含Access-Control-Allow-Origin 字段（詳見下文），就知道出錯了，就會拋出一個錯誤，被XMLHttpRequest 的onerror 回調函數所捕獲。注意，這種錯誤是無法通過狀態碼識別，因為HTTP回應的狀態碼有可能是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
該字段是可選的。它的值是一個布爾值，表示是否允許發送Cookie。默認情況下，Cookie不包含在 CORS請求之中。設為true時，表示服務器明確許可，Cookie可以包含在請求中，一起發給服務器。這個值也只能設為true，如果服務器不要瀏覽器發送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請求默認不發送Cookie和HTTP認證信息。如果要把Cookie 發送到服務器，一方面需要服務器同意，指定Access-Control-Allow-Credentials 字段。

Access-Control-Allow-Credentials: true

另一方面，開發者必須在AJAX請求中打開withCredentials屬性。

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

否則，即使服務器同意發送Cookie，瀏覽器也不會發送。或者，服務器要求設置Cookie，瀏覽器也不會處理。
但是，如果省略withCredentials設置，有的瀏覽器還是會一起發送Cookie。這時，可以**顯式關閉**withCredentials。

xhr.withCredentials = false;

需要注意的是，如果要發送Cookie，Access-Control-Allow-Origin就不能設為星號，必須指定明確的、與請求網頁一致的域名。同時，Cookie依然遵循同源政策，只有用服務器域名設置的Cookie才會上傳，其他域名的Cookie并不會上傳，且（跨源）原網頁代碼中的document.cookie也無法讀取服務器域名下的Cookie。

四、非簡單請求

4.1 預檢請求

非簡單請求是那種對服務器有特殊要求的請求，比如請求方法是PUT或DELETE，或者Content-Type字段的類型是application/json。

非簡單請求的CORS請求，會在正式通信之前，增加一次HTTP查詢請求，稱為“預檢”請求（preflight）。

瀏覽器先詢問服務器，當前網頁所在的域名是否在服務器的許可名單之中，以及可以使用哪些HTTP動詞和信息字段。只有得到肯定的答復，瀏覽器才會發出正式的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，并且發送一個自定義頭信息X-Custom-Header。

瀏覽器發現，這是一個非簡單請求，就自動發出一個”預檢”請求，要求服務器確認可以這樣請求。下面是這個”預檢”請求的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請求會額外發送的頭信息字段。上例是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相關的頭信息字段。這時，瀏覽器就會認定，服務器不同意預檢請求，因此觸發一個錯誤，被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-Allow-Headers，則Access-Control-Allow-Headers 字段是必須的。它也是一個逗號分隔的字符串，表明服務器支持的所有頭信息的字段，不限于瀏覽器在”預檢”中請求的字段。

（3）Access-Control-Allow-Credentials
該請求與簡單請求時的含義一樣。

（4）Access-Control-Max-Age
該字段可選，用來指定本次預檢請求的有效期，單位為妙。上面結果中，有效期是20天（1728000秒），即允許緩存該條回應1728000秒（即20天），在此期間，不用發出另一條預檢請求。

4.3 瀏覽器的正常請求和回應

一旦服務器通過了預檢請求，以后每次瀏覽器正常的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的優勢在于支持老式瀏覽器，以及可以向不支持CORS的網站請求數據。