CORS 讓瀏覽器得以向跨來源的伺服器發出 XMLHttpRequest 請求,藉此突破 AJAX 只能同源的先天限制。以下詳細說明它的內部機制。

(圖片說明:攝於阿聯酋艾因(Al Ain)的綠洲公園)
CORS 需要瀏覽器與伺服器同時支援。目前所有主流瀏覽器都支援,IE 則需 10 以上版本。
整個 CORS 溝通過程由瀏覽器自動完成,不需要使用者參與。對開發者而言,CORS 請求與同源 AJAX 的程式碼寫法完全一樣;瀏覽器一旦發現請求跨源,就會自動補上額外的標頭,有時甚至會多送一次請求,但使用者不會察覺。因此,實作 CORS 的關鍵在伺服器端——只要伺服器實作了 CORS 介面,跨源溝通即可成立。
瀏覽器把 CORS 請求分成簡單請求(simple request)與非簡單請求(not-so-simple request)。
同時滿足以下兩個條件即屬於簡單請求:
(1)方法是 HEAD、GET、POST 三者之一;
(2)標頭不超出以下欄位:Accept、Accept-Language、Content-Language、Last-Event-ID,以及 Content-Type 但僅限 application/x-www-form-urlencoded、multipart/form-data、text/plain 三種值。
不同時滿足這兩點的,就是非簡單請求。瀏覽器對這兩者的處理方式截然不同。
3.1 基本流程
對於簡單請求,瀏覽器直接送出,只是在標頭中多補一個 Origin 欄位:
GET /cors HTTP/1.1
Origin: https://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 捕獲。請注意:這類錯誤無法靠狀態碼辨識,因為回應的狀態碼可能就是 200。
若 Origin 在許可範圍內,回應會多出幾個以 Access-Control- 開頭的欄位:
Access-Control-Allow-Origin: https://api.bob.com
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
(1)Access-Control-Allow-Origin:必填。值要麼是請求時 Origin 的值,要麼是 * 表示接受任意網域。
(2)Access-Control-Allow-Credentials:選填,布林值,表示是否允許帶 Cookie。預設情況下 CORS 請求不含 Cookie;設為 true 代表伺服器明確允許,且這個值只能是 true,若不希望帶 Cookie 就把該欄位移除。
(3)Access-Control-Expose-Headers:選填。CORS 請求時,getResponseHeader() 只能取到六個基本欄位:Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。若要取其他欄位,必須在此明確列出。
3.2 withCredentials 屬性
CORS 預設不送 Cookie 與 HTTP 認證資訊。要把 Cookie 送到伺服器,需要兩邊配合。伺服器端:
Access-Control-Allow-Credentials: true
開發者端則必須開啟 withCredentials:
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
否則即使伺服器允許,瀏覽器也不會送;反之,若伺服器要求設定 Cookie,瀏覽器同樣不會處理。也有瀏覽器在省略此設定時仍會送 Cookie,這時可以顯式關閉:
xhr.withCredentials = false;
要特別注意:一旦要送 Cookie,Access-Control-Allow-Origin 就不能設為星號,必須明確指定與請求網頁一致的網域。此外 Cookie 仍遵循同源政策——只有伺服器網域設定的 Cookie 才會上傳,其他網域的 Cookie 不會;而跨源時,原網頁的 document.cookie 也讀不到伺服器網域下的 Cookie。
4.1 預檢請求
非簡單請求是對伺服器有特殊要求的請求,例如方法是 PUT、DELETE,或 Content-Type 為 application/json。這類請求在正式溝通前,會先多送一次 HTTP 查詢請求,稱為「預檢」(preflight)。
瀏覽器先詢問伺服器:目前網頁所屬網域是否在許可名單中,以及可以使用哪些 HTTP 動詞與標頭欄位。只有得到肯定答覆,才會發出正式的 XMLHttpRequest,否則直接報錯。
var url = 'https://api.alice.com/cors';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();
上例方法是 PUT 且帶了自訂標頭 X-Custom-Header,瀏覽器判定為非簡單請求,於是自動先發出預檢:
OPTIONS /cors HTTP/1.1
Origin: https://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,還有兩個關鍵欄位:Access-Control-Request-Method(必填,列出即將使用的 HTTP 方法)與 Access-Control-Request-Headers(逗號分隔的字串,列出會額外送出的標頭)。
4.2 預檢的回應
伺服器檢查這三個欄位後,若允許跨源,即可回應:
HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:39 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: https://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-Length: 0
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
關鍵是 Access-Control-Allow-Origin,表示該網域可以請求資料;設為 * 則允許任意跨源請求。
若瀏覽器被否定,伺服器會回一個正常回應但不含任何 CORS 欄位,瀏覽器即認定預檢失敗並觸發錯誤,交由 onerror 處理,主控台會看到類似訊息:
XMLHttpRequest cannot load https://api.alice.com.
Origin https://api.bob.com is not allowed by Access-Control-Allow-Origin.
其餘相關欄位:
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,此欄位即為必填,內容同樣是逗號分隔字串,且不限於瀏覽器詢問的那些。
(3)Access-Control-Allow-Credentials:含義與簡單請求時相同。
(4)Access-Control-Max-Age:選填,指定本次預檢結果的有效期(秒)。上例為 1728000 秒(20 天),這段期間內不必再發預檢,能有效減少往返次數。
4.3 瀏覽器的正常請求與回應
一旦伺服器通過預檢,後續每次正常的 CORS 請求都與簡單請求無異,會帶 Origin,回應則必定帶 Access-Control-Allow-Origin。
PUT /cors HTTP/1.1
Origin: https://api.bob.com
Host: api.alice.com
X-Custom-Header: value
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
Access-Control-Allow-Origin: https://api.bob.com
Content-Type: text/html; charset=utf-8
兩者目的相同,但 CORS 更強大:JSONP 只支援 GET 請求,CORS 支援所有類型的 HTTP 請求。JSONP 的優勢在於能支援老舊瀏覽器,以及能向未實作 CORS 的網站取資料。