關於 JSONP 的概念與使用理由網上已有許多討論,這裡聚焦在實作:如何用 jQuery 的 $.ajax() 完成一次跨域的 JSONP 呼叫,以及如何自訂回呼函數名稱。
type 請求方式,GET 或 POST(JSONP 實際上只能是 GET)
url 請求位址
async 布林值,預設 true 表示非同步
dataType 回傳的資料類型,這裡設為 "jsonp"
jsonp 傳給伺服器、用來指定回呼函數名稱的參數名,預設為 callback
jsonpCallback 自訂的回呼函數名稱,預設由 jQuery 產生隨機名稱
success / error 成功與失敗時執行的函數
把 jsonp 與 jsonpCallback 分清楚很重要:前者是「用哪個參數名傳」,後者是「傳什麼值」。
伺服器端以 ASP.NET MVC 的 Action 回傳資料:
public class HomeController : Controller
{
public ActionResult Index()
{
return View();
}
public ActionResult ReturnJson()
{
string callback = Request.QueryString["callback"];
string json = "{'name':'張三','age':'20'}";
string result = string.Format("{0}({1})", callback, json);
return Content(result);
}
}
關鍵就是把回呼名稱與 JSON 資料包成 callback({...}) 的形式回傳,瀏覽器執行這段「JavaScript」時便等於呼叫了我們的函數。
客戶端:
<script src="~/Scripts/jquery-1.7.1.min.js" type="text/javascript"></script>
<script type="text/javascript">
function SendData()
{
$.ajax({
type: "get",
async: false,
url: "/home/ReturnJson",
dataType: "jsonp",
success: function(data){
alert(data.name);
},
error: function(){
alert('fail');
}
});
}
</script>
<input type="button" value="提交" onclick="SendData();"/>
點下按鈕後,可以在伺服器端觀察到 Request.QueryString["callback"] 收到一個 jQuery 自動產生的隨機函數名,資料便以 JSONP 格式傳了回來。
加上 jsonpCallback 就能指定名稱,同時也能自己寫一個同名函數去接收資料:
<script type="text/javascript">
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');
}
});
}
function receive(data) {
alert(data.age);
}
</script>
伺服器端仍用 Request.QueryString["callback"] 取值,此時收到的會是 "receive"。
JSONP 只能是 GET。它的本質是動態插入一個 <script> 標籤,而 script 標籤無法發送 POST。因此 type:"post" 搭配 dataType:"jsonp" 是不會生效的,需要送出大量或敏感資料時,JSONP 並不適合。
async:false 沒有意義。既然底層是 script 標籤載入,本來就是非同步的,這個參數在 JSONP 模式下不起作用,請直接移除。
安全性上要特別小心。JSONP 等於把目標網域的執行權交給對方回應的內容,因此只應向完全可信的網域發出 JSONP 請求。同時,回傳的 JSON 若含有使用者輸入的資料,伺服器端必須過濾 <、> 等字元,避免在客戶端造成 XSS。
如果是自己可以掌握的環境,今日更推薦用 CORS:伺服器端加上 Access-Control-Allow-Origin 標頭即可,能支援完整的 HTTP 方法、自訂標頭與錯誤處理,也不必把資料包成函數呼叫。JSONP 主要還存在於「對方只提供 JSONP 介面」這種無法改變的情境。