瀏覽器的同源政策會阻擋跨網域的 AJAX 請求,而 $.getJSON 透過 JSONP 機制繞過了這個限制。以下從最簡單的例子講到完整的跨域登記介面。
jQuery.getJSON( url, [data], [callback] )
url:發送請求的位址data:(可選)待發送的 key/value 參數callback:(可選)載入成功時的回呼函式主要用於用戶端取得伺服端的 JSON 資料。
伺服器腳本(PHP)回傳 JSON 資料:
// $.getJSON.php
$arr = array("name" => "zhangsan", "age" => 20);
$jarr = json_encode($arr);
echo $jarr;
這裡有兩個重點:第一,回傳前必須用 json_encode() 編碼;第二,輸出要用 echo 而不是 return。
用戶端程式碼:
<script language="javascript" type="text/javascript" src="./js/jquery.js"></script>
<script language="javascript" type="text/javascript">
function getjs()
{
$.getJSON("$.getJSON.php", {}, function(response){
alert(response.age);
});
}
</script>
<input type="button" name="btn" id="btn" value="test" onClick="javascript:getjs();"/>
因為 PHP 端是用 JSON 編碼回傳,所以前端必須用 getJSON 呼叫才能正確解析。可以注意到,回呼中拿到的資料已經是物件,用 response.name 與 response.age 就能直接取值。
jQuery API 文件對 $.getJSON 的說明相當簡略,很多人會卡在「後端該回傳什麼格式」。以下用一個預約登記的實例說明,需要傳入的參數為姓名、聯絡電話與地址。
後端 PHP:
/* 預約登記 執行 介面 */
case "yuyue_interface":
$name = trim($_GET['name']);
$phone = trim($_GET['phone']);
$addr = trim($_GET['addr']);
$dt = date("Y-m-d H:i:s");
$cb = $_GET['callback'];
if ($name == "" || $name == NULL) {
echo $cb."({code:".json_encode(1)."})";
} elseif ($phone == "" || $phone == NULL) {
echo $cb."({code:".json_encode(2)."})";
} elseif ($addr == "" || $addr == NULL) {
echo $cb."({code:".json_encode(3)."})";
} else {
$db->execute("insert into tb_yuyue (realname,telphone,danwei,dt,ischeck) values ('$name','$phone','$addr','$dt',0)");
echo $cb."({code:".json_encode(0)."})";
}
exit;
break;
前端處理:
$(document).ready(function(){
// 以下三個為預約登記需要的參數
var name = "name"; // varchar 型別,最長 8 位(4 個漢字)
var phone = "phone"; // varchar 型別,長度 11 位
var addr = "addr"; // varchar 型別,最長 500 位(250 個漢字)
$.getJSON("https://請求網站位址/data.php?ac=yuyue_interface&name=" + name +
"&phone=" + phone + "&addr=" + addr + "&callback=?",
function(data){
if (data.code == 1) {
// 自訂處理
alert("姓名不能為空");
} else if (data.code == 2) {
alert("手機不能為空");
} else if (data.code == 3) {
alert("所在單位不能為空");
} else {
alert("預約成功");
}
});
});
最關鍵的一點:後端必須把傳入的 callback 參數原樣輸出並包住回傳資料,例如:
$cb = $_GET['callback'];
echo $cb."({code:".json_encode(4)."})";
否則前端拿到的只是一段純文字,回呼函式不會被觸發。
JSONP 的本質是「動態插入 script 標籤」。jQuery 會產生一個隨機函式名(如 jQuery1234567_8901),替換網址中的 ?,後端回傳 jQuery1234567_8901({...}),瀏覽器執行這段 script 時就等於呼叫了該函式。因為 script 標籤不受同源政策限制,跨域就完成了。
因此有幾個限制要先知道:
如果後端可以自行設定標頭,更現代的作法是改用 CORS:在回應中加上 Access-Control-Allow-Origin,前端就能正常用 $.ajax 或 fetch 跨域存取,並支援完整的錯誤處理。另外,上面的 PHP 範例直接把 GET 參數拼進 SQL,正式環境請改用 Prepared Statement 避免 SQL Injection。