在 ASP.NET 中實作 Ajax,伺服器端可以選.aspx、.ashx,也可以用 WebService。研究 WebService 這個方式時,有幾個細節一開始沒注意,折騰了一陣子才把參數傳對。
客戶端 data 裡的 key 名稱,必須與伺服器端方法的參數名稱嚴格一致,大小寫也要相同。否則伺服器收到的會是 null 或型別轉換失敗。
客戶端:
$(document).ready(function () {
$("#btn2").click(function () {
$.ajax({
type: "POST",
contentType: "application/json", // 必須明確宣告
url: "WebService.asmx/GetWish",
data: "{value1:'心想事成',value2:'萬事如意',value3:'牛牛牛',value4:2009}",
dataType: 'json',
success: function (result) {
$('#dictionary').append(result.d);
}
});
});
});
伺服器端的參數名稱必須剛好是 value1、value2、value3、value4:
[WebMethod]
public string GetWish(string value1, string value2, string value3, int value4)
{
return string.Format("祝您在{3}年裡 {0}、{1}、{2}", value1, value2, value3, value4);
}
若要傳整個物件,客戶端要先序列化:
$(function () {
$("#btn6").click(function () {
var obj = new Object();
obj.ID = "1";
obj.Value = "aaa";
// 結果形如 {"obj":{"ID":"1","Value":"aaa"}}
var d = '{"obj":' + JSON.stringify(obj) + '}';
$.ajax({
type: "POST",
contentType: "application/json",
url: "WebService.asmx/ParmsObject",
data: d,
dataType: 'json',
success: function (result) { alert(result.d); },
error: function () { alert("fail"); }
});
});
});
伺服器端直接以自訂類別接收:
[WebMethod]
public string ParmsObject(Class1 obj)
{
return obj.ID + ":" + obj.Value;
}
測試環境為 VS2010 + jquery-1.3.2.min.js。
1. 要允許 JSON 呼叫,需在 Web.config 加上 ScriptHandlerFactory。少了這段,即使參數名稱都對,仍會收到 500 錯誤:
<webServices>
<protocols>
<add name="HttpGet"/>
<add name="HttpPost"/>
</protocols>
</webServices>
<!-- 放在 system.web 下 -->
<httpHandlers>
<add verb="POST,GET" path="*.asmx"
type="System.Web.Script.Services.ScriptHandlerFactory, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35"
validate="false" />
</httpHandlers>
2. 回應結構中有個 d。範例用 result.d 取值,這是 ASP.NET 為避免 JSON 劫持而做的包裝:WebMethod 的回傳值會被包進一個名為 d 的屬性裡。知道這件事,就不會在除錯時困惑「明明回傳了字串,為什麼拿到 undefined」。
老實說,新專案通常不需要再走這條路。ASMX WebService 屬於較早期的技術,只支援 SOAP 1.1/1.2 與它自己那套 JSON 格式,也不容易測試與版本化。若要在 ASP.NET 上提供 HTTP 介面,Web API 是更合適的選擇:路由與模型綁定更直觀,回傳格式由 ApiController 與內容協商決定,也不必依賴 result.d 這種歷史包袱。
若只是要回傳簡單資料,.ashx Generic Handler 往往就足夠,設定最少、沒有額外框架負擔。
不過如果維護的是既有系統,上面兩個細節(參數名稱一致、以及 d 包裝)加上 ScriptHandlerFactory 設定,基本就能解決絕大多數「Ajax 呼叫 WebService 拿不到資料」的問題。