跨域CORS原理及調用具體樣本

標籤：tps   blog   sam   .net   rom   除了   response   xmlhttp   zip   

　　原文： https://www.cnblogs.com/keyi/p/6726089.html

 

　　上篇部落格介紹了JSONP原理，其不足，就是只能使用GET提交，若傳輸的資料量大，這個JSONP方式就歇菜了。那這篇部落格就來介紹另一種跨域介紹方案—CORS。

  　　相對JSONP，CORS支援POST提交，並且實施起來灰常簡單，CORS原理只需要向回應標頭header中注入Access-Control-Allow-Origin，這樣瀏覽器檢測到header中的Access-Control-Allow-Origin，則就可以跨網域作業了。 

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

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

一、簡介

　　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.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欄位的值。

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.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。

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: 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天），在此期間，不用發出另一條預檢請求。

4.3 瀏覽器的正常請求和回應

　　一旦伺服器通過了"預檢"請求，以後每次瀏覽器正常的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欄位是每次回應都必定包含的。

五、與JSONP的比較

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

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

 ---------------------------------------------------------------------------------------------------------------------     　　具體實現如下：  　　前台使用普通的Ajax提交方式，跟普通訪問一樣，無需更改。  

$.ajax({   url:"http://localhost:8080/crcp/rcp/t99eidt/testcors.do",   async :false,   type:"POST",   success:function(data){   var a=JSON.parse(data);   var html=JSON.stringify(a.RESULTSET);   $("#testcors").html(html);   },   error:function(){   alert("error");   }   }); 

   伺服器Action方法如下： 

public void testCors() throws Exception{  JSONObject jsonObject=new JSONObject();  List list=new ArrayList();  for(int i=0;i<4;i++){  Map paramMap=new HashMap();  paramMap.put("bank_no", 100+i);  paramMap.put("money_type", i);  paramMap.put("bank_name", "測試代碼"+i);  paramMap.put("bank_type", i);  paramMap.put("bank_status", 0);  paramMap.put("en_sign_ways", 1);  list.add(paramMap);  }  JSONArray rows=JSONArray.fromObject(list);  jsonObject.put("RESULTSET", rows);  HttpServletRequest request=ServletActionContext.getRequest();  HttpServletResponse response=ServletActionContext.getResponse();  response.setHeader("Access-Control-Allow-Origin", "*");  response.setCharacterEncoding("UTF-8");  Writer out = response.getWriter();          System.out.println(jsonObject.toString());  out.write(jsonObject.toString());  

   　　response.setHeader("Access-Control-Allow-Origin", "*");這句代碼中*代碼，伺服器允許任何人訪問。當然可以設定規定訪問的網域名稱。比如只允許http://localhost:8080/crcp這個域下的訪問。則把*代替成這個網域名稱即可。    響應圖如下： 　　CORS實現起來比較簡單，但是缺點是支援瀏覽器有限。目前支援的瀏覽器版本如下

跨域CORS原理及調用具體樣本