一、前言
跨域問題是我們經常遇到的問題,在涉及不同域名下應用訪問時,便出現了跨域問題。最近在做專案也遇到了許多跨域問題,跨域一般需要前後端配合,但是作為後端開發人員,前端的跨域方式真的搞不懂,所以就講講我們後端經常使用的跨域方式CORS吧。實現CORS的關鍵是在後臺設定實現介面。
二、簡介
1、什麼是跨域呢?
跨域:指的是瀏覽器當前回話訪問不同域名下的資源或者介面,根據同源規則,瀏覽器只能訪問當前回話相同域下的資源介面,其他域的介面是不能訪問的。如果需要訪問其他域下的資源,這便出現了跨域問題。
2、什麼是CORS呢?
CORS: 跨域資源共享,CORS指的是一種跨域的策略模式,常見的模式還有JSONP模式等,但是目前更多的是使用CORS模式,因為CORS更高階。JSONP模式只能跨域請求GET請求,其他請求方式不能通過JSONP模式跨域。JSONP模式還支援IE10以下版本,而CORS卻不支援,這也是JSONP模式仍然常用的原因。
三、兩種請求方式
瀏覽器將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簡單請求
3.1.1基本流程
對於簡單請求,瀏覽器直接發出CORS請求。具體來說,就是在頭資訊之中,增加一個Origin欄位。
下面是一個例子,瀏覽器發現這次跨源AJAX請求是簡單請求,就自動在頭資訊之中,新增一個Origin欄位。
3.1.1.1請求頭:
下面的頭資訊中,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...
複製程式碼
3.1.1.2響應頭:
·如何請求頭指定的源Origin不在伺服器白名單中(不允許跨域),則伺服器返回的http響應頭中不包含Access-Control-Allow-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
複製程式碼
上面返回的響應頭資訊需要在伺服器中設定,下面是返回情況
1)、Access-Control-Allow-Origin
該欄位是必須的。它的值要麼是請求時Origin欄位的值,要麼是一個*,表示接受任意域名的請求。
2)、Access-Control-Allow-Credentials
該欄位為可選,如果返回true,說明伺服器端執行前端攜帶跨域的cookie資訊到伺服器訪問,如果不需要攜帶cookie,不設定該欄位即可。
3)、Access-Control-Expose-Headers
該欄位為可選,XMLHttpRequest物件的getResponseHeader()方法只能拿到6個基本欄位:Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他欄位,就必須在Access-Control-Expose-Headers裡面指定。上面的例子指定,getResponseHeader('FooBar')可以返回FooBar欄位的值。
3.1.2withCredentials屬性
要想跨域傳遞cookie資訊,關鍵是在設定withCredentials屬性,這個需要前後端配合,只在一端設定話無法傳遞cookie資訊
1)、前端設定:
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
複製程式碼
2)、後端設定:
Access-Control-Allow-Credentials: true
複製程式碼
需要注意的是,如果要傳送Cookie,Access-Control-Allow-Origin就不能設為星號,必須指定明確的、與請求網頁一致的域名。同時,Cookie依然遵循同源政策,只有用伺服器域名設定的Cookie才會上傳,其他域名的Cookie並不會上傳,且(跨源)原網頁程式碼中的document.cookie也無法讀取伺服器域名下的Cookie。
3.2非簡單請求
3.2.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。
3.2.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可以請求資料。該欄位也可以設為星號,表示同意任意跨源請求。
如果瀏覽器否定了"預檢"請求,會返回一個正常的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天),在此期間,不用發出另一條預檢請求。
3.2.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...
複製程式碼
響應頭:下面頭資訊中,Access-Control-Allow-Origin欄位是每次迴應都必定包含的。
Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8
複製程式碼