DIV CSS 佈局教程網

AJAX 跨來源請求 WebService:JSONP 的實作與原理
編輯:關於JavaScript     

瀏覽器的同源政策會擋下所有跨來源的 AJAX 請求,不管你請求的是靜態頁面、動態網頁還是 Web 服務。繞過這個限制最經典的方案就是 JSONP,本文整理實作程式碼與背後的道理。

一、前端程式碼

$.ajax({
    type: "get",
    url: "https://localhost/Service1.asmx/getElevatorStatusJsonData?jsoncallback=?",
    dataType: "jsonp",
    jsonp: "json",           // 傳 callback 函式名的參數名稱
    data: "",
    success: function (result) {
        var data = eval(result);
        for (var i = 0; i < data.length; i++) {
            alert(data[i].ID + "--" + data[i].Name);
        }
    },
    error: function (a, b, c) { alert(c); }
});

二、後端程式碼(C#)

/// <summary>
/// 取得狀態資料
/// </summary>
[WebMethod]
public void getElevatorStatusJsonData()
{
    List<List<DeviceInfo>> elevatordatas = new List<List<DeviceInfo>>();

    List<SendDicdate> searchList = XmlSerializeHelper.XmlDeserializeFromFile<List<SendDicdate>>(
        @ConfigUtil.servicePath + ConfigUtil.getConfigByKey("xmlPath") + "查詢指令信息.xml",
        Encoding.UTF8);

    foreach (SendDicdate item in searchList) {
        string key = item.portno + "-" + item.bordrate + "-" + item.sendtype;
        elevatordatas.Add((List<DeviceInfo>)Context.Cache.Get(key));
    }

    // 序列化為 JSON
    String result = "";
    DataContractJsonSerializer json = new DataContractJsonSerializer(elevatordatas.GetType());
    using (MemoryStream stream = new MemoryStream()) {
        json.WriteObject(stream, elevatordatas);
        result = Encoding.UTF8.GetString(stream.ToArray());
    }

    // 關鍵:用 callback 名稱把 JSON 包起來
    String jsoncallback = HttpContext.Current.Request["jsoncallback"];
    result = jsoncallback + '(' + result + ')';

    HttpContext.Current.Response.Write(result);
    HttpContext.Current.Response.End();
}

Java 端原理相同,只是取參數的方法不同:

String callbackFunName = context.Request["callbackparam"];
context.Response.Write(callbackFunName + "([{\"name\":\"John\"}])");

三、兩個容易混淆的參數

jsonp 是告訴 jQuery「用哪個 query 參數名稱去傳 callback 函式名」。寫 jsonp: "json",實際送出的 URL 就會變成 ...?json=jQuery123456。

jsonpCallback 則是自己指定 callback 的名稱,而不是讓 jQuery 隨機產生。

這兩個名字很像但作用不同,設定錯就會一直拿到 callback undefined 的錯誤。

四、另一條路:CORS 標頭

如果後端你能控制,更現代的做法是直接加上 CORS 回應標頭:

context.Response.AddHeader("Access-Control-Allow-Origin", "*");

加上這一行之後,前端就不需要 dataType: "jsonp" 那三個參數,用普通的 AJAX 呼叫就能拿到資料。這是 Chrome 等現代瀏覽器支援的標準做法,比 JSONP 乾淨得多。

五、JSONP 的原理

  1. AJAX 直接請求普通檔案必然遇到跨來源限制,無論對方是靜態頁面、動態網頁、Web 服務還是 WCF。
  2. 但我們發現,網頁上用 script 標籤載入 JS 檔案時不受跨來源限制。事實上凡是帶有 src 屬性的標籤都具備跨來源能力。
  3. 於是結論很清楚:想在純前端跨來源取資料,唯一的路是「讓遠端伺服器把資料裝進一段 JS 裡」,供客戶端載入。
  4. 剛好 JSON 是一種能簡潔描述複雜結構的純文字格式,而且被 JS 原生支援,客戶端幾乎可以隨意處理。
  5. 這樣方案就出來了:客戶端用「載入腳本」的方式去請求遠端動態生成的 JS 檔案(後綴通常寫成 .json 或 .jsonp)。伺服器之所以要動態生成,就是為了把客戶端要的資料塞進去。
  6. 載入成功後,客戶端就拿到資料了。這個過程看起來很像 AJAX,本質上完全不同——它其實只是一次普通的 script 載入。
  7. 為了讓客戶端能處理資料,業界逐漸形成一個非正式協議:允許客戶端傳一個 callback 參數給伺服器,伺服器回應時把這個參數當成函式名,用括號把 JSON 包起來。這樣客戶端就能自訂函式去接收資料。

於是伺服器只要「動態生成腳本」就行了:客戶端傳一個參數說「我要一段呼叫 XXX 函式的 JS 程式碼」,伺服器就照著產生並回應。

六、不用 jQuery 的純原生寫法

<!DOCTYPE html>
<html>
<head>
<title>JSONP 原生實作</title>
<script type="text/javascript">
// 這個函式會被遠端回傳的腳本呼叫
var flightHandler = function (data) {
    alert('您查詢的航班結果是:票價 ' + data.price + ' 元,餘票 ' + data.tickets + ' 張。');
};

// 遠端服務的位址,callback 參數指定要呼叫的函式名
var url = "https://flightQuery.com/jsonp/flightResult.aspx?code=CA1998&callback=flightHandler";

// 動態建立 script 標籤
var script = document.createElement('script');
script.setAttribute('src', url);

// 加入 head 的瞬間,請求就開始了
document.getElementsByTagName('head')[0].appendChild(script);
</script>
</head>
<body></body>
</html>

這段程式完全沒有 AJAX,就是建立一個 script 標籤塞進頁面。伺服器回傳的內容長得像這樣:

flightHandler({"price": 780, "tickets": 12});

瀏覽器執行這段腳本,等於呼叫了 flightHandler 並把資料傳進來。這就是 JSONP 的全部魔法——一點也不神奇。

用 jQuery 時之所以沒看到 flightHandler,是因為 jQuery 會自動幫你產生回調函式並在資料到手後交給 success 處理:

<script src="jquery.min.js"</script>
<script type="text/javascript">
$.ajax({
    type: "get",
    async: false,
    url: "https://flightQuery.com/jsonp/flightResult.aspx?code=CA1998",
    dataType: "jsonp",
    jsonp: "callback",              // 傳 callback 名的參數名稱
    jsonpCallback: "flightHandler", // 自訂回調函式名;寫 "?" 則交給 jQuery 產生
    success: function (json) {
        alert('查到航班資訊:票價 ' + json.price + ' 元,餘票 ' + json.tickets + ' 張。');
    },
    error: function () { alert('fail'); }
});
</script>

七、JSONP 的兩個致命限制

只能 GET。因為它的本質是載入一個 script 檔案,而 script 標籤無法發送 POST。要送出大量資料或敏感資料就完全不行。

有 XSS 風險。你把一段遠端 JavaScript 直接放進自己的頁面執行。如果對方被入侵或回傳的內容被污染,你的頁面就完全暴露在風險中。所以只對「你信任的來源」使用 JSONP,並在後端確實過濾 callback 參數(只允許字母數字),否則還會被拿來做 JSONP 劫持。

結論很明確:新專案請優先採用 CORS。只有在你無法控制後端、對方又不支援 CORS 的情況下,才退回 JSONP。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved