如何透過 Nginx 解決跨域問題

一、簡介

CORS(Cross-Origin Resources sharding)

CORS是一個W3C標準,全稱是“跨域資源共享”(Cross-origin resource sharing)。 它允許瀏覽器向跨源伺服器,發出XMLHttpRequest請求,從而克服了AJAX只能同源使用的限制。 本文詳細介紹CORS的內部機制。

CORS需要瀏覽器和伺服器同時支援。目前,所有瀏覽器都支援該功能,IE瀏覽器不能低於IE10。 整個CORS通訊過程,都是瀏覽器自動完成,不需要使用者參與。對於開發者來說,CORS通訊與同源的AJAX通訊沒有差別,程式碼完全一樣。瀏覽器一旦發現AJAX請求跨源,就會自動新增一些附加的頭資訊,有時還會多出一次附加的請求,但使用者不會有感覺。 因此,實現CORS通訊的關鍵是伺服器。只要伺服器實現了CORS介面,就可以跨源通訊。

二、跨域請求型別

瀏覽器將CORS請求分成兩類:簡單請求(simple request)和非簡單請求(not-so-simple request)。 只要同時滿足以下兩大條件,就屬於簡單請求。

(1) 請求方法是以下三種方法之一:

HEADGETPOST

(2)HTTP的頭資訊不超出以下幾種欄位:

AcceptAccept-LanguageContent-LanguageLast-Event-ID

Content-Type:只限於三個值application/x-www-form-urlencoded、multipart/form-data、text/plain 凡是不同時滿足上面兩個條件,就屬於非簡單請求。 瀏覽器對這兩種請求的處理,是不一樣的。

三、簡單請求

3。1 基本流程

對於簡單請求,瀏覽器直接發出CORS請求。具體來說,就是在頭資訊之中,增加一個Origin欄位。 下面是一個例子,瀏覽器發現這次跨源AJAX請求是簡單請求,就自動在頭資訊之中,新增一個Origin欄位。

GET /cors HTTP/1。1Origin: ‘https://www。guance。com’Host: ‘www。jiagouyun。com’Accept-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: ‘https://www。guance。com’Access-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欄位的值。

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://www。jiagouyun。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: https://www。guance。comAccess-Control-Request-Method: PUTAccess-Control-Request-Headers: X-Custom-HeaderHost: www。jiagouyun。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。

4。2 預檢請求的迴應

伺服器收到“預檢”請求以後,檢查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers欄位以後,確認允許跨源請求,就可以做出迴應。

HTTP/1。1 200 OKDate: Mon, 01 Dec 2008 01:15:39 GMTServer: Apache/2。0。61 (Unix)Access-Control-Allow-Origin: ‘https://www。guance。com’Access-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欄位,

表示 https://www.guance.com 可以請求資料

。該欄位也可以設為萬用字元 ‘ * ’,表示同意任意跨源請求。

Access-Control-Allow-Origin: *

如果瀏覽器否定了“預檢”請求,會返回一個正常的HTTP迴應,但是沒有任何CORS相關的頭資訊欄位。這時,瀏覽器就會認定,伺服器不同意預檢請求,因此觸發一個錯誤,被XMLHttpRequest物件的onerror回撥函式捕獲。控制檯會打印出如下的報錯資訊。

XMLHttpRequest cannot load “http://www。jiagouyun。com”Origin “https://www。guance。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天),在此期間,不用發出另一條預檢請求。

4。3 瀏覽器的正常請求和迴應

一旦伺服器通過了“預檢”請求,以後每次瀏覽器正常的CORS請求,就都跟簡單請求一樣,會有一個Origin頭資訊欄位。伺服器的迴應,也都會有一個Access-Control-Allow-Origin頭資訊欄位。 下面是“預檢”請求之後,瀏覽器的正常CORS請求。

PUT /cors HTTP/1。1Origin: ‘https://www。guance。com’Host: ‘www。jiagouyun。com’X-Custom-Header: valueAccept-Language: en-USConnection: keep-aliveUser-Agent: Mozilla/5。0

上面頭資訊的Origin欄位是瀏覽器自動新增的。 下面是伺服器正常的迴應。

Access-Control-Allow-Origin: ‘https://www。guance。com’Content-Type: text/html; charset=utf-8

上面頭資訊中,Access-Control-Allow-Origin欄位是每次迴應都必定包含的。

五、與JSONP的比較

5。1 CORS與JSONP的使用目的相同,但是比JSONP更強大。

JSONP只支援GET請求,CORS支援所有型別的HTTP請求。JSONP的優勢在於支援老式瀏覽器,以及可以向不支援CORS的網站請求資料。

注:有的瀏覽器不允許https跨站訪問http網站。

六、常見跨域配置示例

6。1 單域名跨域請求

server {listen 80;server_name *。51fugj。com;add_header Access-Control-Allow-Origin ‘https://docs。guance。com’;add_header Access-Control-Allow-Headers Origin,Accept,Authorization,platformId,ut,DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type;add_header Access-Control-Allow-Methods GET,POST,OPTIONS;add_header Access-Control-Allow-Credentials true;location ^~/ {index index。html;proxy_pass http://frontier。egeo。com/appUnion/;proxy_set_header Host $host;proxy_set_header X-Real-IP $remote_addr;proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;break;}

6。2 多域名跨域請求

map $http_origin $corsHost { default 0; “~http://boss。guance。com” http://boss。guance。com; “~http://auth。guance。com” http://auth。guance。com;}server { listen 80; server_name www。jiagouyun。com; location / { if ($request_method = ‘OPTIONS’) { return 204; } root /usr/share/nginx/html; index index。html index。htm; add_header ‘Access-Control-Allow-Origin’ $corsHost; add_header ‘Access-Control-Max-Age’ 86400; add_header ‘Access-Control-Allow-Credentials’ ‘true’; add_header ‘Access-Control-Allow-Headers’ ‘Authorization,Content-Type,Accept,Origin,User-Agent,DNT,Cache-Control,X-Mx-ReqToken,X-Requested-With’; add_header ‘Access-Control-Allow-Methods’ ‘GET,POST,OPTIONS’; }}

server { listen 80; server_name www。jiagouyun。com; location / { root /usr/share/nginx/html; index index。html index。htm; set $cors ‘’; if ($http_origin ~* ‘https?://(localhost|boss\。guance。com\。com|auth\。guance\。com)’) { set $cors ‘true’; } if ($cors = ‘true’) { add_header ‘Access-Control-Allow-Origin’ “$http_origin”; add_header ‘Access-Control-Allow-Credentials’ ‘true’; add_header ‘Access-Control-Allow-Methods’ ‘GET,POST,OPTIONS’; add_header ‘Access-Control-Allow-Headers’ ‘Accept,Authorization,Cache-Control,Content-Type,DNT,If-Modified-Since,Keep-Alive,Origin,User-Agent,X-Mx-ReqToken,X-Requested-With’; } if ($request_method = ‘OPTIONS’) { return 204; } }}

server { listen 80; server_name www。jiagouyun。com; location / { root /usr/share/nginx/html; index index。html index。htm; if ( $http_origin ~ http://(。*)。guance。com){ set $allow_url $http_origin; } #CORS(Cross Orign Resource-Sharing)跨域控制配置 #是否允許請求帶有驗證資訊 add_header ‘Access-Control-Allow-Credentials’ ‘true’; #允許跨域訪問的域名,可以是一個域的列表,也可以是萬用字元* add_header ‘Access-Control-Allow-Origin’ “$allow_url”; #允許指令碼訪問的返回頭 add_header ‘Access-Control-Allow-Headers’ ‘x-requested-with,content-type,Cache-Control,Pragma,Date,x-timestamp’; #允許使用的請求方法,以逗號隔開 add_header ‘Access-Control-Allow-Methods’ ‘POST,GET,OPTIONS,PUT,DELETE’; #允許自定義的頭部,以逗號隔開,大小寫不敏感 add_header ‘Access-Control-Expose-Headers’ ‘WWW-Authenticate,Server-Authorization’; #P3P支援跨域cookie操作 add_header P3P ‘policyref=“/w3c/p3p。xml”, CP=“NOI DSP PSAa OUR BUS IND ONL UNI COM NAV INT LOC”’; }}

6。3 按請求方法區分跨域

server{ listen 80; server_name www。jiagouyun。com; root root /usr/share/nginx/html; location / { if ($request_method = ‘OPTIONS’) { add_header ‘Access-Control-Allow-Origin’ ‘*’; add_header ‘Access-Control-Allow-Methods’ ‘GET, POST, OPTIONS’; add_header ‘Access-Control-Allow-Headers’ ‘DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type’; add_header ‘Access-Control-Max-Age’ 864000; add_header ‘Content-Type’ ‘text/plain charset=UTF-8’; add_header ‘Content-Length’ 0; return 204; } if ($request_method = ‘POST’) { add_header ‘Access-Control-Allow-Origin’ ‘*’; add_header ‘Access-Control-Allow-Methods’ ‘GET, POST, OPTIONS’; add_header ‘Access-Control-Allow-Headers’ ‘DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type’; } if ($request_method = ‘GET’) { add_header ‘Access-Control-Allow-Origin’ ‘*’; add_header ‘Access-Control-Allow-Methods’ ‘GET, POST, OPTIONS’; add_header ‘Access-Control-Allow-Headers’ ‘DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type’; } }}

文章來源:https://www。guance。com/learning/articles/cross_origin_problem_with_Nginx