# CORS 通信 CORS 是一個 W3C 標準，全稱是“跨域資源共享”（Cross-origin resource sharing）。它允許瀏覽器向跨域的服務器，發出`XMLHttpRequest`請求，從而克服了 AJAX 只能同源使用的限制。 ## 簡介 CORS 需要瀏覽器和服務器同時支持。目前，所有瀏覽器都支持該功能。 整個 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` 凡是不同時滿足上面兩個條件，就屬于非簡單請求。一句話，簡單請求就是簡單的 HTTP 方法與簡單的 HTTP 頭信息的結合。 這樣劃分的原因是，表單在歷史上一直可以跨域發出請求。簡單請求就是表單請求，瀏覽器沿襲了傳統的處理方式，不把行為復雜化，否則開發者可能轉而使用表單，規避 CORS 的限制。對于非簡單請求，瀏覽器會采用新的處理方式。 ## 簡單請求 ### 基本流程 對于簡單請求，瀏覽器直接發出 CORS 請求。具體來說，就是在頭信息之中，增加一個`Origin`字段。 下面是一個例子，瀏覽器發現這次跨域 AJAX 請求是簡單請求，就自動在頭信息之中，添加一個`Origin`字段。 ```http 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`指定的域名在許可范圍內，服務器返回的響應，會多出幾個頭信息字段。 ```http 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`字段的值。 ### withCredentials 屬性 上面說到，CORS 請求默認不包含 Cookie 信息（以及 HTTP 認證信息等），這是為了降低 CSRF 攻擊的風險。但是某些場合，服務器可能需要拿到 Cookie，這時需要服務器顯式指定`Access-Control-Allow-Credentials`字段，告訴瀏覽器可以發送 Cookie。 ```http Access-Control-Allow-Credentials: true ``` 同時，開發者必須在 AJAX 請求中打開`withCredentials`屬性。 ```javascript var xhr = new XMLHttpRequest(); xhr.withCredentials = true; ``` 否則，即使服務器要求發送 Cookie，瀏覽器也不會發送。或者，服務器要求設置 Cookie，瀏覽器也不會處理。 但是，有的瀏覽器默認將`withCredentials`屬性設為`true`。這導致如果省略`withCredentials`設置，這些瀏覽器可能還是會一起發送 Cookie。這時，可以顯式關閉`withCredentials`。 ```javascript xhr.withCredentials = false; ``` 需要注意的是，如果服務器要求瀏覽器發送 Cookie，`Access-Control-Allow-Origin`就不能設為星號，必須指定明確的、與請求網頁一致的域名。同時，Cookie 依然遵循同源政策，只有用服務器域名設置的 Cookie 才會上傳，其他域名的 Cookie 并不會上傳，且（跨域）原網頁代碼中的`document.cookie`也無法讀取服務器域名下的 Cookie。 ## 非簡單請求 ### 預檢請求 非簡單請求是那種對服務器提出特殊要求的請求，比如請求方法是`PUT`或`DELETE`，或者`Content-Type`字段的類型是`application/json`。 非簡單請求的 CORS 請求，會在正式通信之前，增加一次 HTTP 查詢請求，稱為“預檢”請求（preflight）。瀏覽器先詢問服務器，當前網頁所在的域名是否在服務器的許可名單之中，以及可以使用哪些 HTTP 方法和頭信息字段。只有得到肯定答復，瀏覽器才會發出正式的`XMLHttpRequest`請求，否則就報錯。這是為了防止這些新增的請求，對傳統的沒有 CORS 支持的服務器形成壓力，給服務器一個提前拒絕的機會，這樣可以防止服務器收到大量`DELETE`和`PUT`請求，這些傳統的表單不可能跨域發出的請求。 下面是一段瀏覽器的 JavaScript 腳本。 ```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 頭信息。 ```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`。 ### 預檢請求的回應 服務器收到“預檢”請求以后，檢查了`Origin`、`Access-Control-Request-Method`和`Access-Control-Request-Headers`字段以后，確認允許跨源請求，就可以做出回應。 ```http 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`可以請求數據。該字段也可以設為星號，表示同意任意跨源請求。 ```http Access-Control-Allow-Origin: * ``` 如果服務器否定了“預檢”請求，會返回一個正常的 HTTP 回應，但是沒有任何 CORS 相關的頭信息字段，或者明確表示請求不符合條件。 ```http OPTIONS http://api.bob.com HTTP/1.1 Status: 200 Access-Control-Allow-Origin: https://notyourdomain.com Access-Control-Allow-Method: POST ``` 上面的服務器回應，`Access-Control-Allow-Origin`字段明確不包括發出請求的`http://api.bob.com`。 這時，瀏覽器就會認定，服務器不同意預檢請求，因此觸發一個錯誤，被`XMLHttpRequest`對象的`onerror`回調函數捕獲。控制臺會打印出如下的報錯信息。 ```bash XMLHttpRequest cannot load http://api.alice.com. Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin. ``` 服務器回應的其他 CORS 相關字段如下。 ```http 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天），在此期間，不用發出另一條預檢請求。 ### 瀏覽器的正常請求和回應 一旦服務器通過了“預檢”請求，以后每次瀏覽器正常的 CORS 請求，就都跟簡單請求一樣，會有一個`Origin`頭信息字段。服務器的回應，也都會有一個`Access-Control-Allow-Origin`頭信息字段。 下面是“預檢”請求之后，瀏覽器的正常 CORS 請求。 ```http 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`字段是瀏覽器自動添加的。 下面是服務器正常的回應。 ```http 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 的網站請求數據。 ## 參考鏈接 - [Using CORS](http://www.html5rocks.com/en/tutorials/cors/), Monsur Hossain - [HTTP access control (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS), MDN - [CORS](https://frontendian.co/cors), Ryan Miller - [Do You Really Know CORS?](http://performantcode.com/web/do-you-really-know-cors), Grzegorz Mirek