子域名之間互相調用資源時,只要主機名稱不同就屬於跨域,會被瀏覽器的同源政策擋下來。本文用一組實際環境把整個流程走一遍,並釐清幾個網路上少有人講清楚的細節。
1. 服務端必須設定允許跨域。
2. 客戶端若要帶 cookie,必須設定 withCredentials。
3. 無論服務端是否允許跨域,該 request 都會被完整執行。
4. options 預檢請求必須直接回傳空內容,否則若 requestMapping 不支援該方法就會出錯。
先準備兩台服務:一個是提供 API 的 server A,一個是需要跨域呼叫的 server B。
Server A 提供的介面完整路徑為:
https://local.corstest.com.net:8443/contentmain/getDepositsRoomAndRatePlanInfo.json?htid=759&_=1490855801818
Server B 上有一個頁面:
https://cros.corstest.com.net:3001/test.html
這個頁面要去請求 server A 的 API,但受限於跨域保護而失敗, Console 會出現:
No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'xxxxx' is therefore not allowed access.
在本機的 hosts 檔加入兩筆指向 127.0.0.1 的記錄,模擬不同子域名:
127.0.0.1 local.corstest.com.net 127.0.0.1 cros.corstest.com.net
接著啟動專案 A 提供 API。至於專案 B,測試跨域只需要一個靜態頁面,因此寫一份 test.html 並用工具發布即可:
browser-sync
安裝方式:
npm install -g browser-sync
啟動指令:
browser-sync start --server --files "*.html" --host "cros.corstest.com.net" --port 3001
瀏覽器把 CORS 請求分成兩類:簡單請求(simple request)與非簡單請求(not-so-simple request)。
同時滿足以下兩個條件即屬於簡單跨域:
1)請求方法是下列三者之一:
2)HTTP 標頭不超出以下幾種欄位:
其餘情況都算非簡單請求,例如方法是 PUT 或 DELETE,或 Content-Type 為 application/json。非簡單請求會在正式溝通之前多發一次 HTTP 查詢請求,稱為「預檢」(preflight),也就是 options 請求。
跨域的本質是瀏覽器要求服務端「表態」,而表態的方式就是標頭裡的 Access-Control-Allow-Origin。瀏覽器會比對回應中是否含這個欄位、內容是否與當前網址相符,來決定要不要把結果交給頁面。也就是說,如果繞過瀏覽器(例如用 server 端程式發請求),根本不存在跨域問題。
有兩個問題在多數文章裡都沒有交代清楚,這裡實際驗證一次。
第一點,帶 cookie 的行為。瀏覽器把 withCredentials 設為 true 時會帶 cookie 送出;服務端設 Access-Control-Allow-Credentials 為 true 才接收。關鍵在於,是否設定回應標頭是在 filter 階段才決定的,而此時 cookie 其實已經在 request 裡了。
驗證結果:服務端確實已經收到 cookie,即使把該標頭設為 false,服務端仍然收到了 cookie,客戶端也仍然能送出。
第二點,簡單跨域究竟請求了幾次?如果是 1 次,那麼服務端不支援跨域(沒有設定 allow)時,還會不會繼續往下執行並把結果放進回應?畢竟所有設定標頭的動作都只是「告知瀏覽器」,與服務端自身的限制無關。
驗證結果:即使服務端沒有設定允許跨域,請求進來時服務端仍然完整執行並回傳了結果,只是客戶端沒有接收。這一點在除錯時很重要——畫面上看到錯誤,不代表後端沒有真的執行過業務邏輯。
針對上述兩類跨域,server A 需要寫一個 filter。先在 web.xml 註冊:
<filter> <filter-name>cors</filter-name> <filter-class>com.test.filter.CorsFilter</filter-class> </filter> <filter-mapping> <filter-name>cors</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> </filter>
Filter 實作:
public class CorsFilter extends OncePerRequestFilter { @Override protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException { URL requestURL = new URL(request.getRequestURL().toString()); String hostName = requestURL.getHost(); String origin = request.getHeader("Origin"); int index = hostName.indexOf("."); if(index > -1) { String domainHost = hostName.substring(index, hostName.length()); if(!StringUtils.isEmpty(origin) && origin.contains(domainHost)) { response.addHeader("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS"); response.addHeader("Access-Control-Allow-Origin", origin); response.addHeader("Access-Control-Allow-Credentials", "true"); response.setHeader("Access-Control-Max-Age", "3600"); response.addHeader("Access-Control-Allow-Headers", "Content-Type, Cookie, " + "Accept-Encoding, User-Agent, " + "Host, Referer, " + "X-Requested-With, Accept, " + "Accept-Language, Cache-Control, Connection"); if (request.getHeader("Access-Control-Request-Method") != null && "OPTIONS".equals(request.getMethod())) { // CORS "pre-flight" request response.setStatus(200); return; } } } filterChain.doFilter(request, response); } }
這個 filter 的策略是:只允許同一個主域名下的不同子域名互相存取,其他域名一律不通過。因為我們需要共用 cookie,所以 Access-Control-Allow-Credentials 設為 true;設為 false 則不會接收 cookie。
至於客戶端(server B),若要送出 cookie 就必須設 withCredentials 為 true:
//原生 var xhr = new XMLHttpRequest(); xhr.withCredentials = true; //jquery $.ajax({ ... xhrFields: { withCredentials: true } ... });
特別注意:遇到非簡單跨域時,options 預檢請求的目的只是讓服務端表態是否支援跨域,表態完就該直接回傳,不要繼續往下走。否則流程會一路走到指定的 requestMapping,而該方法可能根本不支援 OPTIONS,於是丟出錯誤。
<!DOCTYPE html> <html lang="en"> <meta charset="UTF-8"> <title>test</title> <script src="jquery-1.11.3.js"></script> </head> <body> <input type="button" value="GET_Default" onclick="testGetDefault()"> <input type="button" value="GET_JSON" onclick="testGetJSON()"> <input type="button" value="POST_Default" onclick="testPostDefault()"> <input type="button" value="POST_JSON" onclick="testPostJson()"> <input type="button" value="PUT" onclick="testPUT()"> <script> var getUrl = "https://local.corstest.com.net:8443/contentmain/getDepositsRoomAndRatePlanInfo.json?htid=759"; var postUrl = "https://local.corstest.com.net:8443/contentmain/saveReservationDeposits.json?htid=759"; function testGetDefault(){ sendAjax("GET",getUrl, "json", "application/x-www-form-urlencoded"); } function testGetJSON(){ sendAjax("GET",getUrl, "json", "application/json; charset=utf-8"); } function testPostDefault(){ sendAjax("POST",postUrl, "json", "application/x-www-form-urlencoded"); } function testPostJson(){ sendAjax("POST",postUrl, "json", "application/json; charset=utf-8"); } function testPUT(){ sendAjax("PUT",postUrl, "json", "application/json; charset=utf-8"); } function sendAjax(type, url, dataType, contentType){ $.ajax( { type: type, url: url, xhrFields: { withCredentials: true }, dataType : dataType, // accept type contentType: contentType, //request type, default is application/x-www-form-urlencoded success: function(result){ console.log(result); }, error: function (xhr) { console.log(xhr); } }); } </script> </body> </html>
GET default:只送出一個正常的 get 請求。
GET json:先送出一個 options 預檢請求:
General: Request URL:https://local.corstest.com.net:8443/contentmain/getDepositsRoomAndRatePlanInfo.json?htid=759 Request Method:OPTIONS Status Code:200 OK Remote Address:127.0.0.1:8443 Response Headers: Access-Control-Allow-Credentials:true Access-Control-Allow-Headers:Content-Type, Cookie, Accept-Encoding, User-Agent, Host, Referer, X-Requested-With, Accept, Accept-Language, Cache-Control, Connection Access-Control-Allow-Methods:GET, POST, PUT, DELETE, OPTIONS Access-Control-Allow-Origin:https://cros.corstest.com.net:3001 Content-Length:0 Date:Thu, 30 Mar 2017 12:47:44 GMT Server:Apache-Coyote/1.1 Request Headers: Accept:*/* Accept-Encoding:gzip, deflate, sdch, br Accept-Language:zh-CN,zh;q=0.8 Access-Control-Request-Headers:content-type Access-Control-Request-Method:GET Connection:keep-alive Host:local.corstest.com.net:8443 Origin:https://cros.corstest.com.net:3001 Referer:https://cros.corstest.com.net:3001/test.html User-Agent:Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36
接著才送出正常的 GET 請求。
POST default:正常送出請求,沒有預檢。
POST json:先送 options 預檢,再送正式請求。
其餘情況同理。歸納起來就是:非簡單跨域會多一次 options 請求來確認是否支援跨域,此時服務端必須回覆支援並立即返回,不要往下執行。
跨域問題的除錯順序建議是:先確認請求方法與 Content-Type 屬於哪一類,再看回應標頭有沒有正確帶上 Access-Control-Allow-Origin,最後檢查 options 是否被正確攔截並提前返回。把這三步走完,九成的跨域狀況都能定位。