由Request Method:OPTIONS初窺CORS
目前的工作中,HEAD、PUT、DELETE我是真的沒有見過……但是OPTIONS幾乎天天都會遇到。本地環境跑公司項目的時候,每次POST之前,為啥瀏覽器還偷偷給我來一次沒有返回的OPTIONS請求?
原來,瀏覽器在某些請求中,在正式通信前會增加一次HTTP查詢請求,稱為"預檢"請求(preflight)。
覽器先詢問伺服器,當前網頁所在的域名是否在伺服器的許可名單之中,以及可以使用哪些HTTP動詞和頭信息欄位。只有得到肯定答覆,瀏覽器才會發出正式的XMLHttpRequest請求,否則就報錯。
如上兩張圖片,圖2就是本地環境,本地環境請求介面的時候,每次請求介面之前都會多一次OPTIONS請求。
CORS
CORS是一個W3C標準,全稱是"跨域資源共享"(Cross-origin resource sharing)。
它允許瀏覽器向跨源伺服器,發出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制。
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
簡單請求
對於簡單請求,瀏覽器直接發出CORS請求。具體來說,就是在頭信息之中,增加一個Origin欄位。
Origin欄位用來說明,本次請求來自哪個源(協議 + 域名 + 埠)。伺服器根據這個值,決定是否同意這次請求。
如果Origin指定的源,不在許可範圍內,伺服器會返回一個正常的HTTP回應。瀏覽器發現,這個回應的頭信息沒有包含Access-Control-Allow-Origin欄位(詳見下文),就知道出錯了,從而拋出一個錯誤,被XMLHttpRequest的onerror回調函數捕獲。注意,這種錯誤無法通過狀態碼識別,因為HTTP回應的狀態碼有可能是200。
如果Origin指定的域名在許可範圍內,伺服器返回的響應,會多出幾個頭信息欄位。都以Access-Control- 開頭:
(1)Access-Control-Allow-Origin
該欄位是必須的。它的值要麼是請求時Origin欄位的值,要麼是一個*,表示接受任意域名的請求。
需要注意的是,如果要發送Cookie,Access-Control-Allow-Origin就不能設為星號,必須指定明確的、與請求網頁一致的域名。同時,Cookie依然遵循同源政策,只有用伺服器域名設置的Cookie才會上傳,其他域名的Cookie並不會上傳,且(跨源)原網頁代碼中的document.cookie也無法讀取伺服器域名下的Cookie。
(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裡面指定。
非簡單請求
非簡單請求是那種對伺服器有特殊要求的請求,比如請求方法是PUT或DELETE,或者Content-Type欄位的類型是application/json。
我工作中寫的所有頁面拉的介面都是非簡單請求。
非簡單請求的CORS請求,會在正式通信之前,增加一次HTTP查詢請求,稱為"預檢"請求(preflight)。
瀏覽器先詢問伺服器,當前網頁所在的域名是否在伺服器的許可名單之中,以及可以使用哪些HTTP動詞和頭信息欄位。只有得到肯定答覆,瀏覽器才會發出正式的XMLHttpRequest請求,否則就報錯。
在頁面域名與介面域名不一致的情況下,就出現了每次請求前先發送一個options請求的問題。
OPTIONS請求頭信息中,除了Origin欄位,還至少會多兩個特殊欄位:
(1)Access-Control-Request-Method
該欄位是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法。
(2)Access-Control-Request-Headers
該欄位是一個逗號分隔的字元串,指定瀏覽器CORS請求會額外發送的頭信息欄位。
至於其他亂七八糟的欄位,現在的我還用不到也不懂,將會慢慢深入了解。伺服器收到預檢請求後,檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers欄位以後,確認允許跨源請求,就可以做出回應。
上面的HTTP回應中,關鍵的是Access-Control-Allow-Origin欄位,表示http://lizard.qa.nt.ctripcorp.com可以請求數據。該欄位也可以設為星號,表示同意任意跨源請求。
如果瀏覽器否定了"預檢"請求,會返回一個正常的HTTP回應,但是沒有任何CORS相關的頭信息欄位。這時,瀏覽器就會認定,伺服器不同意預檢請求,因此觸發一個錯誤,被XMLHttpRequest對象的onerror回調函數捕獲。控制台會列印出如下的報錯信息。
XMLHttpRequest cannot load http://lizard.qa.nt.ctripcorp.com
Origin http://lizard.qa.nt.ctripcorp.com is not allowed by Access-Control-Allow-Origin.其他欄位中Access-Control-Max-Age 用來指定本次預檢請求的有效期,單位為秒。該欄位可選。
與JSONP的對比
CORS與JSONP的使用目的相同,但是比JSONP更強大。
JSONP只支持GET請求,JSONP的優勢在於支持老舊瀏覽器。
推薦閱讀:
※既然說 HTTP 是明文傳輸,為什麼沒聽說哪個著名的網站因為採用 http 協議而暴露了用戶的密碼?
※認識HTTP----Cookie和Session篇
※優雅地請求: fetch, node-fetch, isomorphic-fetch
※web性能優化之:no-cache與must-revalidate深入探究
※在前端性能優化中應用HTTP緩存的三部曲