以前寫 Ajax,通常得搭配一般處理常式(.ashx)或 Web 服務(.asmx),而且每支請求都要開一個新檔案。請求一多,專案裡就堆滿一堆 ashx,翻起來很痛苦。
其實改用 WebMethod,就能把多支請求集中到同一個頁面裡管理,整件事會清爽很多。
首先要引用命名空間:
using System.Web.Services;
實務上我習慣另外開一個專門放 WebMethod 的頁面,請求分類清楚、也方便維護。若請求數量龐大,就按頁面主題再拆幾個。
方法本身有兩個硬性要求:必須是 public static,而且一定要掛上 [WebMethod] 屬性。
/// <summary>
/// 根據任務 ID 取得任務名稱、完成狀態與數量
/// </summary>
/// <param name="id">任務 ID</param>
/// <returns></returns>
[WebMethod]
public static string GetMissionInfoById(int id)
{
CommonService commonService = new CommonService();
DataTable table = commonService.GetSysMissionById(id);
// .....
return "false";
}
如果方法裡需要操作 Session,得再多帶一個參數打開它:
[WebMethod(EnableSession = true)] // 也可以寫成 [WebMethod(true)]
public static string GetMissionInfoById(int id)
{
CommonService commonService = new CommonService();
DataTable table = commonService.GetSysMissionById(id);
// .....
return "false";
}
$.ajax({
type: "POST",
contentType: "application/json",
url: "WebMethodAjax.aspx/GetMissionInfoById",
data: "{id:12}",
dataType: "json",
success: function() {
// 請求成功後的回呼處理
},
error: function() {
// 請求失敗時的回呼處理
}
});
type:只能是 POST。WebMethod 不接受其他請求類型。
contentType:固定為 application/json。
url:格式是「檔名(含副檔名)/方法名」。
data:必須是 JSON 格式的字串,例如 "{aa:11,bb:22,cc:33}"。這一點最容易出錯——如果你傳的是物件而非字串,jQuery 會把它序列化,伺服器端收到的就不再是 JSON 了。另外即使沒有參數也要寫成 "{}",不能留空。很多人卡住就是卡在這裡。
dataType:只能是 json。WebMethod 固定回傳 {"d":"......."} 這種包了一層 d 的結構,取值時記得先取 .d。
success:成功後的回呼,可以在這裡對 data.d 做任意處理。
既然有幾個參數是固定的,不妨給 jQuery 做個擴充。新增一支 jquery.extend.js:
///<summary>
/// jQuery 原型擴充,重新封裝 Ajax 請求 WebService
///</summary>
///<param name="url" type="String">處理請求的位址</param>
///<param name="dataMap" type="String">參數,JSON 格式的字串</param>
///<param name="fnSuccess" type="Function">請求成功後的回呼函數</param>
$.ajaxWebService = function(url, dataMap, fnSuccess) {
$.ajax({
type: "POST",
contentType: "application/json",
url: url,
data: dataMap,
dataType: "json",
success: fnSuccess
});
}
之後呼叫就只剩一行:
$.ajaxWebService("WebMethodAjax.aspx/GetMissionInfoById", "{id:12}", function(result) {
// ......
});
這個方法對 *.asmx 一樣有效,因為 WebMethod 本質上就是 WebService。
以下這個版本是先前跟一位前輩共事時看到的,用同步方式把結果直接回傳,寫起來很像呼叫本地函式。建立一支 CommonAjax.js:
function json2str(o) {
var arr = [];
var fmt = function(s) {
if (typeof s == 'object' && s != null) return json2str(s);
return /^(string|number)$/.test(typeof s) ? "'" + s + "'" : s;
};
for (var i in o) arr.push("'" + i + "':" + fmt(o[i]));
return '{' + arr.join(',') + '}';
}
function Invoke(url, param) {
var result;
$.ajax({
type: "POST",
url: url,
async: false,
data: json2str(param),
contentType: "application/json; charset=utf-8",
dataType: "json",
success: function(msg) {
result = msg.d;
},
error: function(r, s, e) {
throw new Error();
}
});
return result;
}
呼叫端就變得很直觀:
var result = Invoke("WebMethodAjax.aspx/GetMissionInfoById", {
"name": arguments.Value,
"id": id
});
不過這種寫法有兩個必須注意的規則:JSON 的 key 名稱要和 WebMethod 的形參完全一致,而且參數順序不能亂,否則一樣會請求失敗。
例如後端方法簽名是:
[WebMethod]
public static string GetMissionInfoById(int Id, string name)
{
// .....
return "false";
}
那前端就得照這個順序傳:
{"Id":23,"name":"study"}
另外提醒一下,async: false 會凍結整個瀏覽器 UI 直到請求回來,畫面體驗很差。除非有特殊需求,否則建議還是走非同步,把結果處理寫在 success 回呼裡。