跨域資源共享 CORS 詳解

解決方法來源 阮一峰的網路日志 http://www.ruanyifeng.com/blog/2016/04/cors.html

解決方法來源二  Vuejs之axios獲取Http回應頭 https://segmentfault.com/a/1190000009125333?utm_source=tag-newest

今天遇到了自定義請求頭的發送和接收回應，遇到了問題，花費了一些時間解決了，又去查了一些資料去看，沒想到之前阮一峰寫的內容里面有，但是沒有仔細查看，把他的拿過了記錄一下，

前端請求用的 axios

我的第一個問題：

為什么這個報錯了，是因為我的請求頭中的自定義內容沒有在后臺服務的回應串列里面，

第二個問題，ajax請求回應中如何拿到后臺自定義的內容，

　第一步加上這個自定義的欄位

第二步回應內容

請求與回應

查看結果

阮一峰的網路日志

CORS是一個W3C標準，全稱是"跨域資源共享"（Cross-origin resource sharing），

它允許瀏覽器向跨源服務器，發出XMLHttpRequest請求，從而克服了AJAX只能同源使用的限制，

本文詳細介紹CORS的內部機制，

（圖片說明：攝于阿聯酋艾因（Al Ain）的綠洲公園）

一、簡介

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

標籤：JavaScript

上一篇：javascript應該嵌入到html中的什么位置

下一篇：leetcode求峰值，js實作