.NETCore3.1中的Json互操作最全解讀-收藏級

来源:https://www.cnblogs.com/viter/archive/2019/12/30/12116640.html
-Advertisement-
Play Games

本文全面的介紹了 System.Text.Json 在各種場景下的用法，並比較和 Newtonsoft.Json 使用上的不同，也通過實例演示了具體的使用方法，進一步深入講解了 System.Text.Json 各種對象的原理，希望對大家在遷移到.NETCore-3.1 的時候有所幫助。 ...


前言

本文比較長，我建議大家先點贊、收藏後慢慢閱讀，點贊再看，形成習慣！

我很高興,.NETCore終於來到了3.1LTS版本，並且將支持3年，我們也準備讓部分業務遷移到3.1上面，不過很快我們就遇到了新的問題，就是對於Json序列化的選擇；我本著清真的原則，既然選擇遷移到3.1，一切都應該用官方標準或者建議方案。所以我們信心滿滿的選擇了System.Text.Json。本文將會全面介紹System.Text.Json 和 Newtonsoft.Json 的相同和異同之處，方便需要的同學做遷移使用，對未來，我們保持期待。

文檔比較

幾個重要的對象

在 System.Text.Json 中，有幾個重量級的對象，所有的JSON互操作，都是圍繞這幾個對象進行，只要理解了他們各自的用途用法，就基本上掌握了JSON和實體對象的互操作。

JsonDocument

提供用於檢查 JSON 值的結構內容，而不自動實例化數據值的機制。JsonDocument 有一個屬性 RootElement，提供對JSON文檔根元素的訪問，RootElement是一個JsonElement對象。

JsonElement

提供對JSON值的訪問，在System.Text.Json 中，大到一個對象、數組，小到一個屬性、值，都可以通過 JsonElement 進行互操作

JsonProperty

JSON中最小的單元，提供對屬性、值的訪問

JsonSerializer

提供JSON互操作的靜態類，提供了一系列 Serializer/Deserialize 的互操作的方法，其中還有一些非同步/流式操作方法。

JsonSerializerOptions

與上面的 JsonSerializer 配合使用，提供自定義的個性化互操作選項，包括命名、枚舉轉換、字元轉義、註釋規則、自定義轉換器等等操作選項。

Utf8JsonWriter/Utf8JsonReader

這兩個對象是整個 System.Text.Json 的核心對象，所有的JSON互操作幾乎都是通過這兩個對象進行，他們提供的高性能的底層讀寫操作。

初始化一個簡單的 JSON 對象

在 System.Text.Json 中，並未提供像 JToken 那樣非常便捷的創建對象的操作，想要創建一個 JSON 對象，其過程是比較麻煩的，請看下麵的代碼，進行對比

 // 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

基本介紹

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 介面，然後同樣的在內部維護一個 List 鏈表，以實現數組功能，對象的序列化都是通過 JsonValue 進行操作，序列化的方式也是非常的簡單，就是對對像進行迭代，唯一值得稱道的地方是，採用了流式處理。

使用System.Json操作上面的查找過程如下

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文本進行美化，而不是輸出上面的壓縮後的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 名稱和值

在預設情況下，輸出的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，其他屬性保持大小寫不變

對所有屬性設置為 camel 大小寫

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 中，可以通過下麵的幾種方式實現屬性排除

排除所有屬性值為 null 屬性

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 。

在反序列化的時候，允許 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

加入Converters 方式

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}

應用 JsonConverter 特性方式

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 的時候有所幫助。

最後，歡迎點贊！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • [隨筆]Centos 7上部署.net core webapi
    1、centos7 上安裝.net core sdk 3.1 參考官方所給的教程 官方建議直接安裝運行時 我安裝了sdk 發現也安裝了依賴項運行時 https://docs.microsoft.com/zh cn/dotnet/core/install/linux package manager c ...
  • .NetCore學習筆記：三、基於AspectCore的AOP事務管理
    AOP（面向切麵編程），通過預編譯方式和運行期間動態代理實現程式功能的統一維護的一種技術。AOP是OOP的延續，是函數式編程的一種衍生範型。利用AOP可以對業務邏輯的各個部分進行隔離，從而使得業務邏輯各部分之間的耦合度降低，提高程式的可重用性，同時提高了開發的效率。 AspectCore 提供了一個 ...
  • ASP.NET Core 2.1 中的 HttpClientFactory (Part 4) 整合Polly實現瞬時故障處理
    原文：https://www.stevejgordon.co.uk/httpclientfactory-using-polly-for-transient-fault-handling發表於：2018年6月 原文：https://www.stevejgordon.co.uk/httpclientfa ...
  • C#介面與抽象類學習筆記
    本筆記摘抄自：https://www.cnblogs.com/solan/archive/2012/08/01/CSharp06.html，記錄一下學習過程以備後續查用。 摘要： 抽象類：是一種特殊的類，可以定義具有實現的方法，也可以定義未實現的方法契約，本身不能被實例化，只能在派生類中進行實例化。 ...
  • 聊聊多線程哪一些事兒（task）之 三 非同步取消和非同步方法
    介紹了task的創建、運行、同步/非同步執行、阻塞等待，本文將主要介紹task的延續操作：WhenAny、WhenAll、ContinueWith；CancellationTokenSource任務取消；非同步方法之:(async/await) ...
  • Ioc依賴註入：Unity4.0.1 在項目中的應用 (MVC和API)
    使用Unity的好處網上有很多，百度一下即可 這裡引用了一篇關於面向介面編程的好處的文章作為引申：https://blog.csdn.net/Cyy19970527/article/details/83177996 在MVC中使用Unity 需要引用Unity包，我安裝的版本為 Unity-4.0. ...
  • 記一次畫圖出現的小細節，導致我找了3天多
    項目里 要用到畫圖 並且最大化 和常態都要自適應 並且線還能被擦掉 我就沒畫在圖片上（主要是這個是老大開發自定義控制項 我不知道怎麼畫在這個控制項的圖片上。。。）， 然後就出現了下圖的運算 var x1 = ImgXInfo.lineStartPoint.X * ImgXInfo.MaxWidth / ...
  • C# extract img url from web content then download the img
    static void Main(string[] args) { WebClientDemo(); Console.ReadLine(); } static void WebClientDemo() { webContent = File.ReadAllText("img2.txt"); var ... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類