Newtonsoft.Json進階用法 1.忽略某些屬性 2.預設值的處理 3.空值的處理 4.支援非公用成員 5.日期處理 6.自訂序列化的欄位名稱

標籤：

　手機端應用講究速度快，體驗好。剛好手頭上的一個專案服務端介面有效能問題，需要進行最佳化。在介面多次修改中，實體添加了很多欄位用於中間計算或者儲存，然後最終用Newtonsoft.Json進行序列化返回資料，經過分析一個簡單的列表介面每一行資料返回了16個欄位，但是手機APP端只用到了其中7個欄位，剩餘9個欄位的資料全部都是多餘的，如果介面返回資料為40K大小，也就是說大約20K的資料為無效資料，3G網路下20K下載差不多需要1s，不返回無效資料至少可以節約1s的時間，大大提高使用者體驗。本篇將為大家介紹Newtonsoft.Json的一些進階用法，可以修改很少的代碼解決上述問題。

閱讀目錄

• Newtonsoft.Json介紹
• 基本用法
• 進階用法
• 總結

回到頂部Newtonsoft.Json介紹

　　在做開發的時候，很多資料交換都是以json格式傳輸的。而使用Json的時候，我們很多時候會涉及到幾個序列化對象的使用：DataContractJsonSerializer,JavaScriptSerializer 和 Json.NET即Newtonsoft.Json。大多數人都會選擇效能以及通用性較好Json.NET，這個不是微軟的類庫，但是一個開源的世界級的Json操作類庫，從下面的效能對比就可以看到它的其中之一的效能優點。

齊全的API介紹，使用方式簡單

 

回到頂部基本用法

　　Json.Net是支援序列化和還原序列化DataTable,DataSet,Entity Framework和Entity的。下面分別舉例說明序列化和還原序列化。

DataTable：

            //序列化DataTable            DataTable dt = new DataTable();            dt.Columns.Add("Age", Type.GetType("System.Int32"));            dt.Columns.Add("Name", Type.GetType("System.String"));            dt.Columns.Add("Sex", Type.GetType("System.String"));            dt.Columns.Add("IsMarry", Type.GetType("System.Boolean"));            for (int i = 0; i < 4; i++)            {                DataRow dr = dt.NewRow();                dr["Age"] = i + 1;                dr["Name"] = "Name" + i;                dr["Sex"] = i % 2 == 0 ? "男" : "女";                dr["IsMarry"] = i % 2 > 0 ? true : false;                dt.Rows.Add(dr);            }            Console.WriteLine(JsonConvert.SerializeObject(dt));

利用上面字串進行還原序列化

 string json = JsonConvert.SerializeObject(dt); dt=JsonConvert.DeserializeObject<DataTable>(json); foreach (DataRow dr in dt.Rows) { 　　Console.WriteLine("{0}\t{1}\t{2}\t{3}\t", dr[0], dr[1], dr[2], dr[3]); }

Entity序列化和DataTable一樣，就不過多介紹了。

回到頂部進階用法

    1.忽略某些屬性

    2.預設值的處理

    3.空值的處理

    4.支援非公用成員

    5.日期處理

    6.自訂序列化的欄位名稱

 一.忽略某些屬性

　　類似本問開頭介紹的介面最佳化，實體中有些屬性不需要序列化返回，可以使用該特性。首先介紹Json.Net序列化的模式:OptOut 和 OptIn

OptOut	預設值,類中所有公有成員會被序列化,如果不想被序列化,可以用特性JsonIgnore
OptIn	預設情況下,所有的成員不會被序列化,類中的成員只有標有特性JsonProperty的才會被序列化,當類的成員很多,但用戶端僅僅需要一部分資料時,很有用

 

 

　僅需要姓名屬性

    [JsonObject(MemberSerialization.OptIn)]    public class Person    {        public int Age { get; set; }        [JsonProperty]        public string Name { get; set; }        public string Sex { get; set; }        public bool IsMarry { get; set; }        public DateTime Birthday { get; set; }    }

  不需要是否結婚屬性

    [JsonObject(MemberSerialization.OptOut)]    public class Person    {        public int Age { get; set; }        public string Name { get; set; }        public string Sex { get; set; }        [JsonIgnore]        public bool IsMarry { get; set; }        public DateTime Birthday { get; set; }    }

  通過上面的例子可以看到，要實現不返回某些屬性的需求很簡單。1.在實體類上加上[JsonObject(MemberSerialization.OptOut)] 2.在不需要返回的屬性上加上 [JsonIgnore]說明。

二.預設值處理

    序列化時想忽略預設值屬性可以通過JsonSerializerSettings.DefaultValueHandling來確定，該值為枚舉值

DefaultValueHandling.Ignore	序列化和還原序列化時,忽略預設值
DefaultValueHandling.Include	序列化和還原序列化時,包含預設值

 

 

 

 [DefaultValue(10)] public int Age { get; set; }

 Person p = new Person { Age = 10, Name = "張三丰", Sex = "男", IsMarry = false, Birthday = new DateTime(1991, 1, 2) }; JsonSerializerSettings jsetting=new JsonSerializerSettings(); jsetting.DefaultValueHandling=DefaultValueHandling.Ignore; Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

最終結果如下：

 

三.空值的處理

　　序列化時需要忽略值為NULL的屬性，可以通過JsonSerializerSettings.NullValueHandling來確定，另外通過JsonSerializerSettings設定屬性是對序列化過程中所有屬性生效的，想單獨對某一個屬性生效可以使用JsonProperty，下面將分別展示兩個方式

　　1.JsonSerializerSettings

 Person p = new Person { room=null,Age = 10, Name = "張三丰", Sex = "男", IsMarry = false, Birthday = new DateTime(1991, 1, 2) }; JsonSerializerSettings jsetting=new JsonSerializerSettings(); jsetting.NullValueHandling = NullValueHandling.Ignore; Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

   

   2.JsonProperty

通過JsonProperty屬性設定的方法，可以實現某一屬性特別處理的需求，如預設值處理，空值處理，自訂屬性名處理，格式化處理。上面空值處理實現

 [JsonProperty(NullValueHandling=NullValueHandling.Ignore)] public Room room { get; set; }

 

四.支援非公用成員

  序列化時預設都是處理公用成員，如果需要處理非公用成員，就要在該成員上加特性"JsonProperty"

 [JsonProperty] private int Height { get; set; }

 

五.日期處理

　　對於Dateime類型日期的格式化就比較麻煩了，系統內建的會格式化成iso日期標準，但是實際使用過程中大多數使用的可能是yyyy-MM-dd 或者yyyy-MM-dd HH:mm:ss兩種格式的日期，解決辦法是可以將DateTime類型改成string類型自己格式化好，然後在序列化。如果不想修改代碼，可以採用下面方案實現。

      Json.Net提供了IsoDateTimeConverter日期轉換這個類，可以通過JsnConverter實現相應的日期轉換

    [JsonConverter(typeof(IsoDateTimeConverter))]    public DateTime Birthday { get; set; }

　　但是IsoDateTimeConverter日期格式不是我們想要的，我們可以繼承該類實現自己的日期

    public class ChinaDateTimeConverter : DateTimeConverterBase    {        private static IsoDateTimeConverter dtConverter = new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd" };        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)        {            return dtConverter.ReadJson(reader, objectType, existingValue, serializer);        }        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)        {            dtConverter.WriteJson(writer, value, serializer);        }    }

    自己實現了一個yyyy-MM-dd格式化轉換類，可以看到只是初始化IsoDateTimeConverter時給的日期格式為yyyy-MM-dd即可，下面看下效果

[JsonConverter(typeof(ChinaDateTimeConverter))]public DateTime Birthday { get; set; }

   可以根據自己需求實現不同的轉換類

 

六.自訂序列化的欄位名稱

    實體中定義的屬性名稱可能不是自己想要的名稱，但是又不能更改實體定義，這個時候可以自訂序列化欄位名稱。

     [JsonProperty(PropertyName = "CName")]     public string Name { get; set; }

 

回到頂部總結

　　Newtonsoft.Json序列化庫替我們想了很多特性，也實現了很多特性，除了上面介紹的六種進階用法外，還有其它的特殊用法，可以去官網進行學習。當然這裡我目前最喜歡的特性就是那個忽略部分屬性序列化的功能，很小的代碼改動實現了介面的最佳化，提升了使用者體驗。

 

Newtonsoft.Json進階用法 1.忽略某些屬性 2.預設值的處理 3.空值的處理 4.支援非公用成員 5.日期處理 6.自訂序列化的欄位名稱