一、基本用法
Json.Net是支援序列化和反序列化DataTable,DataSet,Entity Framework和Entity的。下面分別舉例說明序列化和反序列化。
//序列化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]); }
二、高階用法
- 忽略某些屬性
- 預設值的處理
- 空值的處理
- 支援非公共成員
- 日期處理
- 自定義序列化的欄位名稱
- 動態決定屬性是否序列化
- 列舉值的自定義格式化問題
- 自定義型別轉換
- 全域性序列化設定
1.忽略某些屬性
我們在序列化的過程中，並不是所有屬性都需要序列化的，如果實體中有些屬性不需要序列化，可以使用該特性。首先介紹Json.Net序列化的模式：OptOut和OptIn
僅需要姓名屬性
[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; } }
透過上面的例子可以看到，要實現不返回某些屬性的需求很簡單：
- 在實體類上加上
[JsonObject(MemberSerialization.OptOut)] - 在不需要返回的屬性上加上
[JsonIgnore]說明。
2.預設值處理
序列化時想忽略預設值屬性可以透過JsonSerializerSettings.DefaultValueHandling來確定，該值為列舉值
[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日期標準"Birthday":"1991-01-02T00:00:00，但是實際使用過程中大多數使用的可能是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; }
可以根據自己需求實現不同的轉換類
6.自定義序列化的欄位名稱
實體中定義的屬性名可能不是自己想要的名稱，但是又不能更改實體定義，這個時候可以自定義序列化欄位名稱。
[JsonProperty(PropertyName = "CName")] public string Name { get; set; }
7.動態決定屬性是否序列化
根據某些場景，可能A場景輸出A，B，C三個屬性，B場景輸出E，F屬性。雖然實際中不一定存在這種需求，但是json.net依然可以支援該特性。
繼承預設的DefaultContractResolver類，傳入需要輸出的屬性
重寫修改了一下，大多數情況下應該是要排除的欄位少於要保留的欄位, 為了方便書寫這裡修改了建構函式加入retain表示props是需要保留的欄位還是要排除的欄位
public class LimitPropsContractResolver : DefaultContractResolver { string[] props = null; bool retain; /// <summary> /// 建構函式 /// </summary> /// <param name="props">傳入的屬性陣列</param> /// <param name="retain">true:表示`props`是需要保留的欄位`false`：表示`props`是要排除的欄位</param> public LimitPropsContractResolver(string[] props, bool retain = true) { //指定要序列化屬性的清單 this.props = props; this.retain = retain; } protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization) { IList<JsonProperty> list = base.CreateProperties(type, memberSerialization); //只保留清單有列出的屬性 return list.Where(p => { if (retain) { return props.Contains(p.PropertyName); } else { return !props.Contains(p.PropertyName); } }).ToList(); } }
public int Age { get; set; } [JsonIgnore] public bool IsMarry { get; set; } 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端序列化一部分，手機端序列化另一部分就很簡單了吧，我們改下程式碼實現一下
string[] propNames = null; if (p.Age > 10) { propNames = new string[] { "Age", "IsMarry" }; } else { propNames = new string[] { "Age", "Sex" }; } jsetting.ContractResolver = new LimitPropsContractResolver(propNames); Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));
8.列舉值的自定義格式化問題
預設情況下對於實體裡面的列舉型別系統是格式化成
public enum NotifyType { /// <summary> /// Emil傳送 /// </summary> Mail = 0, /// <summary> /// 簡訊傳送 /// </summary> SMS = 1 } public class TestEnmu { /// <summary> /// 訊息傳送型別 /// </summary> public NotifyType Type { get; set; } } JsonConvert.SerializeObject(new TestEnmu());
列舉對應的整型數值，那如果需要格式化成列舉對應的字元怎麼處理呢？Newtonsoft.Json也幫我們想到了這點，下面看例項
輸出結果：
現在改造一下，輸出"Type":"Mail"
public class TestEnmu { /// <summary> ///訊息傳送型別 /// </summary> [JsonConverter(typeof(StringEnumConverter))] public NotifyType Type { get; set; } }
其它的都不變，在Type屬性上加上了JsonConverter(typeof(StringEnumConverter))表示將列舉值轉換成對應的字串，而StringEnumConverter是Newtonsoft.Json內建的轉換型別，最終輸出結果
9.自定義型別轉換
預設情況下對於實體裡面的Boolean系統是格式化成true或者false，對於true轉成"是" false轉成"否"這種需求改怎麼實現了？我們可以自定義型別轉換實現該需求，下面看例項
public class BoolConvert : JsonConverter { private string[] arrBString { get; set; } public BoolConvert() { arrBString = "是,否".Split(','); } /// <summary> /// 建構函式 /// </summary> /// <param name="BooleanString">將`bool`值轉換成的字串值</param> public BoolConvert(string BooleanString) { if (string.IsNullOrEmpty(BooleanString)) { throw new ArgumentNullException(); } arrBString = BooleanString.Split(','); if (arrBString.Length != 2) { throw new ArgumentException("BooleanString格式不符合規定"); } } public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { bool isNullable = IsNullableType(objectType); Type t = isNullable ? Nullable.GetUnderlyingType(objectType) : objectType; if (reader.TokenType == JsonToken.Null) { if (!IsNullableType(objectType)) { throw new Exception(string.Format("不能轉換null value to {0}.", objectType)); } return null; } try { if (reader.TokenType == JsonToken.String) { string boolText = reader.Value.ToString(); if (boolText.Equals(arrBString[0], StringComparison.OrdinalIgnoreCase)) { return true; } else if (boolText.Equals(arrBString[1], StringComparison.OrdinalIgnoreCase)) { return false; } } if (reader.TokenType == JsonToken.Integer) { return Convert.ToInt32(reader.Value) == 1; } } catch (Exception ex) { throw new Exception(string.Format("Error converting value {0} to type '{1}'", reader.Value, objectType)); } throw new Exception(string.Format("Unexpected token {0} when parsing enum", reader.TokenType)); } /// <summary> /// 判斷是否為`Bool`型別 /// </summary> /// <param name="objectType">型別</param> /// <returns>為`bool`型別則可以進行轉換</returns> public override bool CanConvert(Type objectType) { return true; } public bool IsNullableType(Type t) { if (t == null) { throw new ArgumentNullException("t"); } return (t.BaseType.FullName == "System.ValueType" && t.GetGenericTypeDefinition() == typeof(Nullable<>)); } public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { if (value == null) { writer.WriteNull(); return; } bool bValue = (bool)value; if (bValue) { writer.WriteValue(arrBString[0]); } else { writer.WriteValue(arrBString[1]); } } }
自定義了BoolConvert型別，繼承自JsonConverter。建構函式引數BooleanString可以讓我們自定義將true false轉換成相應字串。下面看實體裡面怎麼使用這個自定義轉換型別
public class Person { [JsonConverter(typeof(BoolConvert))] public bool IsMarry { get; set; } }
10.全域性序列化設定
文章開頭提出了Null值欄位怎麼不返回的問題，相應的在高階用法也給出了相應的解決方案使用jsetting.NullValueHandling = NullValueHandling.Ignore;來設定不返回空值。這樣有個麻煩的地方，每個不想返回空值的序列化都需設定一下。可以對序列化設定一些預設值方式麼？下面將解答
Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings(); JsonConvert.DefaultSettings = new Func<JsonSerializerSettings>(() => {
//日期型別預設格式化處理 setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat; setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
//空值處理 setting.NullValueHandling = NullValueHandling.Ignore;
//高階用法九中的`Bool`型別轉換設定 setting.Converters.Add(new BoolConvert("是，否")); return setting; });
這樣設定以後，以後使用序列化的地方就不需要單獨設定了，個人最喜歡設定的是空值處理這一塊。