前幾天接到一個需求:前端頁面異步調用後台的 WebService 方法拿數據。方案選了 jQuery + Ajax,本地調試一切正常,可部署到服務器上就出問題了——後台服務調用毫無響應。代碼幾乎沒動,唯一改動的是 Ajax 裡的 url 地址。
查了一輪才明白,罪魁禍首是同源策略。
JavaScript 有一個非常重要的安全限制,被稱為 Same-Origin Policy(同源策略)。它規定:JavaScript 只能訪問與包含它的文檔或腳本處於同一域名下的內容。不同域名的腳本不能互相訪問,即便是父子域之間也不行。所謂「同源」,指的是協議、域名、端口三者完全一致。
本地調試能通、部署後不通,正是因為前者是同域,後者變成了跨域。
JSON(JavaScript Object Notation) 是一種輕量級的數據交換格式,基於 JavaScript 的一個子集,採用完全獨立於語言的文本格式,但也沿用了 C 語言家族的習慣(C、C++、C#、Java、JavaScript、Perl、Python 等)。這些特性讓它成為理想的數據交換語言:易於人閱讀和編寫,也易於機器解析和生成,網絡傳輸速度快。
JSONP(JSON with Padding) 是 JSON 的一種「使用模式」,可用於解決主流瀏覽器的跨域數據訪問問題。由於同源策略,位於 server1.example.com 的網頁通常無法與其他服務器溝通,而 HTML 的 script 元素是一個例外。利用 script 元素的這個開放策略,網頁可以得到從其他來源動態產生的 JSON 資料,這種模式就是 JSONP。用 JSONP 抓到的資料並不是 JSON,而是任意 JavaScript,由 JavaScript 直譯器執行,而不是由 JSON 解析器解析。
一句話概括:JSON 是描述數據的格式,像 XML 一樣;JSONP 是使用 JSON 的一種方式,返回的不是 JSON 對象,而是包含 JSON 對象的 JavaScript 腳本。
由於同源策略,XMLHttpRequest 只允許請求當前源(協議、域名、端口)的資源。但我們注意到一個事實:Web 頁面加載 js 文件時並不受跨域影響,凡是擁有 src 屬性的標簽(script、img、iframe)都具備跨域能力。
於是想到了變通:用 script 標簽發起請求,讓服務端返回一段待執行的腳本,腳本內容裡直接攜帶 JSON 數據並調用預先約定好的函數。這樣就繞過了同源策略。
前端代碼:
function CallWebServiceByJsonp() { $("#SubEquipmentDetails").html(''); $.ajax({ type: "GET", cache: false, url: "https://servername/webservice/webservice.asmx/GetSingleInfo", data: { strCparent: $("#Equipment_ID").val() }, dataType: "jsonp", jsonpCallback: "OnGetMemberSuccessByjsonp" }); } function OnGetMemberSuccessByjsonp(data) { //處理data alert(data); }
後端 WebService:
[WebMethod] [ScriptMethod(ResponseFormat = ResponseFormat.Json, UseHttpGet = true)] public void GetSingleInfo(string strCparent) { string ret = string.Empty; HttpContext.Current.Response.ContentType = "application/json;charset=utf-8"; //必須先取出callback參數 string jsonCallBackFunName = HttpContext.Current.Request.Params["callback"].ToString(); //中間執行自己的業務邏輯 BLL.equipment eq_bll = new BLL.equipment(); List<Model.equipment> equipmentList = new List<Model.equipment>(); equipmentList = eq_bll.GetModelEquimentList(strCparent); ret = JsonConvert.SerializeObject(equipmentList); //必須以 callback(數據) 的形式輸出 HttpContext.Current.Response.Write(string.Format("{0}({1})", jsonCallBackFunName, ret)); HttpContext.Current.Response.End(); }
流程串起來就是:前端帶上 callback 參數發請求,後端取出這個參數名,把自己的業務數據序列化後包成 callback(數據) 的形式輸出,前端頁面裡預先定義的同名函數隨即被執行,數據就到手了。
必須承認 JSONP 並非完美,主要有幾點:
不提供錯誤處理。動態插入的腳本若正常運行,你能拿到返回;一旦失敗,什麼都不會發生,沒有任何回調通知你。這是它與正規 Ajax 最大的差距。
只支援 GET。因為本質是加載腳本資源,無法帶請求體。
存在安全風險。本質上是執行遠端返回的任意 JavaScript,因此只能請求完全可信的域名。
如果目標瀏覽器都比較現代,直接讓服務端開 CORS 會是更規範的選擇;JSONP 更像是兼容存量環境時的權宜之計。