DIV CSS 佈局教程網

jQuery 呼叫 WebService 完整流程:從後端序列化到前端解析
編輯:關於JavaScript     

用 jQuery 去呼叫 .NET 的 WebService,看起來是件小事,實際走一遍卻會踩到好幾個坑:特性沒取消註解、序列化沒加修飾、web.config 沒開放協定、回傳值多包了一層 d。這篇把整個流程從後端寫到前端完整跑一次。

步驟一:建立 WebService

 /// <summary> /// WebService1 的摘要說明 /// </summary> [WebService(Namespace = "https://tempuri.org/")] [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] [ToolboxItem(false)] // 若要允許使用 ASP.NET AJAX 從腳本中調用此 Web 服務,請取消對下行的注釋。 [System.Web.Script.Services.ScriptService] public class WebService1 : System.Web.Services.WebService { [WebMethod] public string HelloWorld() { CommonData.Json.ObjectSerialization ser = new CommonData.Json.ObjectSerialization(); Student stu = new Student(); stu.Id = 1; stu.Name = "hechen"; string json = ser.EntityToJson(stu); return json; } } 

這裡有個關鍵細節:[System.Web.Script.Services.ScriptService] 這個特性預設是被註解掉的,如果想讓 JavaScript 直接呼叫這個 WebService,一定要把它取消註解,否則前端永遠拿不到你要的結果。

另外要理解一件事:jQuery 呼叫 WebService,最外層拿到的其實是一個 XML 說明文件,而不是方法真正的回傳值。所以我們讓 WebService 方法回傳 JSON 字串,前端再自行解析,這樣處理起來乾淨得多。

步驟二:把實體物件序列化成 JSON

 /** * * 2009-5-26 * 賀 臣 * * 將某個對象轉化為Json數據格式 * */ using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; using System.Data; using System.ServiceModel.Web; using System.Runtime.Serialization; using System.Runtime.Serialization.Json; namespace CommonData.Json { public class ObjectSerialization { private object _entity; /// <summary> /// 被序列化得實體對象 /// </summary> public object Entity { get { return _entity; } set { _entity = value; } } private string _jsonData; /// <summary> /// 被轉化為json格式數據的對象 /// </summary> public string JsonData { get { return _jsonData; } set { _jsonData = value; } } /// <summary> /// 無參數構造方法 /// </summary> public ObjectSerialization() { } /// </summary> /// 有參數構造方法 /// </summary> /// <param name="entity">要被序列化得實體對象</param> public ObjectSerialization(object entity) { this._entity = entity; } /// <summary> /// 序列化實體對象 /// </summary> /// <returns></returns> public string EntityToJson() { var serializer = new DataContractJsonSerializer(Entity.GetType()); MemoryStream ms = new MemoryStream(); serializer.WriteObject(ms, Entity); byte[] myByte = new byte[ms.Length]; ms.Position = 0; ms.Read(myByte, 0, (int)ms.Length); string dataString = Encoding.UTF8.GetString(myByte); return dataString; } /// <summary> /// 序列化實體對象 /// </summary> /// <param name="entity">要被序列化得實體對象</param> /// <returns></returns> public string EntityToJson(object entity) { this._entity = entity; return EntityToJson(); } /// <summary> /// 將Json格式數據轉換為對象 /// </summary> /// <returns></returns> public T GetObjectJson<T>() { MemoryStream ms = new MemoryStream(Encoding.UTF8.GetBytes(JsonData)); var serializer = new DataContractJsonSerializer(typeof(T)); T t = (T)serializer.ReadObject(ms); return t; } /// <summary> /// 將Json格式數據轉換為對象 /// </summary> /// <param name="jsonData">json數據格式</param> /// <returns></returns> public T GetObjectJson<T>(string jsonData) { this._jsonData = jsonData; return GetObjectJson<T>(); } } } 

這裡最容易漏的一點:要被序列化的實體類別必須加上可序列化特性(例如 [Serializable]),否則 DataContractJsonSerializer 沒辦法把它轉成 JSON 字串。

步驟三:前端用 jQuery 發請求

 <script src="jquery-1[1].2.3.min.js" type="text/javascript"></script> <script src="json2.js" type="text/javascript"></script> <script type="text/javascript"> $(document).ready(function() { $("#btnClick").click(function() { $.ajax({ url:"https://localhost:10168/WebService1.asmx/HelloWorld", beforeSend: function(x) { x.setRequestHeader("Content-Type", "application/json; charset=utf-8"); }, data:{}, dataType:"json", type:"POST", error: function(x, e) { alert(x.responseText); }, complete: function(x) { //alert(x.responseText); } , success:function(data){ var msg=data.d; var json=JSON2.parse(msg); alert(json.id); } }); }); }); </script>

這裡需要 jQuery 本體加上一個 json2.js。幾個要點:

url 的格式是「服務位址 + 方法名」,這裡的 HelloWorld 就是 WebService 裡的方法。

要用 POST,並在 beforeSend 裡把 Content-Type 設成 application/json; charset=utf-8,同時 dataType 設為 json。

回傳值多包了一層。ASP.NET 會把結果包進一個名為 d 的屬性裡,所以要寫 var msg = data.d; 才拿得到真正的內容。

而 data.d 拿到的還是一個 JSON 字串,沒辦法直接用 . 取值。這時候就要靠 json2.js 的 JSON2.parse() 把它轉成物件,之後才能 json.id 這樣存取。

如果要呼叫帶參數的方法,在 data 裡指定即可,參數名稱必須和 WebService 方法的參數名完全一致。

步驟四:別忘了改 web.config

我寫這個範例時卡最久的就是這一步。預設情況下,.NET 為了安全,不允許用 URL 直接觸發 WebService 方法,必須手動開放 Get/Post 協定。在 System.web 節點下加入:

 <webServices> <protocols> <add name="HttpGet"/> <add name="HttpPost"/> </protocols> </webServices>

改完這段,整個鏈路就通了。回顧一下四個必查項:ScriptService 特性有沒有取消註解、實體有沒有加 Serializable、web.config 有沒有開放協定、前端取值有沒有記得 data.d。這四點任意一處漏掉,都會表現成「請求成功但拿不到資料」的假象。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved