在 jQuery 中透過 Ajax 呼叫 WebService,是常見的前後端互動方式。本篇整理 GET 與 POST 兩種提交方式,並進一步說明如何提交較複雜的巢狀 JSON 資料、以及如何在伺服器端反序列化處理。
客戶端可直接使用 JSON 物件作為參數:
var data = { classCode: "0001" };
$.ajax({
type: "GET",
contentType: "application/json; charset=utf-8",
url: "/WebServices/ProductPropertyWebService.asmx/GetProductPropertyList",
dataType: "json",
anysc: false,
data: data,
success: RenderProperties,
error: function (XMLHttpRequest, textStatus, errorThrown) {
alert(errorThrown + ':' + textStatus);
}
});
伺服器端需標註 UseHttpGet = true,並從查詢字串中取值:
[ScriptMethod(ResponseFormat = ResponseFormat.Json, UseHttpGet = true)]
public List<Property> GetProductPropertyList() {
string classCode = HttpContext.Current.Request["classCode"];
return PropertyManager.GetPropertySet(classCode, "zh-CN").DataList;
}
POST 時,data 需使用拼接好的 JSON 字串,且不可為空(即使不傳參數也要寫成 "{}",否則 contentType 無法附加到 Request Headers 中):
var data = '{ classCode: "' + classCode + '", city: "GuangDong" }';
$.ajax({
type: "POST",
contentType: "application/json; charset=utf-8",
url: "/WebServices/ProductPropertyWebService.asmx/GetProductPropertyList",
dataType: "json",
anysc: false,
data: data,
success: RenderProperties,
error: function (XMLHttpRequest, textStatus, errorThrown) {
alert(errorThrown + ':' + textStatus);
}
});
伺服器端設 UseHttpGet = false,方法參數會自動對應 JSON 欄位並賦值:
[ScriptMethod(ResponseFormat = ResponseFormat.Json, UseHttpGet = false)]
public List<Property> GetProductPropertyList(string classCode, string city) {
return PropertyManager.GetPropertySet(classCode, "zh-CN").DataList;
}
重點提醒:GET 與 POST 不同,若參數值不是 ASCII 字元(例如中文),GET 的參數必須先做 encodeURI 編碼,否則伺服器接收到的會是亂碼。
簡單的 JSON 如 { name:Yangjun, age:27 };而複雜的 JSON 其實只是巢狀結構,例如 {name:yangjun, age:27, child:[{name:yangke, age:1},{name:yangbin, age:2}]}。要在 WebService 中接收並還原為 .NET 物件,可撰寫一個以 DataContractJsonSerializer 為基礎的輔助類:
public class JsonHelper {
// 序列化:把物件轉成 JSON 字串
public static string JsonSerializer<T>(T t) {
var ser = new DataContractJsonSerializer(typeof(T));
var ms = new MemoryStream();
ser.WriteObject(ms, t);
string jsonString = Encoding.UTF8.GetString(ms.ToArray());
ms.Close();
return jsonString;
}
// 反序列化:把 JSON 字串還原成物件
public static T JsonDeserialize<T>(string jsonString) {
var ser = new DataContractJsonSerializer(typeof(T));
var ms = new MemoryStream(Encoding.UTF8.GetBytes(jsonString));
return (T)ser.ReadObject(ms);
}
}
接著定義對應的資料類別,注意每個類別與欄位前的特性修飾符:
[DataContract]
public class MProductProperty {
[DataMember(Order = 0, IsRequired = true)]
public int ProductId { set; get; }
[DataMember(Order = 1, IsRequired = true)]
public List<MProperty> PropertyList { set; get; }
}
public class MProperty {
[DataMember(Order = 0, IsRequired = true)]
public int PropertyId { set; get; }
[DataMember(Order = 1, IsRequired = true)]
public string PropertyType { set; get; }
[DataMember(Order = 2, IsRequired = true)]
public string PropertyValue { set; get; }
}
最後,在接收並處理 JSON 的 Web 方法中,取出參數字串後反序列化即可直接使用:
[WebMethod]
[ScriptMethod(UseHttpGet = true)]
public string PostProductPropertyList() {
string jsonString = HttpContext.Current.Request["propertyList"];
var productProperty = JsonHelper.JsonDeserialize<MProductProperty>(jsonString);
// productProperty 已成功還原為 MProductProperty 物件
return "postsuccess";
}
透過這套「客戶端組裝 JSON → Ajax 提交 → 伺服器反序列化」的流程,即可從容處理包含巢狀結構的複雜資料交換。