ASP.NET中定義JavaScriptConverter
有時候在Web Service中會需要使用到比較復雜的類型，它們的特征往往都是含用循環引用，這樣的對象如果交給ASP.NET AJAX中默認的序列化方式來處理則會拋出異常，大家經常遇到的“DataTable”問題正是由此引起的。關于這一點，ASP.NET AJAX自然提供了解決方法，在這里“官方”的解決方案就是JavaScriptConverter，它可以讓開發人員自定義特定類型的序列化能力。
事實上，需要自定義JavaScriptConverter的類型不止“含有循環引用”的類型，事實上，JavaScriptConverter的目標是“ASP.NET AJAX中無法操作，或者結果不是開發人員所期望那樣”的類型，這里的“操作”包括“序列化”于“反序列化”兩部分。再舉個例子：如果一個類型沒有無參數的構造函數，那么也需要定義JavaScriptConverter，否則ASP.NET AJAX無法對其進行反序列化操作。
那么我們就通過一個簡單的例子來看一下應該如何開發和使用JavaScriptConverter吧。
1、定義存在循環引用的類型
首先我們定義一個Boy類和Girl類以供使用：
- public class Boy
- {
- public string Name;
- public Girl GirlFriend;
- }
- public class Girl
- {
- public string Name;
- public Boy BoyFriend;
- }
很顯然，如果我將它們“配成一對”，在序列化輸出時就會拋出異常了。就沖著這點，我們就必須定義一個JavaScriptConverter啊，總不能拆散他倆。
2、定義JavaScriptConverter以及序列化能力
我們下面就該開始定義JavaScriptConverter了，我們姑且將其稱之為BoyConverter。首先需要告訴ASP.NET，我們這個Converter可以支持哪些類型：
- public class BoyConverter : JavaScriptConverter
- {
- public override IEnumerable<Type> SupportedTypes
- {
- get
- {
- yield return typeof(Boy);
- }
- }
- ……
- }
如果要實現一個比較良好的Serialize方法，就需要處理“有循環引用”和“沒有循環引用”兩種情況。幸運的是，對于Serialize方法來說，這點比較容易：
- public override IDictionary<string, object> Serialize(object obj,
JavaScriptSerializer serializer)- {
- IDictionary<string, object> result = new Dictionary<string, object>();
- Boy boy = (Boy)obj;
- result["Name"] = boy.Name;
- // 如果有GirlFriend引用
- if (boy.GirlFriend != null)
- {
- // 摘除循環引用
- boy.GirlFriend.BoyFriend = null;
- result["GirlFriend"] = boy.GirlFriend;
- // 在客戶端再建立關聯
- result["__getRealObject"] =
- "function(o) { oo.GirlFriend.BoyFriend = o; return o; }";
- }
- return result;
- }
在這里，我們“手動”地將Boy對象轉換為了一個IDictionary<string, objct>，這樣就避免出現了循環引用。另外，為了在客戶端直接得到一個互相引用的“Boy”和“Girl”對象，我在這里使用了我在前一片文章中提到的擴展，具體請見《深入Atlas系列：綜合示例（1） - 調用服務器端方法時直接獲得客戶端具體類型》。
3、自定義序列化功能使用示例
那么我們來看一下使用示例吧，首先我們需要定義一個Web Service方法：
- [WebService(Namespace = "http://tempuri.org/")]
- [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
- [Microsoft.Web.Script.Services.ScriptService]
- public class BoyGirlService : System.Web.Services.WebService {
- [WebMethod]
- public Boy GetBoy(string boyName, string girlName)
- {
- Boy boy = new Boy();
- boy.Name = boyName;
- if (!String.IsNullOrEmpty(girlName))
- {
- Girl girl = new Girl();
- girl.Name = girlName;
- girl.BoyFriend = boy;
- boy.GirlFriend = girl;
- }
- return boy;
- }
- }
以上介紹在ASP.NET中定義JavaScriptConverter
【編輯推薦】
