You are on page 1of 10

一、簡介

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-Request-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 的網站請求資料。

(完)
Reference

https://developer.mozilla.org/zh-TW/docs/Web/HTTP/CORS

You might also like