跨域資源共享 CORS 詳解

跨域資源共享 CORS 詳解

1 簡介

CORS需要瀏覽器和服務(wù)器同時(shí)支持。目前，所有瀏覽器都支持該功能，IE瀏覽器不能低于IE10。

整個(gè)CORS通信過程，都是瀏覽器自動(dòng)完成，不需要用戶參與。對于開發(fā)者來說，CORS通信與同源的AJAX通信沒有差別，代碼完全一樣。瀏覽器一旦發(fā)現(xiàn)AJAX請求跨源，就會(huì)自動(dòng)添加一些附加的頭信息，有時(shí)還會(huì)多出一次附加的請求，但用戶不會(huì)有感覺。

因此，實(shí)現(xiàn)CORS通信的關(guān)鍵是服務(wù)器。只要服務(wù)器實(shí)現(xiàn)了CORS接口，就可以跨源通信。

2 兩種請求

瀏覽器將CORS請求分成兩類：簡單請求（simple request）和非簡單請求（not-so-simple request）。

  • simple request

只要同時(shí)滿足以下兩大條件，就屬于簡單請求。

  1. 請求方法是以下三種方法之一：HEAD、GET、POST
  2. HTTP的頭信息不超出以下幾種字段：Accept、Accept-Language、Content-Language、Last-Event-ID、Content-Type（只限于三個(gè)值application/x-www-form-urlencoded、multipart/form-data、text/plain）

凡是不同時(shí)滿足上面兩個(gè)條件，就屬于非簡單請求。

3 簡單請求

3.1 基本流程

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

下面是一個(gè)例子，瀏覽器發(fā)現(xiàn)這次跨源AJAX請求是簡單請求，就自動(dòng)在頭信息之中，添加一個(gè) 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 字段用來說明，本次請求來自哪個(gè)源（協(xié)議 + 域名 + 端口）。服務(wù)器根據(jù)這個(gè)值，決定是否同意這次請求。

如果 Origin 指定的源，不在許可范圍內(nèi)，服務(wù)器會(huì)返回一個(gè)正常的HTTP回應(yīng)。瀏覽器發(fā)現(xiàn)，這個(gè)回應(yīng)的頭信息沒有包含 Access-Control-Allow-Origin 字段（詳見下文），就知道出錯(cuò)了，從而拋出一個(gè)錯(cuò)誤，被 XMLHttpRequest 的 onerror 回調(diào)函數(shù)捕獲。注意，這種錯(cuò)誤無法通過狀態(tài)碼識(shí)別，因?yàn)镠TTP回應(yīng)的狀態(tài)碼有可能是200。

如果 Origin 指定的域名在許可范圍內(nèi)，服務(wù)器返回的響應(yīng)，會(huì)多出幾個(gè)頭信息字段。


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

上面的頭信息之中，有三個(gè)與CORS請求相關(guān)的字段，都以 Access-Control- 開頭。

  • Access-Control-Allow-Origin：該字段是必須的。它的值要么是請求時(shí) Origin 字段的值，要么是一個(gè)*，表示接受任意域名的請求。
  • Access-Control-Allow-Credentials：該字段可選。它的值是一個(gè)布爾值，表示是否允許發(fā)送Cookie。默認(rèn)情況下，Cookie不包括在CORS請求之中。設(shè)為true，即表示服務(wù)器明確許可，Cookie可以包含在請求中，一起發(fā)給服務(wù)器。這個(gè)值也只能設(shè)為true，如果服務(wù)器不要瀏覽器發(fā)送Cookie，刪除該字段即可。
  • Access-Control-Expose-Headers：該字段可選。CORS請求時(shí)，XMLHttpRequest對象的getResponseHeader()方法只能拿到6個(gè)基本字段：Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他字段，就必須在Access-Control-Expose-Headers里面指定。上面的例子指定，getResponseHeader('FooBar')可以返回FooBar字段的值。

3.2 withCredentials 屬性

上面說到，CORS請求默認(rèn)不發(fā)送Cookie和HTTP認(rèn)證信息。如果要把Cookie發(fā)到服務(wù)器，一方面要服務(wù)器同意，指定 Access-Control-Allow-Credentials 字段。


Access-Control-Allow-Credentials: true

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

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

否則，即使服務(wù)器同意發(fā)送Cookie，瀏覽器也不會(huì)發(fā)送?；蛘?，服務(wù)器要求設(shè)置Cookie，瀏覽器也不會(huì)處理。
但是，如果省略 withCredentials 設(shè)置，有的瀏覽器還是會(huì)一起發(fā)送Cookie。這時(shí)，可以顯式關(guān)閉 withCredentials。

xhr.withCredentials = false;

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

4 非簡單請求

4.1 預(yù)檢請求

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

非簡單請求的CORS請求，會(huì)在正式通信之前，增加一次HTTP查詢請求，稱為"預(yù)檢"請求（preflight）。

瀏覽器先詢問服務(wù)器，當(dāng)前網(wǎng)頁所在的域名是否在服務(wù)器的許可名單之中，以及可以使用哪些HTTP動(dòng)詞和頭信息字段。只有得到肯定答復(fù)，瀏覽器才會(huì)發(fā)出正式的 XMLHttpRequest 請求，否則就報(bào)錯(cuò)。

下面是一段瀏覽器的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 ，并且發(fā)送一個(gè)自定義頭信息 X-Custom-Header。

瀏覽器發(fā)現(xiàn)，這是一個(gè)非簡單請求，就自動(dòng)發(fā)出一個(gè)"預(yù)檢"請求，要求服務(wù)器確認(rèn)可以這樣請求。下面是這個(gè)"預(yù)檢"請求的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...

"預(yù)檢"請求用的請求方法是 OPTIONS，表示這個(gè)請求是用來詢問的。頭信息里面，關(guān)鍵字段是 Origin，表示請求來自哪個(gè)源。
除了Origin字段，"預(yù)檢"請求的頭信息包括兩個(gè)特殊字段。

  • Access-Control-Request-Method：該字段是必須的，用來列出瀏覽器的CORS請求會(huì)用到哪些HTTP方法，上例是 PUT。
  • Access-Control-Request-Headers：該字段是一個(gè)逗號分隔的字符串，指定瀏覽器CORS請求會(huì)額外發(fā)送的頭信息字段，上例是 X-Custom-Header。

4.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.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回應(yīng)中，關(guān)鍵的是 Access-Control-Allow-Origin 字段，表示http://api.bob.com可以請求數(shù)據(jù)。該字段也可以設(shè)為星號，表示同意任意跨源請求。

Access-Control-Allow-Origin: *

如果瀏覽器否定了"預(yù)檢"請求，會(huì)返回一個(gè)正常的HTTP回應(yīng)，但是沒有任何CORS相關(guān)的頭信息字段。這時(shí)，瀏覽器就會(huì)認(rèn)定，服務(wù)器不同意預(yù)檢請求，因此觸發(fā)一個(gè)錯(cuò)誤，被XMLHttpRequest對象的onerror回調(diào)函數(shù)捕獲?？刂婆_(tái)會(huì)打印出如下的報(bào)錯(cuò)信息。

XMLHttpRequest cannot load http://api.alice.com.
Origin http://api.bob.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：該字段必需，它的值是逗號分隔的一個(gè)字符串，表明服務(wù)器支持的所有跨域請求的方法。注意，返回的是所有支持的方法，而不單是瀏覽器請求的那個(gè)方法。這是為了避免多次"預(yù)檢"請求。
  • Access-Control-Allow-Headers：如果瀏覽器請求包括Access-Control-Request-Headers字段，則Access-Control-Allow-Headers字段是必需的。它也是一個(gè)逗號分隔的字符串，表明服務(wù)器支持的所有頭信息字段，不限于瀏覽器在"預(yù)檢"中請求的字段。
  • Access-Control-Allow-Credentials：該字段與簡單請求時(shí)的含義相同。
  • Access-Control-Max-Age：該字段可選，用來指定本次預(yù)檢請求的有效期，單位為秒。上面結(jié)果中，有效期是20天（1728000秒），即允許緩存該條回應(yīng)1728000秒（即20天），在此期間，不用發(fā)出另一條預(yù)檢請求。

4.3 瀏覽器的正常請求和回應(yīng)

一旦服務(wù)器通過了"預(yù)檢"請求，以后每次瀏覽器正常的CORS請求，就都跟簡單請求一樣，會(huì)有一個(gè) Origin 頭信息字段。服務(wù)器的回應(yīng)，也都會(huì)有一個(gè) Access-Control-Allow-Origin 頭信息字段。

下面是"預(yù)檢"請求之后，瀏覽器的正常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 字段是瀏覽器自動(dòng)添加的。

下面是服務(wù)器正常的回應(yīng)。

Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8

上面頭信息中，Access-Control-Allow-Origin 字段是每次回應(yīng)都必定包含的。

5 與JSONP的比較

CORS與JSONP的使用目的相同，但是比JSONP更強(qiáng)大。
JSONP只支持 GET 請求，CORS支持所有類型的HTTP請求。JSONP的優(yōu)勢在于支持老式瀏覽器，以及可以向不支持CORS的網(wǎng)站請求數(shù)據(jù)。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • CORS是一個(gè)W3C標(biāo)準(zhǔn)，全稱是"跨域資源共享"（Cross-origin resource sharing）。 ...
    起名字太累閱讀 1,011評論 0贊 2
  • CORS是一個(gè)W3C標(biāo)準(zhǔn)，全稱是"跨域資源共享"（Cross-origin resource sharing）。 ...
    myccy8閱讀 463評論 0贊 2
  • 轉(zhuǎn)載于阮一峰老師的跨域資源共享 CORS 詳解 CORS是一個(gè)W3C標(biāo)準(zhǔn)，全稱是"跨域資源共享"（Cross-or...
    俊_杰閱讀 522評論 0贊 3
  • CORS是一個(gè)W3C標(biāo)準(zhǔn)，全稱是"跨域資源共享"（Cross-origin resource sharing）。 ...
    奇特思維家閱讀 1,176評論 0贊 3
  • 費(fèi)孝通先生有四句話：“各美其美，美人之美，美美與共，天下大同”。我一直很喜歡。近日我又頻頻想起這16個(gè)字。費(fèi)老是是...
    悠游涵泳閱讀 746評論 0贊 0

友情鏈接更多精彩內(nèi)容