Newtonsoft.Json 你必須知道的一些用法
最近在做介面開發，對方團隊開發了一個Web API 的介面，傳輸資料的格式是 JSON。當時看到這個東西，感覺很簡單，也沒想什麼，沒用多久就完成了我的功能，我完成的功能很簡單，就是獲取資料，然後把資料列表進行 JSON 序列化，然後再以 POST 方式呼叫對方 Web Api 的介面，將 JSON 的資料一起傳遞過去，我想的很簡單，直接呼叫並返回結果就完成了。最後對方介面返回錯誤，提示從 傳遞過去的 JSON 資料中的第一個欄位開始就取不到值。
鬱悶，為什麼呢？我的引數也是按著他們介面的規範寫的，資料獲取也沒錯，JSON 格式化的資料好像也正常，對方團隊的 Api 介面為什麼提示取不到值。後來，靜下心來，仔細看了看我的專案，應該沒啥大問題。突然，好像感覺找到了原因，但是感覺不應該是這個問題，那就是我傳遞的 JSON 資料的 Key 值的名稱採用的是 Pascal 命名法，就是每個單詞的首字元都是大寫的（{“BoyFirend”:“xxx”,"HomeAddress":"xxxx"}），而對方的 Key 的命名法是 Camel 命名法（比如：{“boyFirend”:“xxx”,"homeAddress":"xxxx"}）。之所以產生這個結果，因為 JSON 資料是直接通過 C#的實體類序列化而來的，在 C# 中的實體類的每個屬性的命名就是採用的是 Pascal 命名方法。找到了原因，但是不太確定，然後一試，還這是這樣原因。
原因找到了，解決問題就簡單了，對方團隊寫的 Api 介面個人感覺相容不好，不應該對大小寫敏感，讓介面更通用一點才好，我建議對方改一下介面，對方好像不怎麼同意，那我只能修改我的介面了。說到 JSON 序列化，我使用的是 Newtonsoft.Json，這個東東，大家應該很熟悉吧。由於對它研究不深，就上網找了一下子，不錯，還真有解決辦法，那我也收藏一下，便於以後查閱。
一、Newtonsoft.Json介紹
做 Web 開發的，沒有接觸過 JavaScript 的肯定很少。現在的很多是分散式開發，分散式系統，分散式系統有時候就會涉及到資料的傳輸，JSON在資料傳輸和提交有著天生的優勢。而使用Json的時候，我們很多時候會涉及到幾個序列化物件的使用：DataContractJsonSerializer,JavaScriptSerializer 和 Json.NET即Newtonsoft.Json。大多數人都會選擇效能以及通用性較好Json.NET，這個不是微軟的類庫，但是一個開源的世界級的Json操作類庫，從下面的效能對比就可以看到它的其中之一的效能優點。
二、基本用法
Json.Net是支援序列化和反序列化DataTable,DataSet,Entity Framework和Entity的。下面分別舉例說明序列化和反序列化。
DataTable：
1 //序列化DataTable 2 DataTable dt = new DataTable(); 3 dt.Columns.Add("Age", Type.GetType("System.Int32")); 4 dt.Columns.Add("Name", Type.GetType("System.String")); 5 dt.Columns.Add("Sex", Type.GetType("System.String")); 6 dt.Columns.Add("IsMarry", Type.GetType("System.Boolean")); 7 for (int i = 0; i < 4; i++) 8 { 9 DataRow dr = dt.NewRow(); 10 dr["Age"] = i + 1; 11 dr["Name"] = "Name" + i; 12 dr["Sex"] = i % 2 == 0 ? "男" : "女"; 13 dr["IsMarry"] = i % 2 > 0 ? true : false; 14 dt.Rows.Add(dr); 15 } 16 Console.WriteLine(JsonConvert.SerializeObject(dt));
利用上面字串進行反序列化
1 string json = JsonConvert.SerializeObject(dt); 2 dt=JsonConvert.DeserializeObject<DataTable>(json); 3 foreach (DataRow dr in dt.Rows) 4 { 5 Console.WriteLine("{0}\t{1}\t{2}\t{3}\t", dr[0], dr[1], dr[2], dr[3]); 6 }
Entity序列化和DataTable一樣，就不過多介紹了。
三、高階用法
1.忽略某些屬性
2.預設值的處理
3.空值的處理
4.支援非公共成員
5.日期處理
6.自定義序列化的欄位名稱
7.動態決定屬性是否序列化
8.列舉值的自定義格式化問題
9.自定義型別轉換
10.全域性序列化設定
1.忽略某些屬性
類似本問開頭介紹的介面優化，實體中有些屬性不需要序列化返回，可以使用該特性。首先介紹Json.Net序列化的模式:OptOut 和 OptIn
| OptOut | 預設值,類中所有公有成員會被序列化,如果不想被序列化,可以用特性JsonIgnore |
| OptIn | 預設情況下,所有的成員不會被序列化,類中的成員只有標有特性JsonProperty的才會被序列化,當類的成員很多,但客戶端僅僅需要一部分資料時,很有用 |
僅需要姓名屬性
1 [JsonObject(MemberSerialization.OptIn)] 2 public class Person 3 { 4 public int Age { get; set; } 5 6 [JsonProperty] 7 public string Name { get; set; } 8 9 public string Sex { get; set; } 10 11 public bool IsMarry { get; set; } 12 13 public DateTime Birthday { get; set; } 14 }
不需要是否結婚屬性
1 [JsonObject(MemberSerialization.OptOut)] 2 public class Person 3 { 4 public int Age { get; set; } 5 6 public string Name { get; set; } 7 8 public string Sex { get; set; } 9 10 [JsonIgnore] 11 public bool IsMarry { get; set; } 12 13 public DateTime Birthday { get; set; } 14 }
通過上面的例子可以看到，要實現不返回某些屬性的需求很簡單。1.在實體類上加上[JsonObject(MemberSerialization.OptOut)] 2.在不需要返回的屬性上加上 [JsonIgnore]說明。
2.預設值處理
序列化時想忽略預設值屬性可以通過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));
最終結果如下：
3.空值的處理
序列化時需要忽略值為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; }
4.支援非公共成員
序列化時預設都是處理公共成員，如果需要處理非公共成員，就要在該成員上加特性"JsonProperty"
[JsonProperty]
private int Height { get; set; }
5.日期處理
對於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日期格式不是我們想要的，我們可以繼承該類實現自己的日期
1 public class ChinaDateTimeConverter : DateTimeConverterBase 2 { 3 private static IsoDateTimeConverter dtConverter = new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd" }; 4 5 public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) 6 { 7 return dtConverter.ReadJson(reader, objectType, existingValue, serializer); 8 } 9 10 public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) 11 { 12 dtConverter.WriteJson(writer, value, serializer); 13 } 14 }
自己實現了一個yyyy-MM-dd格式化轉換類，可以看到只是初始化IsoDateTimeConverter時給的日期格式為yyyy-MM-dd即可，下面看下效果
[JsonConverter(typeof(ChinaDateTimeConverter))]
public DateTime Birthday { get; set; }
可以根據自己需求實現不同的轉換類
6.自定義序列化的欄位名稱
實體中定義的屬性名可能不是自己想要的名稱，但是又不能更改實體定義，這個時候可以自定義序列化欄位名稱。
[JsonProperty(PropertyName = "CName")]
public string Name { get; set; }
7.動態決定屬性是否序列化
這個是為了實現@米粒兒提的需求特別增加的，根據某些場景，可能A場景輸出A，B，C三個屬性，B場景輸出E，F屬性。雖然實際中不一定存在這種需求，但是json.net依然可以支援該特性。
繼承預設的DefaultContractResolver類，傳入需要輸出的屬性
重寫修改了一下，大多數情況下應該是要排除的欄位少於要保留的欄位, 為了方便書寫這裡修改了建構函式加入retain表示props是需要保留的欄位還是要排除的欄位
1 public class LimitPropsContractResolver : DefaultContractResolver 2 { 3 string[] props = null; 4 5 bool retain; 6 7 /// <summary> 8 /// 建構函式 9 /// </summary> 10 /// <param name="props">傳入的屬性陣列</param> 11 /// <param name="retain">true:表示props是需要保留的欄位 false：表示props是要排除的欄位</param> 12 public LimitPropsContractResolver(string[] props, bool retain=true) 13 { 14 //指定要序列化屬性的清單 15 this.props = props; 16 17 this.retain = retain; 18 } 19 20 protected override IList<JsonProperty> CreateProperties(Type type, 21 22 MemberSerialization memberSerialization) 23 { 24 IList<JsonProperty> list = 25 base.CreateProperties(type, memberSerialization); 26 //只保留清單有列出的屬性 27 return list.Where(p => { 28 if (retain) 29 { 30 return props.Contains(p.PropertyName); 31 } 32 else 33 { 34 return !props.Contains(p.PropertyName); 35 } 36 }).ToList(); 37 }
public string Sex { get; set; }
JsonSerializerSettings jsetting=new JsonSerializerSettings();
jsetting.ContractResolver = new LimitPropsContractResolver(new string[] { "Age", "IsMarry" }); Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));
使用自定義的解析類，只輸出"Age", "IsMarry"兩個屬性，看下最終結果.只輸出了Age屬性，為什麼IsMarry屬性沒有輸出呢，因為標註了JsonIgnore
看到上面的結果想要實現pc端序列化一部分，手機端序列化另一部分就很簡單了吧，我們改下程式碼實現一下
1 string[] propNames = null; 2 if (p.Age > 10) 3 { 4 propNames = new string[] { "Age", "IsMarry" }; 5 } 6 else 7 { 8 propNames = new string[] { "Age", "Sex" }; 9 } 10 jsetting.ContractResolver = new LimitPropsContractResolver(propNames); 11 Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));
8.列舉值的自定義格式化問題
預設情況下對於實體裡面的列舉型別系統是格式化成改列舉對應的整型數值,那如果需要格式化成列舉對應的字元怎麼處理呢？Newtonsoft.Json也幫我們想到了這點，下面看例項
1 public enum NotifyType 2 { 3 /// <summary> 4 /// Emil傳送 5 /// </summary> 6 Mail=0, 7 8 /// <summary> 9 /// 簡訊傳送 10 /// </summary> 11 SMS=1 12 } 13 14 public class TestEnmu 15 { 16 /// <summary> 17 /// 訊息傳送型別 18 /// </summary> 19 public NotifyType Type { get; set; } 20 } 21 JsonConvert.SerializeObject(new TestEnmu());
輸出結果：
現在改造一下，輸出"Type":"Mail"
1 public class TestEnmu 2 { 3 /// <summary> 4 /// 訊息傳送型別 5 /// </summary> 6 [JsonConverter(typeof(StringEnumConverter))] 7 public NotifyType Type { get; set; } 8 }
其它的都不變，在Type屬性上加上了JsonConverter(typeof(StringEnumConverter))表示將列舉值轉換成對應的字串,而StringEnumConverter是Newtonsoft.Json內建的轉換型別,最終輸出結果
9.自定義型別轉換
預設情況下對於實體裡面的Boolean系統是格式化成true或者false,對於true轉成"是" false轉成"否"這種需求改怎麼實現了？我們可以自定義型別轉換實現該需求，下面看例項
1 public class BoolConvert : JsonConverter 2 { 3 private string[] arrBString { get; set; } 4 5 public BoolConvert() 6 { 7 arrBString = "是,否".Split(','); 8 } 9 10 /// <summary> 11 /// 建構函式 12 /// </summary> 13 /// <param name="BooleanString">將bool值轉換成的字串值</param> 14 public BoolConvert(string BooleanString) 15 { 16 if (string.IsNullOrEmpty(BooleanString)) 17 { 18 throw new ArgumentNullException(); 19 } 20 arrBString = BooleanString.Split(','); 21 if (arrBString.Length != 2) 22 { 23 throw new ArgumentException("BooleanString格式不符合規定"); 24 } 25 } 26 27 28 public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) 29 { 30 bool isNullable = IsNullableType(objectType); 31 Type t = isNullable ? Nullable.GetUnderlyingType(objectType) : objectType; 32 33 if (reader.TokenType == JsonToken.Null) 34 { 35 if (!IsNullableType(objectType)) 36 { 37 throw new Exception(string.Format("不能轉換null value to {0}.", objectType)); 38 } 39 40 return null; 41 } 42 43 try 44 { 45 if (reader.TokenType == JsonToken.String) 46 { 47 string boolText = reader.Value.ToString(); 48 if (boolText.Equals(arrBString[0], StringComparison.OrdinalIgnoreCase)) 49 { 50 return true; 51 } 52 else if (boolText.Equals(arrBString[1], StringComparison.OrdinalIgnoreCase)) 53 { 54 return false; 55 } 56 } 57 58 if (reader.TokenType == JsonToken.Integer) 59 { 60 //數值 61 return Convert.ToInt32(reader.Value) == 1; 62 } 63 } 64 catch (Exception ex) 65 { 66 throw new Exception(string.Format("Error converting value {0} to type '{1}'", reader.Value, objectType)); 67 } 68 throw new Exception(string.Format("Unexpected token {0} when parsing enum", reader.TokenType)); 69 } 70 71 /// <summary> 72 /// 判斷是否為Bool型別 73 /// </summary> 74 /// <param name="objectType">型別</param> 75 /// <returns>為bool型別則可以進行轉換</returns> 76 public override bool CanConvert(Type objectType) 77 { 78 return true; 79 } 80 81 82 public bool IsNullableType(Type t) 83 { 84 if (t == null) 85 { 86 throw new ArgumentNullException("t"); 87 } 88 return (t.BaseType.FullName=="System.ValueType" && t.GetGenericTypeDefinition() == typeof(Nullable<>)); 89 } 90 91 public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) 92 { 93 if (value == null) 94 { 95 writer.WriteNull(); 96 return; 97 } 98 99 bool bValue = (bool)value; 100 101 if (bValue) 102 { 103 writer.WriteValue(arrBString[0]); 104 } 105 else 106 { 107 writer.WriteValue(arrBString[1]); 108 } 109 } 110 } 111 112
自定義了BoolConvert型別，繼承自JsonConverter。建構函式引數BooleanString可以讓我們自定義將true false轉換成相應字串。下面看實體裡面怎麼使用這個自定義轉換型別
public class Person
{
[JsonConverter(typeof(BoolConvert))]
public bool IsMarry { get; set; } }
‘
相應的有什麼個性化的轉換需求，都可以使用自定義轉換型別的方式實現。
10.全域性序列化設定
文章開頭提出了Null值欄位怎麼不返回的問題，相應的在高階用法也給出了相應的解決方案使用jsetting.NullValueHandling = NullValueHandling.Ignore; 來設定不返回空值。這樣有個麻煩的地方，每個不想返回空值的序列化都需設定一下。可以對序列化設定一些預設值方式麼？下面將解答
1 Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings(); 2 JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() => 3 { 4 //日期型別預設格式化處理 5 setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat; 6 setting.DateFormatString = "yyyy-MM-dd HH:mm:ss"; 7 8 //空值處理 9 setting.NullValueHandling = NullValueHandling.Ignore; 10 11 //高階用法九中的Bool型別轉換 設定 12 setting.Converters.Add(new BoolConvert("是,否")); 13 14 return setting; 15 });
這樣設定以後，以後使用序列化的地方就不需要單獨設定了，個人最喜歡設定的是空值處理這一塊。
四、總結
今天就到這裡了，它涉及的內容太多了，我們只是接觸了皮毛，官網地址如下：https://www.newtonsoft.com/json。通過一個小問題，學習了一個大知識點，當自己不深入的時候，對一些事情的判斷就可能有失偏頗，如果想讓自己把技術運用的得心應手，就要深入進去，瞭解其裡，才能有所得。