本文記錄在 Visual Studio 2013 中,以 jQuery AJAX 呼叫 WCF 服務並以 JSON 傳輸資料的完整流程,同時整理過程中常遇到的問題與解法。
[DataContract]
[Table("TUser")]
public class Person {
[DataMember] public int ID { get; set; }
[DataMember] [StringLength(100)] public string LoginName { get; set; }
[DataMember] [StringLength(100)] public string Password { get; set; }
[DataMember] [DataType(DataType.Date)] public DateTime CreateDate { get; set; }
}
DataContract 標志序列化時參考 DataMember;若不加 DataContract,則所有公用屬性與欄位都會被序列化。若使用 EF 才需要 Table、StringLength、DataType 等註解。
[ServiceContract]
public interface IPersonService {
[OperationContract]
[WebInvoke(Method = "POST", RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.WrappedRequest)]
Person CreatePerson(string loginName, string password);
[OperationContract]
[WebGet(RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)]
bool CheckMan(string loginName);
}
若服務僅供 Ajax 等非 WCF 客戶端使用,可不定義介面;但為了讓程式能透過介面訪問(如前端 MVC+後端 WCF),則需使用介面。
[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Allowed)]
public class PersonService : IPersonService {
public Person CreatePerson(string loginName, string password) {
return new PersonBLL().CreatePerson(loginName, password);
}
public bool CheckMan(string loginName) {
return new PersonBLL().CheckMan(loginName);
}
}
<script type="text/javascript">
$(document).ready(function () {
$('#createPerson').click(function () {
$.ajax({
type: "post",
url: "personservice.svc/CreatePerson",
data: '{"loginName":"' + $("#loginName").val() + '","password":"' + $("#password").val() + '"}',
contentType: "application/json; charset=utf-8",
dataType: "json",
success: function (data) {
alert("ID:" + data.d.ID + " Name:" + data.d.LoginName);
},
error: function (xhr) { alert(xhr.responseText); }
});
});
$('#checkMan').click(function () {
$.getJSON("PersonService.svc/CheckMan", 'loginname="' + $("#loginName").val() + '"',
function (data) { alert(data.d); });
});
});
</script>
建議開發時採用带 error 回呼的 $.ajax 寫法,方便透過錯誤回呼檢視實際出錯原因。
右擊 WCF 專案選擇「發布」,可發布到本機 IIS。完成後可透過 https://localhost/wcf/personservice.svc 確認服務端是否部署成功,再開啟測試網頁檢查功能。
1. 請求方法寫錯(POST 寫成 GET)會導致 405 (Method Not Allowed)。
2. web.config 中 endpoint 的 contract 屬性若沒正確指向 WCF.IPersonService,會出現 500 錯誤。若服務非基於介面,則 contract 直接指向服務類即可。
3. jQuery POST 傳值格式錯誤會引發反序列化例外。正確做法有兩種:以 JSON 物件傳遞,或以 JSON 物件字串傳遞;無論哪種,鍵名稱的大小寫都必須與服務方法的形參完全一致。
4. 若需要從客戶端到服務端逐步除錯,必須使用同步呼叫,也就是把 jQuery ajax 的 async 設為 false。