先前談過 load() 方法,它適合快速抓一段靜態 HTML 塞進頁面,但這遠不是 Ajax 的全部能耐。當需要傳參數、需要處理不同格式的回應、或需要完整的錯誤控制時,就該認識 jQuery 提供的其他 Ajax 方法。
語法:$.get(url [, data] [, callback] [, type])
參數說明:
url(String):請求的頁面位址。
data(Object,可選):要送到伺服器的 key/value 資料,會作為 QueryString 附加在網址後。
callback(Function,可選):載入成功時的回呼函式,只有回應狀態為 success 才會執行,會自動接收回應內容與狀態。
type(String,可選):伺服器回傳內容的格式,可為 xml、html、script、json、text 或 _default。
兩者的結構與使用方式完全相同,差別在於請求的語意與限制:
GET 把參數接在網址後傳遞,POST 則把資料放在 HTTP 訊息的實體內容中送出。
GET 對資料量有大小限制(一般約 2KB 上下,且實際上限依瀏覽器與伺服器而異),POST 能傳送的資料量則大得多。
GET 的請求網址可能被瀏覽器快取並留在歷史紀錄中,因此不應傳送帳號、密碼等敏感資訊;POST 相對安全一些(但仍須搭配 HTTPS,POST 並不等於加密)。
兩者在伺服器端的取值方式也不同:GET 用 QueryString 取值,POST 需從表單本文讀取。
此外,GET 在語意上是「查詢」,多次請求應該得到相同結果;POST 則是「提交」,會改變伺服器狀態。瀏覽器的重新整理、預載、快取行為都建立在這個區分上,選用時應依語意而非方便性決定。
這個方法讓載入一支 js 檔變得和載入 HTML 片段一樣簡單,而且檔案會自動執行,不需額外處理。
$(function () {
$("#send").click(function () {
$.getScript("test.js");
});
});
它也支援回呼,會在檔案載入成功後執行。以下例子載入 jQuery 官方的顏色動畫插件,成功後才綁定點擊事件:
<!DOCTYPE html>
<html>
<head lang="en">
<meta charset="UTF-8">
<script type="text/javascript" src="../../js/jquery-2.1.3.js"></script>
<style>
* { margin:0; padding:0;}
body { font-size:12px; }
.block { width:80px; height:80px; background:#DDD; }
</style>
<title></title>
</head>
<body>
<button id="go">運行</button>
<div class="block"></div>
<script type="text/javascript">
$(function () {
$.getScript("jquery.color.js", function () {
$("#go").click(function () {
$(".block").animate({ backgroundColor: 'pink' }, 1000)
.animate({ backgroundColor: 'blue' }, 1000);
});
});
});
</script>
</body>
</html>
把事件綁定寫在回呼裡是關鍵:若提前綁定,使用者可能在插件尚未載入前就點擊,導致 animate 不認識顏色屬性而失效。
用法與 $.getScript() 幾乎一致,只是回傳的是 JSON 物件而非執行程式碼。
$(function () {
$('#send').click(function () {
$.getJSON('test.json', function (data) {
$('#resText').empty();
var html = '';
$.each(data, function (commentIndex, comment) {
html += '<div class="comment"><h6>' + comment['username'] +
':</h6><p class="para">' + comment['content'] + '</p></div>';
});
$('#resText').html(html);
});
});
});
對應的 test.json:
[
{ "username": "張三", "content": "沙發." },
{ "username": "李四", "content": "板凳." },
{ "username": "王五", "content": "地板." }
]
受同源政策限制,一般情況下無法用 XMLHttpRequest 向其他網域取資料。JSONP(JSON with Padding)利用「<script> 標籤不受同源政策限制」這個特性繞過限制:伺服器把資料包成一段 JavaScript 函式呼叫,由瀏覽器執行。
$(function () {
$('#send').click(function () {
$.getJSON("https://api.flickr.com/services/feeds/photos_public.gne" +
"?tags=car&tagmode=any&format=json&jsoncallback=?",
function (data) {
$.each(data.items, function (i, item) {
$("<img class='para'/>").attr("src", item.media.m).appendTo("#resText");
if (i == 3) {
return false; // 中斷 each,只取 4 張
}
});
}
);
});
});
要留意網址中的 jsoncallback=?:jQuery 會自動把最後那個問號替換成它產生的唯一函式名稱,並在資料回來後執行對應回呼。這是 JSONP 能運作的關鍵,也是為什麼 dataType 必須設為 "jsonp"。
需要評估的是,JSONP 本質上是把一段遠端程式碼放進自己的頁面執行,因此必須完全信任對方。若資料來源不可信,或串接需要驗證的 API,應改用 CORS(在伺服器端設定 Access-Control-Allow-Origin),這才是現行的標準做法。
前面幾個方法其實都是 $.ajax() 的包裝。語法為 $.ajax(options),只有一個參數,但這個物件裡可以設定所有請求細節與回呼,全部皆為可選。
url(String):發送請求的位址,預設為當前頁。
type(String):請求方式,post 或 get,預設為 get。(其他如 PUT、DELETE 也能使用,但舊版瀏覽器支援度不一。)
timeout(Number):請求逾時時間(毫秒),會覆蓋全域設定。
data(Object 或 String):要送出的資料。若不是字串會自動轉為 query string 格式;物件須為 key/value 形式,例如 {foo1:"bar1", foo2:"bar2"} 會轉成 &foo1=bar1&foo2=bar2。若值為陣列,jQuery 會產生同名的多個參數,例如 {foo:["bar1","bar2"]} 轉為 &foo=bar1&foo=bar2。
dataType(String):預期伺服器回傳的資料型別。不指定時,jQuery 會依 HTTP 回應的 MIME 型別自動判斷,可能的選項如下:
xml:回傳 XML 文件,可用 jQuery 查詢。
html:回傳純文字 HTML;其中的 script 標籤在插入 DOM 時會執行。
script:回傳純文字 JavaScript 並自動執行,結果預設不快取(除非設定 cache)。注意跨網域請求時,即使指定 POST 也會被轉為 GET。
json:回傳 JSON 並轉為物件。
jsonp:以 JSONP 形式呼叫,jQuery 自動把 callback=? 中的問號替換為正確函式名。
text:回傳純文字字串。
beforeSend(Function):送出請求前可修改 XMLHttpRequest 物件的函式,例如加上自訂標頭;在此回傳 false 可取消本次請求。
function (XMLHttpRequest) {
// this 為本次請求的 options 參數
}
complete(Function):請求完成後(不論成功或失敗)呼叫的回呼,接收 XMLHttpRequest 物件與描述狀態的字串。
function (XMLHttpRequest, textStatus) {
// this 為本次請求的 options 參數
}
success(Function):請求成功時呼叫,有兩個參數:依 dataType 處理後的資料,以及描述狀態的字串。
function (data, textStatus) {
// data 可能是 xmlDoc、jsonObj、html、text 等
// this 為本次請求的 options 參數
}
error(Function):請求失敗時呼叫,有三個參數:XMLHttpRequest 物件、錯誤資訊、以及捕獲的錯誤物件(可選)。通常 textStatus 與 errorThrown 只有其中一個帶有資訊。
function (XMLHttpRequest, textStatus, errorThrown) {
// this 為本次請求的 options 參數
}
global(Boolean):預設為 true,表示觸發全域 Ajax 事件(如 ajaxStart、ajaxStop)。設為 false 則不觸發,適合用於不想影響全域 loading 提示的個別請求。
日常開發的優先順序大致如下:只是塞一段 HTML 進頁面,用 load();單純的 GET 或 POST 且格式單純,用 $.get()/$.post();載入 JSON 用 $.getJSON();需要設定逾時、自訂標頭、或完整的錯誤處理,就用 $.ajax()。
最後補充一點:在現代專案中,原生的 fetch() 搭配 async/await 已成為主流,程式碼通常比 jQuery 的 callback 層層嵌套更清晰;但理解這些方法背後的 HTTP 語意(GET 與 POST 的差別、dataType 的意義、同源政策的限制),在任何工具下都是必要的基礎。