BS架構模式的項目中,跨域是非常常見的。因為瀏覽器端要訪問的資源不一定總在同一域下,那麼如何解決跨域是每個前端小夥伴必備的技能。
基本上有三種主流的解決方案
使用JSONP的方式使用反向代理使用跨域資源共享什麼是跨域
首先,瀏覽器中有很多中方式從伺服器去加載資源。比如:
a標籤的href屬性可以從伺服器去加載hmtl文件img標籤的src屬性可以從伺服器去加載圖片文件link的href屬性可以從伺服器去加載css文件script的src屬性可以從伺服器去加載js文件form表單可以和伺服器進行交互,既能加載數據也可以提交數據ajax技術可以更加靈活的和伺服器進行交互,可加載數據也可以提交數據,且是異步的,不會讓整個頁面重新加載fetch一個新的異步刷新的api採用promise風格的接口....在瀏覽器地址欄輸入url地址,也可以加載資源....正常情況下,一次正常的訪問都是從瀏覽器中輸入url地址開始的,那麼第一次一般情況下加載的都是一個html文件也就是我們所說的頁面,那麼這個html文件所來自的域我們可以成為主域,在html文件被加載的過程中又會發起很多次的請求(參考上述發起請求的方式),而且html中一般會嵌入js,在js中又會有ajax和fetch的這些代碼,他們又會在特定的情況下發起請求。那麼這些請求的目標伺服器所在的域可能和主域並不是同一域,那麼如果和主域不是同一個域則發生了跨域請求。
域指的是一個請求地址的 協議,域名,埠這三部分,判斷兩個域是否相同,那就看域中的這三部分是否都一致。
跨域並不一定是問題
比如我們寫了個頁面,可以在 http://localhost:3000下訪問,頁面內容如下:
<!DOCTYPE HTML><html><head><meta charset="utf-8" /><title>我的第一個頁面</title></head><body><a href="https://www.baidu.com">百度</a></body></html>複製代碼經驗告訴我們上述代碼點擊連結後會跳轉到百度首頁,其實可以理解為跨域去請求了百度的首頁文件。然後我們沒有做任何的特殊處理卻成功了。
這就說明,並不是所有的跨域都會有問題,只有ajax和fetch產生的跨域才會被瀏覽器限制
跨域限制的報錯如下
那麼我們處理跨域的方案也是針對這兩種請求方式而設計的。
JSONP
JSONP是一種比較古老的解決方案,這種方案首先沒有兼容性問題,基本都可以使用,但是它所解決的問題比較有限,且對服務端接口有一定的要求。
原理:JSONP本質上使用的是script標籤的src屬性,前邊提到過該標籤有跨域請求資源的能力,且請求的資源類型是js腳本。也就是說,我們需要在伺服器給返回一段js腳本,並且把要返回給前端的數據加入到這段js腳本中。在瀏覽器端執行這段腳本,從而達到獲取數據的目的。
JSONP我們看到了本質並不是使用了ajax和fetch的請求方式,因此這種方式也只能解決get方式的請求。
代碼如下:
服務端代碼(nodejs)
const express = require('express')const app = express();cosnt data = [{id: 1}] // 要發送的數據app.get('/getData', (req, res) => {// 前端需要給服務端傳遞一個函數名const callbackName = req.query.callbackName;let jstxt = `${callbackName}(${JSON.stringify(data)})`;// 在服務端拼成的腳本為該函數的執行,並被傳入了數據。 res.set('Content-Type', 'application/javascript'); res.send(jstxt);})app.listen(3000, () => console.log('::3000'));複製代碼瀏覽器端代碼
functiondealData(data){// 該函數就是對服務端返回的數據進行處理的// ....}// 創建script標籤,並設置其src的地址為請求目標。請求的js腳本就會執行。let scp = document.createElement('script');scp.src = 'http://localhost:3000/getData?callbackName=dealData'; document.body.appendChild(scp);複製代碼反向代理
這種方式目前使用相當普遍,就是在目標伺服器和瀏覽器中間架一層伺服器,我們稱該伺服器為代理伺服器。方向代理的方式就是把靜態的資源文件部署在代理伺服器上,那麼我們請求的時候,輸入的是代理伺服器的域,在靜態的html的文件被加載後,要發起的ajax請求本來應該是直接發到目標伺服器的,但是這樣一來就會跨域,從而被限制,那麼我們修改一下策略,讓ajax的請求直接請求到代理伺服器,然後代理伺服器轉發該請求到目標伺服器去拿到資源。這樣一來,對於瀏覽器端而言,並沒有發生跨域。所以關鍵是需要在代理伺服器上部署轉發請求的邏輯。
伺服器和伺服器的通信是沒有跨域限制的。
一般來說,我們可以使用nginx作為代理伺服器,當然也可以使用nodejs作為代理伺服器。
具體交互流程如下
可以看到和瀏覽器的交互始終都是代理伺服器,那麼對於瀏覽器來說也就不存在跨域了。
跨域資源共享(CORS)
這是一種新的解決跨域的方式,主要是通過設置特殊的響應頭,來達到解除跨域限制的目的。跨域資源共享簡稱CORS,需要瀏覽器和伺服器同時支持,目前所有的瀏覽器都支持,ie必須不能低於ie10。它有以下幾個特點
CORS通信過程是由瀏覽器自己完成的,不需要用戶參與。對於開發者來說CORS通信和同源的ajax通信是一樣的,代碼也完全一致。在使用CORS通信的過程中,一旦發起了ajax跨域請求,會自動添加一些附加的頭信息,有時候還會多附加一次請求,用戶不會感知到實現CORS的關鍵在於伺服器,只要伺服器實現了,就可以進行CORS通信。簡單請求和非簡單請求
瀏覽器將CORS請求分成兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)。
那麼,如何區分簡單請求和非簡單請求呢?
只要同時滿足以下兩點,就是簡單請求:
請求方法是以下三種之一HEADGETPOSTHTTP的頭信息不超出以下幾種欄位AcceptAccept-LanguageContent-LanguageLast-Event-IDContent-Type 只限於三個值application/x-www-form-urlencoded、multipart/form-data、text/plain凡是不能同時滿足以上兩種條件的就是非簡單請求
那麼瀏覽器對於這兩種請求的處理是不一樣的。
簡單請求
對於簡單請求,瀏覽器直接發出CORS請求。具體來說,就是在頭信息之中,增加一個Origin欄位。
下面是一個例子,瀏覽器發現這次跨源AJAX請求是簡單請求,就自動在頭信息之中,添加一個Origin欄位。
GET /cors HTTP/1.1Origin: http://api.bob.comHost: api.alice.comAccept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5.0...複製代碼上面的頭信息中,Origin欄位用來說明,本次請求來自哪個源(協議 + 域名 + 埠)。伺服器根據這個值,決定是否同意這次請求。
如果Origin指定的源,不在許可範圍內,伺服器會返回一個正常的HTTP回應。瀏覽器發現,這個回應的頭信息沒有包含Access-Control-Allow-Origin欄位,就知道出錯了,從而拋出一個錯誤,被XMLHttpRequest的onerror回調函數捕獲。注意,這種錯誤無法通過狀態碼識別,因為HTTP回應的狀態碼有可能是200。
如果Origin指定的域名在許可範圍內,伺服器返回的響應,會多出幾個頭信息欄位。
Access-Control-Allow-Origin: http://api.bob.comAccess-Control-Allow-Credentials: trueAccess-Control-Expose-Headers: FooBarContent-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欄位的值。
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。
非簡單請求
非簡單請求是那種對伺服器有特殊要求的請求,比如請求方法是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.1Origin: http://api.bob.comAccess-Control-Request-Method: PUTAccess-Control-Request-Headers: X-Custom-HeaderHost: api.alice.comAccept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5.0...複製代碼"預檢"請求用的請求方法是OPTIONS,表示這個請求是用來詢問的。頭信息裡面,關鍵欄位是Origin,表示請求來自哪個源。
除了Origin欄位,"預檢"請求的頭信息包括兩個特殊欄位。
(1)Access-Control-Request-Method
該欄位是必須的,用來列出瀏覽器的CORS請求會用到哪些HTTP方法,上例是PUT。
(2)Access-Control-Request-Headers
該欄位是一個逗號分隔的字符串,指定瀏覽器CORS請求會額外發送的頭信息欄位,上例是X-Custom-Header。
預檢請求的響應
伺服器收到"預檢"請求以後,檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers欄位以後,確認允許跨源請求,就可以做出回應。
HTTP/1.1200 OKDate: Mon, 01 Dec 200801:15:39 GMTServer: Apache/2.0.61 (Unix)Access-Control-Allow-Origin: http://api.bob.comAccess-Control-Allow-Methods: GET, POST, PUTAccess-Control-Allow-Headers: X-Custom-HeaderContent-Type: text/html; charset=utf-8Content-Encoding: gzipContent-Length: 0Keep-Alive: timeout=2, max=100Connection: Keep-AliveContent-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, PUTAccess-Control-Allow-Headers: X-Custom-HeaderAccess-Control-Allow-Credentials: trueAccess-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天),在此期間,不用發出另一條預檢請求
瀏覽器正常的請求和回應
一旦伺服器通過了"預檢"請求,以後每次瀏覽器正常的CORS請求,就都跟簡單請求一樣,會有一個Origin頭信息欄位。伺服器的回應,也都會有一個Access-Control-Allow-Origin頭信息欄位。
下面是"預檢"請求之後,瀏覽器的正常CORS請求。
PUT /cors HTTP/1.1Origin: http://api.bob.comHost: api.alice.comX-Custom-Header: valueAccept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5.0...複製代碼上面頭信息的Origin欄位是瀏覽器自動添加的。
下面是伺服器正常的回應。
Access-Control-Allow-Origin: http://api.bob.comContent-Type: text/html; charset=utf-8複製代碼上面頭信息中,Access-Control-Allow-Origin欄位是每次回應都必定包含的。