DIV CSS 佈局教程網

jQuery $.getJSON 抓取遠端 JSON 的常見坑與跨域做法
編輯:關於JavaScript     

$.getJSON 是 jQuery 裡最省事的取資料方法:把遠端回傳的 JSON 字串直接轉成物件,成功後執行回呼。但很多人第一次用都會卡在「怎麼抓不到」,而原因往往不在前端,而是伺服器吐出來的格式不合規。

一個抓不到值的最小案例

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="https://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>無標題文檔</title>
</head>
<script type="text/javascript" src="jquery-1.7.2.min.js"></script>
<script type="text/javascript">
$(function(){
  $("button").click(function(){
    $.getJSON("ajax6.asp", function(data){
      $("#pig").html(data.name);
    });
  });
});
</script>
<body>
<button>click</button>
<div id="pig"></div>
</body>
</html>

而 ajax6.asp 寫成:

<%
response.Write("{name:'peter',age:18}");
%>

問題就在這裡:JSON 規格要求 key 與字串值都必須使用雙引號,單引號不是合法 JSON,jQuery 內部的解析器自然會失敗,回呼也就不會執行。正確的輸出應該是:

response.Write("{""name"":""peter"",""age"":""18""}");

另外還有一個隱形陷阱:Content-Type 最好明確標成 application/json,並把頁面編碼對齊(例如 UTF-8),否則中文值容易變亂碼而導致解析異常。

getJSON 的簽名

jQuery.getJSON( url [, data] [, callback] )
  • url:請求位址。
  • data(選填):要送出的 key/value 參數。
  • callback(選填):載入成功後的回呼函式。

搭配 PHP 的標準寫法

伺服器端要先編碼,再用 echo 輸出(不是 return):

// $.getJSON.php
$arr = array("name" => "zhangsan", "age" => 20);
$jarr = json_encode($arr);
echo $jarr;

前端:

<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();"/>

因為伺服器已經用 json_encode 編碼,前端就必須用 getJSON 對應。回傳後資料已是物件,用 response.name、response.age 就能直接取值。

跨域請求:JSONP 模式

$.getJSON 之所以能跨域,靠的是 JSONP——把請求包成 <script>,由伺服器回傳一段「呼叫你指定函式」的程式碼。所以後端必須把前端傳來的 callback 名稱原樣吐回去。以下是一個預約登記介面的例子:

/* 預約登記 執行 接口 */
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;

前端只要把 callback 參數寫成 callback=?,jQuery 就會自動產生並替換成隨機函式名:

$(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)."})";

這支小實驗同時示範了兩件事:怎麼用 $.getJSON,以及怎麼寫一個能被別人跨域呼叫的介面。實務上要留意三點安全問題——SQL 那串字串拼接應改成參數化查詢以免注入;JSONP 本質上執行了任意回呼名稱,只該用在可信來源;跨域介面記得做來源與頻率限制。今天若是新專案,改用標準 fetch 搭配 CORS 標頭會比 JSONP 更乾淨。

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