前幾天工作上遇到一個新需求:需要前端 Web 頁面非同步呼叫後台的 WebService 方法並取得回傳資訊。實作方式有很多種,本例採用 jQuery + Ajax。完成後在本地測試一切正常,但部署到伺服器上卻出問題了——後台服務呼叫沒有任何回應。程式碼幾乎沒改動,唯一的差異是修改了 jQuery ajax 方法中的網址。難道是這裡出了問題?經過檢查與除錯,才發現原來是同源策略在作祟。
我們知道,JavaScript 或 jQuery 是 Web 前端開發中常用的動態腳本技術。在 JavaScript 中有一個重要的安全性限制,稱為「Same-Origin Policy」(同源策略)。這一策略對 JavaScript 程式碼能存取的頁面內容做了嚴格限制:JavaScript 只能存取與包含它的文件或腳本位於同一域名下的內容,不同域名下的腳本不能互相存取,即便是子域也不行。
但有時候又難以避免地需要進行跨域操作,這時同源策略就成了限制。怎麼辦呢?採用 JSONP 跨域 GET 請求是一個常見的解決方案。下面我們就來看看 JSONP 跨域是如何實作的,並探討其原理。
提到 JSONP,就有人會問:它和 JSON 有什麼不同?先來釐清兩者的定義。
JSON(JavaScript Object Notation)是一種輕量級的資料交換格式,基於 JavaScript(Standard ECMA-262 3rd Edition - December 1999)的子集,採用完全獨立於語言的純文字格式,卻沿用了 C 語言家族的習慣,易於人閱讀撰寫,也易於機器解析生成。
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 腳本。
那麼 JSONP 是如何運作的呢?由於同源策略的限制,XMLHttpRequest 只允許請求當前源(域名、協議、埠)的資源,跨域請求基於安全考量是不行的。但我們發現,Web 頁面載入 JavaScript 檔時不受跨域影響,而且凡是擁有 src 屬性的標籤(如 <script>、<img>、<iframe>)都具備跨域能力。於是聰明的開發者便想到變通之道:利用 HTML 的 script 標籤進行跨域請求,並在回應中返回要執行的 script 程式碼,其中可直接使用 JSON 傳遞 JavaScript 物件。也就是在跨域的伺服器端產生 JSON 資料,包裝成 script 腳本回傳,如此便突破了同源策略的限制。
下面來看具體實作。前端程式碼:
復制代碼 代碼如下:
function CallWebServiceByJsonp() {
$("#SubEquipmentDetails").html('');
$.ajax({
type: "GET",
cache: false,
url: "https://servername/webservice/webservice.asmx/GetSingleInfo",
data: { strCparent: $("#Equipment_ID").val() },
dataType: "jsonp",
//jsonp: "callback",
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";
string jsonCallBackFunName = HttpContext.Current.Request.Params["callback"].ToString();
//string jsonCallBackFunName1 = HttpContext.Current.Request.QueryString["callback"].Trim();
//上面代碼必須
//中間代碼執行自己的業務操作,可返回自己的任意信息(多數據類型)
BLL.equipment eq_bll = new BLL.equipment();
List<Model.equipment> equipmentList = new List<Model.equipment>();
equipmentList = eq_bll.GetModelEquimentList(strCparent);
ret = JsonConvert.SerializeObject(equipmentList);
//下面代碼必須
HttpContext.Current.Response.Write(string.Format("{0}({1})", jsonCallBackFunName, ret));
HttpContext.Current.Response.End();
}
如上所示,前端的 CallWebServiceByJsonp 方法以 jQuery 的 ajax 呼叫後端 Web 服務的 GetSingleInfo 方法;後台則以前端的回調方法 OnGetMemberSuccessByjsonp 包裝業務操作的 JSON 物件,回傳一段 JavaScript 片段給前端執行,巧妙地解決了跨域存取問題。
最後要提醒 JSONP 的一個缺點:它不提供錯誤處理。如果動態插入的程式碼正常運行,你就能取得回傳;但一旦失敗,則什麼都不會發生,這在除錯時需要特別留意。
希望本文對大家理解 JSONP 跨域 GET 請求有所幫助。