DIV CSS 佈局教程網

跨網域請求解惑:jQuery ajax 的 jsonp 怎麼用才會成功
編輯:JQuery特效代碼     

初次使用 ajax 的 jsonp 時,最容易遇到的狀況是:明明後端邏輯沒問題、前端屬性也照抄範例,卻仍然直接進入 error 分支。原因往往不在程式碼本身,而在回應格式與參數名稱沒有對上。以下整理一份可直接運行的完整範例。

前端頁面

<script type="text/javascript" src="jquery.min.js"></script>
<script type="text/javascript">
jQuery(document).ready(function(){
    $.ajax({
        type: "get",
        async: false,
        url: "ajax.ashx",
        dataType: "jsonp",
        jsonp: "callbackparam",              // 傳給後端、用來取得回呼函數名稱的參數名(預設為 callback)
        jsonpCallback: "success_jsonpCallback", // 自訂回呼函數名稱
        success: function(json){
            alert(json);
            alert(json[0].name);
        },
        error: function(){
            alert('fail');
        }
    });
});
</script>

後端處理程式

<%@ WebHandler Language="C#" Class="ajax" %>
using System;
using System.Web;

public class ajax : IHttpHandler {
    public void ProcessRequest (HttpContext context) {
        context.Response.ContentType = "text/plain";
        string callbackFunName = context.Request["callbackparam"];
        context.Response.Write(callbackFunName + "([ { name:\"John\"} ] )");
    }
    public bool IsReusable { get { return false; } }
}

關鍵觀念:回應必須是「一段函數呼叫」

jsonp 與一般 ajax 最大的差別在於回應結果的處理方式。上述範例的實際回應內容是:

success_jsonpCallback([ { name:"John"} ] );

也就是瀏覽器收到的不是純資料,而是一句「呼叫 success_jsonpCallback,並把後面這個陣列當參數傳進去」的 JavaScript 敘述句。由於它以 script 標籤形式被載入執行,因此得以繞過同源政策。其底層概念大致相當於:

function success_jsonpCallback(data){
    success(data);
}

這也解釋了兩個最常見的失敗原因:後端忘了包上函數名稱(只回傳 JSON 陣列),以及參數名稱不一致(前端指定 jsonp: "callbackparam",後端卻去讀 "callback")。這兩種情況都會讓瀏覽器執行到無效的程式碼,最終落入 error。

dataType 可接受的設定

值說明
xml回傳 XML 文件,可用 jQuery 處理。
html回傳純文字 HTML;其中的 script 標籤會在插入 DOM 時執行。
script回傳純文字 JavaScript 並執行,預設不快取結果(除非明確設定 cache)。注意:跨網域請求時,所有 POST 都會被轉為 GET,因為底層是使用 script 標籤載入。
json回傳 JSON 資料並轉為 JavaScript 物件。
jsonp以 JSONP 形式呼叫。使用 "myurl?callback=?" 時,jQuery 會自動把 ? 替換為正確的函數名稱。
text回傳純文字字串。

若不指定 dataType,jQuery 會依 HTTP 回應的 MIME 型別自行判斷。

jsonp 與 jsonpCallback 的差別

jsonp:用來「覆寫回呼參數的名稱」。例如設為 {jsonp:'onJsonPLoad'},實際送出的查詢字串會變成 onJsonPLoad=? 而非預設的 callback=?。這在後端框架已固定使用別的參數名時很有用。

jsonpCallback:用來「指定回呼函數的名稱」,取代 jQuery 自動產生的隨機函數名。好處是函數名固定,瀏覽器得以快取 GET 請求,也讓請求管理與錯誤處理更容易。

經測試,jsonp 對同步或異步設定並無實質影響。整體而言,只要確認「回應格式是函數呼叫」與「兩端的參數名稱一致」,跨網域取資料其實並不複雜。

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