使用Json.NET來序列化所需的資料

我們在做開發的時候，很多時候需要和Json資料格式打交道，如Web開發裡面，很多時候，資料通過Json進行傳遞到頁面上，然後在進行處理的。而使用Json的時候，我們很多時候會涉及到幾個序列化對象的使用：DataContractJsonSerializer,JavaScriptSerializer 和 Json.NET。大多數人都會選擇效能以及通用性較好Json.NET，這個不是微軟的類庫，但是一個開源的世界級的Json操作類庫，從下面的效能對比就可以看到它的其中之一的效能優點。   Json.NET能很好序列化或者還原序列化.NET的各種類型資料，而且它的另一個優點，是可以配置Attribute屬性，指定輸出的屬性的名稱或者是否輸出，這點我非常喜歡。 JSON(JavaScript Object Notation,JavaScript對象標記法)是一種輕量級的資料交換格式。JSON是“名值對”的集合。結構由大括弧'{}'，中括弧'[]'，逗號'，'，冒號'：'，雙引號'“”'組成，包含的資料類型有Object，Number,Boolean,String,Array, NULL等。 1、在Web中使用Json資料  在我的基於MVC+EasyUI的Web開發架構中，Web介面層大量使用了Ajax方式擷取所需資料，然後綁定到樹清單控制項或者其他介面控制項裡面，在前面的一些Web架構隨筆系列裡面，我介紹過很多Json格式的操作。 1）基於MVC4+EasyUI的Web開發架構經驗總結（3）- 使用Json實體類構建菜單資料 2）基於MVC4+EasyUI的Web開發架構經驗總結（2）- 使用EasyUI的樹控制項構建Web介面 如在MVC的視圖裡面，通過Web請求的Json資料後初始化樹控制項的代碼如下所示 複製代碼    //初始化組織機構列表    function initDeptTreeview() {        $("#loading").show();         $('#treeDept').tree({            url: '/User/GetMyDeptTreeJson?userId=@Session["UserId"]',            onClick: function (node) {                loadDataByOu(node.id);            }          });         $("#loading").fadeOut(500);    }複製代碼或者使用者角色的初始化介面代碼                 $('#lbxRoles').empty();                $.getJSON("/Role/GetRolesByUser?r=" + Math.random() + "&userid=" + info.ID, function (json) {                    $.each(json, function (i, item) {                        $('#lbxRoles').append('<option value="' + item.ID + '">' + item.Name + '</option>');                    });                });  前面說過，Json.NET具有屬性配置功能，可以指定某個屬性是否輸出，或者輸出的名稱轉義等。預設情況下,Json.Net序列化後結果中的欄位名稱和類中屬性的名稱一致，如果想自訂序列化後的欄位名稱，可以使用JsonProperty。 我們知道，EasyUI的Tree控制項裡面，它的資料格式，除了一個id和text是必須的之外，它的很多屬性是可選的，也就是說在Json裡面，可以不輸出某個屬性的內容。這個通過配置 [JsonProperty( NullValueHandling = NullValueHandling.Ignore)]就可以忽略某個屬性的輸出了，如果這個屬性的值為null的話。 樹控制項的資料還有一個checked屬性， 如果沒有轉義功能，我們需要指定屬性為checked， 而checked是C#裡面的保留關鍵字，不能使用，那麼就沒辦法了。而Json.NET提供了轉義功能的配置Attribute，很好解決問題，如下所示。         [JsonProperty(PropertyName = "checked", NullValueHandling = NullValueHandling.Ignore)]        public bool? Checked { get; set; }因此整個EasyUI的Tree資料對象資訊，在C#裡面可以定義為如下所示(這裡可以忽略DataContract、DataMember的定義）。 複製代碼    /// <summary>    /// 定義EasyUI樹的相關資料，方便控制器產生Json資料進行傳遞    /// </summary>    [DataContract]    [Serializable]    public class EasyTreeData    {        /// <summary>        /// ID        /// </summary>        [DataMember]        public string id { get; set; }         /// <summary>        /// 節點名稱        /// </summary>        [DataMember]        public string text { get; set; }                /// <summary>        /// 是否展開        /// </summary>        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]        [DataMember]        public string state  { get; set; }         /// <summary>        /// 表徵圖樣式        /// </summary>        [DataMember]        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]public string iconCls { get; set; }         [JsonProperty(PropertyName = "checked", NullValueHandling = NullValueHandling.Ignore)]        [DataMember(Name="checked")]        public bool? Checked { get; set; }          /// <summary>        /// 子節點集合        /// </summary>        [DataMember]        public List<EasyTreeData> children { get; set; }複製代碼使用上的實體類，並使用Json.NET來序列化我們的資料，我們可能得到下面的Json資料。 複製代碼[ {    id: "-1",    text: "無",    state: "open",    checked: true,    children: [ ]  }, {    id: "6",    text: "總經辦",    state: "open",    iconCls: "icon-group",    children: [ ] }]複製代碼我們從上面的Json資料可以看到，Checked屬性順利轉換為checked的名稱屬性，標記為[JsonProperty(NullValueHandling = NullValueHandling.Ignore)] ，而值為null的屬性，將不會出現在Json的字串裡面了。 這個在某種情形下，正好就是我們所需要的。  2、在介面開發中使用Json API的介面，大量使用了Json資料，不僅很多返回的資料是使用Json表達，而且其Post的資料，也多數使用Json資料格式，如在我的前兩篇隨筆《C#開發門戶及應用(5)--使用者分組資訊管理》 、《C#開發門戶及應用(4)--關注使用者列表及詳細資料管理》 裡面介紹的內容，的很多介面都使用了Json資料。 如返回粉絲列表的Json資料，就是如下所示。 {"total":2,"count":2,"data":{"openid":["","OPENID1","OPENID2"]},"next_openid":"NEXT_OPENID"}建立使用者分組，返回的資料格式如下，同樣也是Json資料。 {    "group": {        "id": 107,         "name": "test"    }}通過下面基於Json.NET的Json資料的轉換，就可以順利從Json字串轉換為相應的實體物件了。 複製代碼    /// <summary>    /// Json字串操作輔助類    /// </summary>    public class JsonHelper<T> where T : class, new()    {        /// <summary>        /// 檢查返回的記錄，如果返回沒有錯誤，或者結果提示成功，則不拋出異常        /// </summary>        /// <param name="content">返回的結果</param>        /// <returns></returns>        private static bool VerifyErrorCode(string content)        {            if (content.Contains("errcode"))            {                ErrorJsonResult errorResult = JsonConvert.DeserializeObject<ErrorJsonResult>(content);                //非成功操作才記錄異常，因為有些操作是返回正常的結果（{"errcode": 0, "errmsg": "ok"}）                if (errorResult != null && errorResult.errcode != ReturnCode.請求成功)                {                    string error = string.Format("請求發生錯誤！錯誤碼：{0}，說明：{1}", (int)errorResult.errcode, errorResult.errmsg);                    LogTextHelper.Error(errorResult);                     throw new WeixinException(error);//拋出錯誤                }            }            return true;        }         /// <summary>        /// 轉換Json字串到具體的對象        /// </summary>        /// <param name="url">返回Json資料的連結地址</param>        /// <returns></returns>        public static T ConvertJson(string url)        {            HttpHelper helper = new HttpHelper();            string content = helper.GetHtml(url);            VerifyErrorCode(content);             T result = JsonConvert.DeserializeObject<T>(content);            return result;        }}複製代碼而如果要把對象轉換為Json字串格式的資料，那麼代碼也很簡單。 JsonConvert.SerializeObject(obj, Formatting.Indented);