萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

jQuery AJAX 透過 JSONP 實現跨域請求完整指南

前言

在前端開發中,瀏覽器的同源策略限制了 JavaScript 直接向不同域發起 AJAX 請求。JSONP(JSON with Padding)是一種經典的跨域解決方案,利用 <script> 標籤不受同源策略限制的特性,透過動態插入腳本標籤並約定回調函數來實現跨域數據交換。本文將詳細介紹如何在 jQuery 中使用 $.ajax() 進行 JSONP 請求,包含參數說明、伺服器端配合以及自定義回調函數的實作範例。

核心參數解析

$.ajax() 在進行 JSONP 請求時,以下參數至關重要:

  • type:請求方式,JSONP 僅支援 GET。
  • url:請求目標地址(跨域 URL)。
  • dataType:必須設為 "jsonp",告知 jQuery 使用 JSONP 模式。
  • jsonp:傳遞給伺服器的查詢參數名,用於指定回調函數名稱,預設為 "callback"。
  • jsonpCallback:自定義的回調函數名稱。若不指定,jQuery 會自動生成隨機函數名;也可設為 "?" 讓 jQuery 自動處理。
  • success:請求成功時的回調函數,參數為解析後的 JSON 資料。
  • error:請求失敗時的回調(注意:JSONP 請求失敗時,error 可能不會觸發,需依賴超時機制)。

範例一:基本 JSONP 請求

伺服器端

以 ASP.NET MVC 為例,Controller Action 需讀取 callback 參數,並將 JSON 資料包裝在該函數呼叫中回傳:

public ActionResult ReturnJson() {
    string callback = Request.QueryString["callback"];
    string json = "{'name':'張三','age':'20'}";
    string result = string.Format("{0}({1})", callback, json);
    return Content(result, "application/javascript");
}

客戶端

前端頁面引入 jQuery 後,呼叫 $.ajax():

function sendData() {
    $.ajax({
        type: "get",
        async: false,          // 示範用同步,實際建議使用非同步
        url: "/home/ReturnJson",
        dataType: "jsonp",
        success: function(data) {
            alert(data.name);  // 直接存取解析後的物件屬性
        },
        error: function() {
            alert('請求失敗');
        }
    });
}

點擊按鈕觸發 sendData() 後,可觀察到伺服器端接收到的 callback 參數為 jQuery 自動生成的隨機函數名(如 jQuery1710123456789_1234567890),資料即以 JSONP 格式傳回並自動執行回調。

範例二:自定義回調函數名稱

若需指定回調函數名(例如與既有程式碼整合),可同時設定 jsonp 與 jsonpCallback:

function sendData() {
    $.ajax({
        type: "get",
        async: false,
        url: "/home/ReturnJson",
        dataType: "jsonp",
        jsonp: "callback",        // 查詢參數名,與伺服器端一致
        jsonpCallback: "receive", // 自定義回調函數名
        success: function(data) {
            alert(data.name);
        },
        error: function() {
            alert('fail');
        }
    });
}

// 全域定義的回調函數(需掛載在 window 下)
function receive(data) {
    alert(data.age);
}

此時伺服器端仍讀取 Request.QueryString["callback"] 獲得 "receive",回傳 receive({'name':'張三','age':'20'}),jQuery 會自動執行全域 receive 函數並將解析後的物件傳入 success 回調。

注意事項與最佳實踐

  1. 僅支援 GET:JSONP 原理是動態建立 <script src="...">,故無法發送 POST 請求或大量資料。
  2. 安全性:JSONP 屬於腳本注入,僅適用於受信任的跨域 API,避免在敏感資料傳輸中使用。
  3. 錯誤處理:JSONP 無法直接捕獲 HTTP 狀態碼,建議搭配 timeout 參數或伺服器端約定錯誤碼在 JSON 內部返回。
  4. 現代替代方案:若伺服器可控,優先考慮 CORS(Cross-Origin Resource Sharing),支援完整 HTTP 動詞與更佳的安全性。

總結

jQuery 的 $.ajax() 透過設定 dataType: "jsonp" 即可輕鬆實現跨域請求。理解 jsonp 與 jsonpCallback 參數的角色,並配合伺服器端正確輸出「函數呼叫包裹 JSON」的格式,即可在不支援 CORS 的舊環境或第三方 API 中順利完成資料交換。

copyright © 萬盛學電腦網 all rights reserved