本文比較長,我建議你們先點贊、收藏後慢慢閱讀,點贊再看,造成習慣!json
我很高興,.NETCore終於來到了3.1LTS版本,而且將支持3年,咱們也準備讓部分業務遷移到3.1上面,不過很快咱們就遇到了新的問題,就是對於Json序列化的選擇;我本着清真的原則,既然選擇遷移到3.1,一切都應該用官方標準或者建議方案。因此咱們信心滿滿的選擇了System.Text.Json。本文將會全面介紹System.Text.Json 和 Newtonsoft.Json 的相同和異同之處,方便須要的同窗作遷移使用,對將來,咱們保持期待。api
在 System.Text.Json 中,有幾個重量級的對象,全部的JSON互操做,都是圍繞這幾個對象進行,只要理解了他們各自的用途用法,就基本上掌握了JSON和實體對象的互操做。數組
提供用於檢查 JSON 值的結構內容,而不自動實例化數據值的機制。JsonDocument 有一個屬性 RootElement,提供對JSON文檔根元素的訪問,RootElement是一個JsonElement對象。異步
提供對JSON值的訪問,在System.Text.Json 中,大到一個對象、數組,小到一個屬性、值,均可以經過 JsonElement 進行互操做ide
JSON中最小的單元,提供對屬性、值的訪問函數
提供JSON互操做的靜態類,提供了一系列 Serializer/Deserialize 的互操做的方法,其中還有一些異步/流式操做方法。性能
與上面的 JsonSerializer 配合使用,提供自定義的個性化互操做選項,包括命名、枚舉轉換、字符轉義、註釋規則、自定義轉換器等等操做選項。jsonp
這兩個對象是整個 System.Text.Json 的核心對象,全部的JSON互操做幾乎都是經過這兩個對象進行,他們提供的高性能的底層讀寫操做。ui
在 System.Text.Json 中,並未提供像 JToken 那樣很是便捷的建立對象的操做,想要建立一個 JSON 對象,其過程是比較麻煩的,請看下面的代碼,進行對比this
// Newtonsoft.Json.Linq; JToken root = new JObject(); root["Name"] = "Ron"; root["Money"] = 4.5; root["Age"] = 30; string jsonText = root.ToString(); // System.Text.Json string json = string.Empty; using (MemoryStream ms = new MemoryStream()) { using (Utf8JsonWriter writer = new Utf8JsonWriter(ms)) { writer.WriteStartObject(); writer.WriteString("Name", "Ron"); writer.WriteNumber("Money", 4.5); writer.WriteNumber("Age", 30); writer.WriteEndObject(); writer.Flush(); } json = Encoding.UTF8.GetString(ms.ToArray()); }
System.Text.Json 的操做便利性在這方面目前處於一個比較弱的狀態,不過,從這裏也能夠看出,可能官方並不但願咱們去直接操做 JSON 源,而是經過操做實體對象以達到操做 JSON 的目的,也可能對互操做是性能比較自信的表現吧。
在對JSON文檔進行包裝的用法
var json = "{\"name\":\"Ron\",\"money\":4.5}"; var jDoc = System.Text.Json.JsonDocument.Parse(json); var jToken = Newtonsoft.Json.Linq.JToken.Parse(json);
我發現MS這幫人很喜歡使用 Document 這個詞,包括XmlDocument/XDocument等等。
var json = "{\"name\":\"Ron\",\"money\":4.5}"; var jDoc = System.Text.Json.JsonDocument.Parse(json); var obj = jDoc.RootElement[0];// 這裏會報錯,索引僅支持 Array 類型的JSON文檔 var jToken = Newtonsoft.Json.Linq.JToken.Parse(json); var name = jToken["name"];
你看,到查找元素環節就體現出差別了,JsonDocuemnt 索引僅支持 Array 類型的JSON文檔,而 JToken 則支持 object 類型的索引(充滿想象),用戶體驗高下立判。
那咱們不由要提問了,如何在 JsonDocument 中查找元素?答案以下。
var json = "{\"name\":\"Ron\",\"money\":4.5}"; var jDoc = System.Text.Json.JsonDocument.Parse(json); var enumerate = jDoc.RootElement.EnumerateObject(); while (enumerate.MoveNext()) { if (enumerate.Current.Name == "name") Console.WriteLine("{0}:{1}", enumerate.Current.Name, enumerate.Current.Value); }
從上面的代碼來看,JsonElement 存在兩個迭代器,分別是EnumerateArray和EnumerateObject;經過迭代器,你能夠實現查找元素的需求。你看,MS關上了一扇門,而後又爲了打開了一扇窗,仍是很人性化的了。在System.Text.Json中,一切對象都是Element,Object/Array/Property,都是Element,這個概念和XML一致,可是和Newtonsoft.Json不一樣,這是須要注意的地方。
你也能夠選擇不迭代,直接獲取對象的屬性,好比使用下面的方法
var json = "{\"name\":\"Ron\",\"money\":4.5}"; var jDoc = System.Text.Json.JsonDocument.Parse(json); var age = jDoc.RootElement.GetProperty("age");
上面這段代碼將拋出異常,由於屬性 age 不存在,一般狀況下,咱們會當即想用一個 ContainsKey 來做一個判斷,可是很惋惜,JsonElement 並未提供該方法,而是提供了一個 TryGetProperty 方法;因此,除非你明確知道 json 對象中的屬性,不然通常狀況下,建議使用 TryGetProperty 進行取值。
就算是這樣,使用 GetProperty/TryGetProperty 獲得的值,仍是一個 JsonElement 對象,並非你指望的「值」。因此 JsonElement 很人性化的提供了各類 GetIntxx/GetString 方法,可是就算如此,仍是可能產生意外,思考下面的代碼:
var json = "{\"name\":\"Ron\",\"money\":4.5,\"age\":null}"; var jDoc = System.Text.Json.JsonDocument.Parse(json); var property = jDoc.RootElement.GetProperty("age"); var age = property.GetInt32();
上面的代碼,最後一行將拋出異常,由於你嘗試從一個 null 到 int32 的類型轉換,怎麼解決這種問題呢,又回到了 JsonElement 上面來,他又提供了一個對值進行檢查的方法
if (property.ValueKind == JsonValueKind.Number) { var age = property.GetInt32(); }
這個時候,程序運行良好,JsonValueKind 枚舉提供了一系列的類型標識,爲了進一步縮小內存使用率,Json團隊用心良苦的將枚舉值聲明爲:byte 類型(夠摳)
public enum JsonValueKind : byte { Undefined = 0, Object = 1, Array = 2, String = 3, Number = 4, True = 5, False = 6, Null = 7 }
看到這裏,你是否是有點想念 Newtonsoft.Json 了呢?彆着急,下面我給你們介紹一個寶貝 System.Json.dll。
System.Json 提供了對JSON 對象序列化的基礎支持,可是也是有限的支持,請看下圖
System.Json 目前已合併到 .NETCore-3.1 中,若是你但願使用他,須要單獨引用
Install-Package System.Json -Version 4.7.0
這個JSON互操做包提供了幾個經常使用的操做類型,從下面的操做類不難看出,提供的支持是很是有限的,並且效率上也很差說
System.Json.JsonArray System.Json.JsonObject System.Json.JsonPrimitive System.Json.JsonValue
首先,JsonObject是實現 IDictionary 接口,並在內部維護一個 SortedDictionary<string, JsonValue> 字典,因此他具有字典類的一切操做,好比索引等等,JsonArray 就更簡單,也是同樣的實現 IList
var obj = System.Json.JsonObject.Parse("{\"name\":\"ron\"}"); if (obj.ContainsKey("age")) { int age = obj["age"]; }
使人遺憾的是,雖然 System.Json 已經合併到 .NETCore-3.1 的路線圖中;可是,System.Text.Json 不提供對 System.Json 的互操做性,咱們期待之後 System.Text.Json 也能提供 System.Json 的操做便利性。
基本知識已經介紹完成,下面咱們進入 System.Text.Json 的內部世界一探究竟。
思考下面的代碼
// 序列化 var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30 }; var json = JsonSerializer.Serialize(user); // 輸出 {"Name":"Ron","Money":4.5,"Age":30} // 反序列化 user = JsonSerializer.Deserialize<UserInfo>(json);
目前爲止,上面的代碼工做良好。讓咱們對上面的代碼稍做修改,將 JSON 字符串進行一個轉小寫的操做後再進行反序列化的操做
// 輸出 {"name":"Ron","money":4.5,"age":30} // 反序列化 user = JsonSerializer.Deserialize<UserInfo>(json);
上面的代碼能夠正常運行,也不會拋出異常,你能夠獲得一個完整的 user 對象;可是,user對象的屬性值將會丟失!這是由於 System.Text.Json 默認採用的是區分大小寫匹配的方式,爲了解決這個問題,咱們須要引入序列化操做個性化設置,請參考下面的代碼,啓用忽略大小寫的設置
// 輸出 {"name":"Ron","money":4.5,"age":30} var options = new JsonSerializerOptions() { PropertyNameCaseInsensitive = true }; // 反序列化 user = JsonSerializer.Deserialize<UserInfo>(json,options);
如今你能夠選擇對序列化的JSON文本進行美化,而不是輸出上面的壓縮後的JSON文本,爲了實現美化的效果,你僅僅須要在序列化的時候加入一個 WriteIndented 設置
var options = new JsonSerializerOptions() options.WriteIndented = true; var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30, Remark = "你好,歡迎!" }; var json = JsonSerializer.Serialize(user, options); // 輸出 { "Name": "Ron", "Money": 4.5, "Age": 30, "Remark": "\u4F60\u597D\uFF0C\u6B22\u8FCE\uFF01" }
你看,就是這麼簡單,可是你也發現了,上面的 Remark 屬性在序列化後,中文被轉義了,這就是接下來要解決的問題
在默認狀況下,System.Text.Json 序列化程序對全部非 ASCII 字符進行轉義;這就是中文被轉義的根本緣由。可是在內部,他又容許你自定義控制字符集的轉義行爲,這個設置就是:Encoder,好比下面的代碼,對中文進行轉義的例外設置,須要建立一個 TextEncoderSettings 對象,並將 UnicodeRanges.All 加入容許例外範圍內,並使用 JavaScriptEncoder 根據 TextEncoderSettings建立一個 JavaScriptEncoder 對象便可。
var encoderSettings = new TextEncoderSettings(); encoderSettings.AllowRanges(UnicodeRanges.All); var options = new JsonSerializerOptions(); options.Encoder = JavaScriptEncoder.Create(encoderSettings); options.WriteIndented = true; var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30, Remark = "你好,歡迎!" }; var json = JsonSerializer.Serialize(user, options); // 輸出 { "Name": "Ron", "Money": 4.5, "Age": 30, "Remark": "你好,歡迎!" }
還有另一種模式,能夠沒必要設置例外而達到不轉義的效果,這個模式就是「非嚴格JSON」模式,將上面的 JavaScriptEncoder.Create(encoderSettings) 替換爲下面的代碼
options.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping;
System.Text.Josn 提供了一系列豐富的JSON互操做,這其中包含異步和流式處理,這點也是和 Newtonsoft.Json 最大的不一樣,但不論是那種方式,都要牢記,最後都是經過下面的兩個類來實現
System.Text.Json.Utf8JsonReader System.Text.Json.Utf8JsonWriter
在默認狀況下,輸出的JSON屬性名稱保持和實體對象相同,包括大小寫的都是一致的,枚舉類型在默認狀況下被序列化爲數值類型。System.Text.JSON 提供了一系列的設置和擴展來幫助開發者實現各類自定義的需求。下面的代碼能夠設置默認的JSON屬性名稱,這個設置和 Newtonsoft.Json 基本一致。
public class UserInfo { [JsonPropertyName("name")] public string Name { get; set; } public decimal Money { get; set; } public int Age { get; set; } public string Remark { get; set; } }
UserInfo 的 屬性 Name 在輸出爲 JSON 的時候,其字段名稱將爲:name,其餘屬性保持大小寫不變
var options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase }; jsonSerializer.Serialize(user, options);
好比咱們的系統,目前採用全小寫的模式,那麼我能夠自定義一個轉換器,並應用到序列化行爲中。
public class LowerCaseNamingPolicy : JsonNamingPolicy { public override string ConvertName(string name) => name.ToLower(); } var options = new JsonSerializerOptions(); // 應用策略 options.PropertyNamingPolicy = new LowerCaseNamingPolicy(); var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30}; var json = JsonSerializer.Serialize(user, options);
var options = new JsonSerializerOptions(); // 添加轉換器 options.Converters.Add(new JsonStringEnumConverter()); var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30; var json = JsonSerializer.Serialize(user, options);
在默認狀況下,全部公共屬性將被序列化爲JSON。 可是,若是你不想讓某些屬性出如今 JSON 中,能夠經過下面的幾種方式實現屬性排除
var options = new JsonSerializerOptions(); options.Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping; options.IgnoreNullValues = true; var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30, Remark =null}; var json = JsonSerializer.Serialize(user, options); // 輸出,能夠看到,Remark 屬性被排除 {"name":"Ron","Money":4.5,"Age":30}
能夠爲某個屬性應用 JsonIgnore 特性,標記爲不輸出到 JSON
public class UserInfo { [JsonPropertyName("name")] public string Name { get; set; } public decimal Money { get; set; } [JsonIgnore]public int Age { get; set; } public string Remark { get; set; } } var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30, Remark =null}; var json = JsonSerializer.Serialize(user); // 輸出,屬性 Age 已被排除 {"name":"Ron","Money":4.5,"Remark":null}
還能夠選擇對全部只讀屬性進行排查輸出 JSON,好比下面的代碼,Password 是不須要輸出的,那麼咱們只須要將 Password 設置爲 getter,並應用 IgnoreReadOnlyProperties = true 便可
public class UserInfo { [JsonPropertyName("name")] public string Name { get; set; } public decimal Money { get; set; } [JsonIgnore] public int Age { get; set; } public int Password { get; } public string Remark { get; set; } } var options = new JsonSerializerOptions { IgnoreReadOnlyProperties = true }; var user = new UserInfo { Name = "Ron", Money = 4.5m, Age = 30, Remark = null }; var json = JsonSerializer.Serialize(user, options); // 輸出 {"name":"Ron","Money":4.5,"Remark":null}
在某些狀況下,因爲業務需求的不一樣,須要實現實體對象的繼承,可是在輸出 JSON 的時候,但願只輸出基類的屬性,而不要輸出派生類型的屬性,以免產生不可控制的數據泄露問題;那麼,咱們能夠採用下面的序列化設置。好比下面的 UserInfoExtension 派生自 UserInfo,並擴展了一個屬性爲身份證的屬性,在輸出 JSON 的時候,咱們但願不要序列化派生類,那麼咱們能夠在 Serialize 序列化的時候,指定序列化的類型爲基類:UserInfo,便可達到隱藏派生類屬性的目的。
public class UserInfo { [JsonPropertyName("name")] public string Name { get; set; } public decimal Money { get; set; } [JsonIgnore] public int Age { get; set; } public int Password { get; } public string Remark { get; set; } } public class UserInfoExtension : UserInfo { public string IdCard { get; set; } } var user = new UserInfoExtension { Name = "Ron", Money = 4.5m, Age = 30, Remark = null }; var json = JsonSerializer.Serialize(user, typeof(UserInfo)); // 輸出 {"name":"Ron","Money":4.5,"Password":0,"Remark":null}
在 Newtonsoft.Json 中,咱們能夠經過指定 MemberSerialization 和 JsonProperty 來實現輸出指定屬性到 JSON 中,好比下面的代碼
[Newtonsoft.Json.JsonObject(Newtonsoft.Json.MemberSerialization.OptIn)] public class UserInfo { [Newtonsoft.Json.JsonProperty("name")] public string Name { get; set; } public int Age { get; set; } } var user = new UserInfo() { Age = 18, Name = "Ron" }; var json = Newtonsoft.Json.JsonConvert.SerializeObject(user); // 輸出 {"name":"Ron"}
不過,很遺憾的告訴你們,目前 System.Text.Json 不支持這種方式;爲此,我特地去看了 corefx 的 issue,我看到了下面這個反饋
如今能夠方向了,當 .NETCore 合併到主分支 .NET 也就是 .NET5.0 的時候,官方將提供支持,在此以前,仍是使用推薦 Newtonsoft.Json 。
默認狀況下,System.Text.JSON 不支持源JSON 文本包含註釋,好比下面的代碼,當你不使用 ReadCommentHandling = JsonCommentHandling.Skip 的設置的時候,將拋出異常,由於在字段 Age 的後面有註釋 /* age */。
var jsonText = "{\"Name\":\"Ron\",\"Money\":4.5,\"Age\":30/* age */}"; var options = new JsonSerializerOptions { ReadCommentHandling = JsonCommentHandling.Skip, AllowTrailingCommas = true, }; var user = JsonSerializer.Deserialize<UserInfoExtension>(jsonText);
在接口數據出現變更時,極有可能出現源 JSON 文本和實體對象屬性不匹配的問題,JSON 中可能會多出一些實體對象不存在的屬性,這種狀況咱們稱之爲「溢出」,在默認狀況下,溢出的屬性將被忽略,若是但願捕獲這些「溢出」的屬性,能夠在實體對象中聲明一個類型爲:Dictionary<string, object> 的屬性,並對其應用特性標記:JsonExtensionData。
爲了演示這種特殊的處理,咱們聲明瞭一個實體對象 UserInfo,並構造了一個 JSON 源,該 JSON 源包含了一個 UserInfo 不存在的屬性:Money,預期該 Money 屬性將被反序列化到屬性 ExtensionData 中。
public class UserInfo { public string Name { get; set; } public int Age { get; set; } [JsonExtensionData] public Dictionary<string, object> ExtensionData { get; set; } } var jsonText = "{\"Name\":\"Ron\",\"Money\":4.5,\"Age\":30}"; var user = JsonSerializer.Deserialize<UserInfo>(jsonText);
輸出截圖
有意思的是,被特性 JsonExtensionData 標記的屬性,在序列化爲 JSON 的時候,他又會將 ExtensionData 的字典都序列化爲單個 JSON 的屬性,這裏再也不演示,留給你們去體驗。
System.Text.Json 內置了各類豐富的類型轉換器,這些默認的轉換器在程序初始化 JsonSerializerOptions 的時候就默認加載,在 JsonSerializerOptions 內部,維護着一個私有靜態成員 s_defaultSimpleConverters,同時還有一個公有屬性 Converters ,Converters 屬性在 JsonSerializerOptions 的構造函數中被初始化;從下面的代碼中能夠看到,默認轉換器集合和公有轉換器集是相互獨立的,System.Text.Json 容許開發人員經過 Converters 添加自定義的轉換器。
public sealed partial class JsonSerializerOptions { // The global list of built-in simple converters. private static readonly Dictionary<Type, JsonConverter> s_defaultSimpleConverters = GetDefaultSimpleConverters(); // The global list of built-in converters that override CanConvert(). private static readonly List<JsonConverter> s_defaultFactoryConverters = GetDefaultConverters(); // The cached converters (custom or built-in). private readonly ConcurrentDictionary<Type, JsonConverter> _converters = new ConcurrentDictionary<Type, JsonConverter>(); private static Dictionary<Type, JsonConverter> GetDefaultSimpleConverters() { ... } private static List<JsonConverter> GetDefaultConverters() { ... } public IList<JsonConverter> Converters { get; } ... }
在 System.Text.Json 內置的轉換器集合中,涵蓋了全部的基礎數據類型,這些轉換器的設計很是精妙,他們經過註冊一系列的類型映射,在經過 Utf8JsonWriter/Utf8JsonReader 的內置方法 GetTypeValue/TryGetTypeValue 方法獲得值,代碼很是精練,複用性很是高,下面是內置類型轉換器。
private static IEnumerable<JsonConverter> DefaultSimpleConverters { get { // When adding to this, update NumberOfSimpleConverters above. yield return new JsonConverterBoolean(); yield return new JsonConverterByte(); yield return new JsonConverterByteArray(); yield return new JsonConverterChar(); yield return new JsonConverterDateTime(); yield return new JsonConverterDateTimeOffset(); yield return new JsonConverterDouble(); yield return new JsonConverterDecimal(); yield return new JsonConverterGuid(); yield return new JsonConverterInt16(); yield return new JsonConverterInt32(); yield return new JsonConverterInt64(); yield return new JsonConverterJsonElement(); yield return new JsonConverterObject(); yield return new JsonConverterSByte(); yield return new JsonConverterSingle(); yield return new JsonConverterString(); yield return new JsonConverterUInt16(); yield return new JsonConverterUInt32(); yield return new JsonConverterUInt64(); yield return new JsonConverterUri(); } }
雖然 System.Text.Json 內置了各類各樣豐富的類型轉換器,可是在各類業務開發的過程當中,總會根據業務需求來決定一些特殊的數據類型的數據,下面,咱們就以經典的日期/時間轉換做爲演示場景。
咱們須要將日期類型輸出爲 Unix 時間戳而不是格式化的日期內容,爲此,咱們將實現一個自定義的時間格式轉換器,該轉換器繼承自 JsonConverter
public class JsonConverterUnixDateTime : JsonConverter<DateTime> { private static DateTime Greenwich_Mean_Time = TimeZoneInfo.ConvertTime(new DateTime(1970, 1, 1), TimeZoneInfo.Local); private const int Limit = 10000; public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Number) { var unixTime = reader.GetInt64(); var dt = new DateTime(Greenwich_Mean_Time.Ticks + unixTime * Limit); return dt; } else { return reader.GetDateTime(); } } public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options) { var unixTime = (value - Greenwich_Mean_Time).Ticks / Limit; writer.WriteNumberValue(unixTime); } }
轉換器的應用形式有兩種,分別是將轉換加入 JsonSerializerOptions.Converters 和給須要轉換的屬性添加特性標記 JsonConverter
var options = new JsonSerializerOptions(); options.Converters.Add(new JsonConverterUnixDateTime()); var user = new UserInfo() { Age = 30, Name = "Ron", LoginTime = DateTime.Now }; var json = JsonSerializer.Serialize(user, options); var deUser = JsonSerializer.Deserialize<UserInfo>(json, options); // JSON 輸出 {"Name":"Ron","Age":30,"LoginTime":1577655080422}
public class UserInfo { public string Name { get; set; } public int Age { get; set; } [JsonConverter(typeof(JsonConverterUnixDateTime))] public DateTime LoginTime { get; set; } } var user = new UserInfo() { Age = 30, Name = "Ron", LoginTime = DateTime.Now }; var json = JsonSerializer.Serialize(user); var deUser = JsonSerializer.Deserialize<UserInfo>(json); // JSON 輸出 {"Name":"Ron","Age":30,"LoginTime":1577655080422}
注意上面的 UserInfo.LoginTime 的特性標記,當你想小範圍的對某些屬性單獨應用轉換器的時候,這種方式費用小巧而有效。
本文全面的介紹了 System.Text.Json 在各類場景下的用法,並比較和 Newtonsoft.Json 使用上的不一樣,也經過實例演示了具體的使用方法,進一步深刻講解了 System.Text.Json 各類對象的原理,但願對你們在遷移到.NETCore-3.1 的時候有所幫助。
最後,歡迎點贊!