前端要跟後端換資料,通常都會用到 AJAX。但實際的呼叫方式有很多種,取決於後端的形態。這裡整理目前專案裡最常出現的幾種。
先快速回顧 Web API 的四種常見動詞:GET、POST、PUT、DELETE。我平常主要用 GET 與 POST。
$.ajax({
url: "你的webapi",
type: "GET",
data: {}, // GET 通常不需要帶參數,直接讀即可
success: function (data) {
// 成功後的處理
},
error: function (data) {
alert("error");
// 別省略這個分支。發生錯誤時不知道哪裡要改,它能幫上大忙
// 實務上最常見的是 500
}
});GET 通常用於頁面初始化時,從後端撈一批資料下來填進畫面。
$.ajax({
url: "你的webapi",
type: "POST",
data: {}, // 這裡放要送給後端的資料
success: function (data) {
// 成功後的處理
},
error: function (data) {
alert("error");
}
});用法與一般 AJAX 無異,但有個關鍵一定要記得:Web API 方法上必須標上 [HttpPost],否則一律 500。
有些時候要直接 POST 到 MVC 的 Controller。雖然用表單直接提交也可以,但我還是偏好 AJAX——因為可以清楚看到錯誤發生在哪一步。
$.ajax({
url: '你的控制器/你的方法名稱',
type: 'POST',
dataType: 'json',
data: {}, // 要傳的參數
contentType: "application/json", // 明確告知送出的內容是 JSON 格式
success: function (data) {
// 成功後的返回處理
}
});這裡的 contentType: "application/json" 不是裝飾用的。一旦這樣宣告,資料就必須先用 JSON.stringify() 序列化,後端方法參數也要搭配 [FromBody],三者要對齊:
$.ajax({
url: '你的控制器/你的方法名稱',
type: 'POST',
dataType: 'json',
contentType: "application/json",
data: JSON.stringify({ id: 1, name: '小明' }),
success: function (data) { },
error: function (xhr) { console.log(xhr.status); }
});如果只傳簡單的鍵值對、不想處理序列化,把 contentType 拿掉,讓 jQuery 用預設的 application/x-www-form-urlencoded 送出,後端用一般參數接收即可,反而更省事。
最後補一個除錯習慣:把 error 分支寫完整,至少印出 xhr.status 與 textStatus。省下的是每次都要開開發者工具翻網路面板的時間。