行為不一致

.NET Core 3.0 新出了個內建的 JSON 庫, 全名叫做尼古拉斯 System.Text.Json - 效能更高佔用記憶體更少這都不是事...

對我來說, 很多或大或小的專案能少個第三方依賴項, 還能規避多個依賴項的依賴 Newtonsoft.Json 版本不一致的問題, 是件極美的事情.

但是, 結果總不是不如預期那麼簡單和美好, 簡單測試了下, 有一些跟 Newtonsoft.Json 行為不一致的地方, 程式碼如下:

using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace UnitTestProject3
{
    [TestClass]
    public class TestJsonDiff
    {
        [TestMethod]
        [Description(description: "測試數字序列化")]
        public void TestNumber()
        {
            object jsonObject = new { number = 123.456 };
            string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
            string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: jsonObject);

            Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試數字序列化失敗");
        }

        [TestMethod]
        [Description(description: "測試英文序列化")]
        public void TestEnglish()
        {
            object jsonObject = new { english = "bla bla" };
            string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
            string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: jsonObject);

            Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試英文序列化失敗");
        }

        [TestMethod]
        [Description(description: "測試中文序列化")]
        public void TestChinese()
        {
            object jsonObject = new { chinese = "灰長標準的布咚發" };
            string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
            string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: jsonObject);

            Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試中文序列化失敗");
        }

        [TestMethod]
        [Description(description: "測試英文符號")]
        public void TestEnglishSymbol()
        {
            object jsonObject = new { symbol = @"~`!@#$%^&*()_-+={}[]:;'<>,.?/ " };
            string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
            string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: jsonObject);

            Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試英文符號失敗");
        }

        [TestMethod]
        [Description(description: "測試中文符號")]
        public void TestChineseSymbol()
        {
            object jsonObject = new { chinese_symbol = @"~·@#￥%……&*（）—-+=｛｝【】；：“”‘’《》，。？、" };
            string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
            string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: jsonObject);

            Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試中文符號失敗");
        }

        [TestMethod]
        [Description(description: "測試反序列化數值字串隱式轉換為數值型別")]
        public void TestDeserializeNumber()
        {
            string ajsonString = "{\"Number\":\"123\"}";

            TestClass aJsonObject = Newtonsoft.Json.JsonConvert.DeserializeObject<TestClass>(ajsonString);

            // 報錯，The JSON value could not be converted to System.Int32. Path: $.number | LineNumber: 0 | BytePositionInLine: 15
            TestClass bJsonObject = System.Text.Json.JsonSerializer.Deserialize<TestClass>(json: ajsonString);

            Assert.AreEqual(expected: aJsonObject.Number, actual: bJsonObject.Number, message: "測試反序列化數值字串隱式轉換為數值型別失敗");
        }

        public class TestClass
        {
            public int Number { get; set; }
        }
    }
}
 

先來看看總體的測試結果:

這是 VS 顯示的結果

這是執行 dotnet test 命令列顯示的結果

這個時候需要配個圖

那麼問題來了, 國慶去哪玩比較好呢, 我是誰? 這是哪? 發生了什麼?

可以羅列為以下行為不一致, 當然可能還有更多, 歡迎補充...讓更多小夥伴看到

中文被編碼

部分符號被轉義

數值字串不能隱式轉換為數值型別

這裡有個相關的 issue System.Text.Json: Deserialization support for quoted numbers #39473

隱式轉換會出現精度缺失, 但依舊會轉換成功最終導致資料計算或者資料落庫等安全隱患, 是個潛在的問題, 而 Newtonsoft.Json 等預設支援隱式轉換, 不一定是個合理的方式.

但是大家習慣用了, 先找找如何讓二者行為一致的辦法吧, 可以通過自定義型別轉換器來實現.

// 自定義型別轉換器
public class IntToStringConverter : JsonConverter<int>
{
    public override int Read(ref Utf8JsonReader reader, Type type, JsonSerializerOptions options)
    {
        if (reader.TokenType == JsonTokenType.String)
        {
            ReadOnlySpan<byte> span = reader.HasValueSequence ? reader.ValueSequence.ToArray() : reader.ValueSpan;
            if (Utf8Parser.TryParse(span, out int number, out int bytesConsumed) && span.Length == bytesConsumed)
            {
                return number;
            }

            if (Int32.TryParse(reader.GetString(), out number))
            {
                return number;
            }
        }
        return reader.GetInt32();
    }

    public override void Write(Utf8JsonWriter writer, int value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString());
    }
}
 

使用的時候新增到配置即可, 依此類推可以自行新增更多其他型別轉換器

JsonSerializerOptions options = new System.Text.Json.JsonSerializerOptions();
options.Converters.Add(item: new IntToStringConverter());
//options.Converters.Add(item: new OthersConverter());

System.Text.Json.JsonSerializer.Deserialize<TestClass>(json: ajsonString, options: options);

列舉型別的轉換

System.Text.Json/tests/Serialization/EnumConverterTests.cs#L149 - 官方測試原始碼例子很全

[TestMethod]
[Description(description: "測試列舉反序列化")]
public void TestDeserializeEnum()
{
    // 場景: 前端傳過來字串, 轉成列舉
    JsonSerializerOptions options = new System.Text.Json.JsonSerializerOptions();            
    options.Converters.Add(item: new JsonStringEnumConverter(namingPolicy: null, allowIntegerValues: false));
    string jsonString = "{\"State\":\"2\"}";
    Some aJsonObject = Newtonsoft.Json.JsonConvert.DeserializeObject<Some>(value: jsonString);
    Some bJsonObject = System.Text.Json.JsonSerializer.Deserialize<Some>(json: jsonString, options: options);
    Assert.AreEqual(expected: aJsonObject.State, actual: bJsonObject.State, message: "測試列舉反序列化失敗");
}

[TestMethod]
[Description(description: "測試列舉序列化")]
public void TestSerializeEnum()
{
    // 場景: 後端列舉返回前端, 需要數值
    Some some = new Some
    { 
        State = State.Delete
    };
    string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: some);
    string bJsonString = System.Text.Json.JsonSerializer.Serialize(value: some);
    Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試列舉序列化失敗");
}

public enum State 
{ 
    Create = 1, 
    Update = 2, 
    Delete = 4, 
}

public class Some
{
    public State State { get; set; }
}

不過這裡延伸了一個問題, 在 ASP.NET Core 中的全域性 JsonOptions 中怎麼處理輸入序列化和輸出序列化設定不同的問題?

解決辦法

解決中文會被 Unicode 編碼的問題

這個問題是在部落格園裡找到的一種答案: .NET Core 3.0 中使用 System.Text.Json 序列化中文時的編碼問題

[TestMethod]
[Description(description: "測試中文序列化")]
public void TestChinese()
{
    object jsonObject = new { chinese = "灰長標準的布咚發" };
    string aJsonString = Newtonsoft.Json.JsonConvert.SerializeObject(value: jsonObject);
    string bJsonString = System.Text.Json.JsonSerializer.Serialize(
        value: jsonObject,
        options: new System.Text.Json.JsonSerializerOptions
        {
            Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(allowedRanges: UnicodeRanges.All)
        });

    Assert.AreEqual(expected: aJsonString, actual: bJsonString, message: "測試中文序列化失敗");
}

關鍵在於序列化配置加了一句

new System.Text.Json.JsonSerializerOptions
{
    Encoder = System.Text.Encodings.Web.JavaScriptEncoder.Create(allowedRanges: UnicodeRanges.All)
}

但是一些符號被轉義的問題還是不管用, 尋思了一上午暫時沒找到答案...

至於什麼時候修復此類問題,

我去原始碼 corefx 溜個一圈, 暫時的發現是歸到了 .NET Core 3.1 和 5.0 的開發時間線裡...後面回來發現這不應該啊

但是...難道就這樣了?

懷著受傷的核桃心, 中午又吃了3只大閘蟹...

詭異的是新建 ASP.NET Core API (.NET Core 3.0) 輸出的 JSON 中文和轉義字元都是正常, 如圖:

說明一定是我們開啟的方式不對...回孃家找原始碼, 尋尋匿匿最後發現這麼一句

// If the user hasn't explicitly configured the encoder, use the less strict encoder that does not encode all non-ASCII characters.
jsonSerializerOptions = jsonSerializerOptions.Copy(JavaScriptEncoder.UnsafeRelaxedJsonEscaping);

less strict ? 那對照的意思是 Newtonsoft.Json 一直使用的就是非嚴格模式咯, 而我們習慣使用的也是這種模式.

那麼改下, 還報錯的單元測試都加上配置 JavaScriptEncoder.UnsafeRelaxedJsonEscaping, 果然測試結果順眼多了. 連上面的 UnicodeRanges.All 都不需要配置了.

string bJsonString = System.Text.Json.JsonSerializer.Serialize(
    value: jsonObject,
    options: new System.Text.Json.JsonSerializerOptions
    { 
        Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping
    });

邊上新開了家店, 晚上去吃吃看...

寫在最後

劃重點: 如果之前專案使用的是 Newtonsoft.Json, 升級之後建議還是繼續使用 Newtonsoft.Json, 可以規避上訴N多可能的問題. 如果是新專案或者想少個三方依賴, 可以試試 System.Text.Json, 畢竟更輕量效能更好.

相關推薦

.NET Core 3.0 System.Text.Json 和 Newtonsoft.Json 行為不一致問題及解決辦法

行為不一致 .NET Core 3.0 新出了個內建的 JSON 庫, 全名叫做尼古拉斯 System.Text.Json - 效能更高佔用記憶體更少這都不是事... 對我來說, 很多或大或小的專案能少個第三方依賴項, 還能規避多個依賴項的依賴 Newtonsoft.Json 版本不一致的問題, 是件極美的

在WPF中使用.NET Core 3.0依賴項注入和服務提供程式

前言 我們都知道.NET Core提供了對依賴項注入的內建支援。我們通常在ASP.NET Core中使用它（從Startup.cs檔案中的ConfigureServices方法開始），但是該功能不限於此框架，我們可以在WPF和Windows Forms應用程式中使用它。 實踐 新建專案 將所需的NuGe

ASP.NET Core 3.0 gRPC 身份認證和授權

一.開頭聊騷 本文算是對於 ASP.NET Core 3.0 gRPC 研究性學習的最後一篇了，以後在實際使用中，可能會發一些經驗之文。本文主要講 ASP.NET Core 本身的認證授權和gRPC接入，認證方式採用目前主流的 JWT 結合 IdentityServer4。 二.服務端配置 我們首先需要在服

複製中釋出伺服器和訂閱伺服器內容不一致的解決辦法 （轉載）

在事務複製的過程中，有時候會由於各種各樣的原因導致釋出伺服器和訂閱伺服器的資料不一致，造成這種情況往往是由於以下幾種原因之一： 某個Agent執行出現錯誤或者Agent程序崩潰 比較大型的釋出是使用了備份還原，而不是快照複製初始化，而備份後釋出端修改了資料 非Distribution Agen

idea中的spring boot maven專案的依賴和pom.xml檔案不一致的解決辦法

今天用idea建立了一個spring boot專案，包含了spring security，在pom檔案和專案依賴都存在security依賴的情況下，對專案的訪問連結都會跳轉到輸入賬號密碼的驗證登入頁面，程式碼和跳轉如下：   為了驗證security的

在.Net Core 3.0中嘗試新的System.Text.Json API

.NET Core 3.0提供了一個名為System.Text.Json的全新名稱空間，它支援reader/writer，文件物件模型（DOM）和序列化程式。在此部落格文章中，我將介紹它如何工作以及如何使用。 官方文件 獲取JSON庫 如果以.NET Core為目標,請安裝.NET Core 3.0及以上版

[.Net Core 3.0+/.Net 5] System.Text.Json中時間格式化

### 簡介 .Net Core 3.0開始全新推出了一個名為`System.Text.Json`的Json解析庫，用於序列化和反序列化Json，此庫的設計是為了取代`Json.Net(Newtonsoft.Json)` ### 時間格式化的不足 `System.Text.Json`的優點就不說了，來說一下

這就是你想要的 C#8.0 和.NET Core 3.0

      C# 的下一個主要版本是 8.0。我們已經為它工作了很長一段時間，即使我們構建併發布了次要版本 C# 7.1, 7.2 和 7.3，我仍然對 8.0 將帶來的新特性感到非常興奮。 目前的計劃是 C# 8.0 將與 .NET Core 3.

.NET Core 3.0 Preview 6中對ASP.NET Core和Blazor的更新

我們都知道在6月12日的時候微軟釋出了.NET Core 3.0的第6個預覽版。針對.NET Core 3.0的釋出我們國內的微軟MVP-汪宇傑還發布的官翻版的博文進行了詳細的介紹。具體的可以關注“汪宇傑部落格”公眾號，或者我的“DotNetCore實戰”公眾號然後在歷史文章裡面進行查閱。而我們這篇文章將會介

.NET Core 3.0預覽版7中的ASP.NET Core和Blazor更新

.NET Core 3.0 Preview 7現已推出，它包含一系列ASP.NET Core和Blazor的新更新。 以下是此預覽中的新功能列表： 最新的Visual Studio預覽包括.NET Core 3.0作為預設執行時 Visual Studio中的頂級ASP.NET核心模板 簡化的網頁模板 元件

.NET Core 3.0 構建和部署

Default Executables 預設可執行檔案  在 dotnet build 或 dotnet publish 期間，將建立一個與你使用的 SDK 的環境和平臺相匹配的可執行檔案。 和其他本機可執

.NET Core 3.0 使用Nswag生成Api文件和客戶端程式碼

摘要 在前後端分離、Restful API盛行的年代，完美的介面文件，成了交流的紐帶。在專案中引入Swagger （也稱為OpenAPI），是種不錯的選擇，它可以讓介面資料視覺化。下文將會演示 利用Nswag如何生成Api文件 利用NSwagStudio如何生成客戶端

Centos7 & Docker & Jenkins & ASP.NET Core 2.0 自動化發布和部署

必須 ans http 集成 ase blank ps 命令 local rom 寫在前面 Docker一直很火熱，一直想把原本的Jenkins自動部署工具搬到Docker上面，無奈今年一直忙於各種事情，遲遲未實施這個事情，正好迎來了dotnet core 2.0 的

ASP.NET Core 3.0 實戰：構建多版本 API 介面

第一次在部落格寫分享，請多多捧場，如有歧義請多多包含！ 因為業務需求發展需要，所以API介面的變更升級是必不可少的事情，而原有的介面是不可能馬上停止使用的。例如：Login介面為例，1.0版本之返回使用者的基本資訊，而2.0版本的迭代下，要把使用者祖宗十八代資訊都要返回到客戶端，這時候1.

ASP.NET Core 3.0 實戰：構建多版本 API 接口

版本信息 include swaggerui 各類 val 業務 oca head sem 第一次在博客寫分享，請多多捧場，如有歧義請多多包含！ 因為業務需求發展需要，所以API接口的變更升級是必不可少的事情，而原有的接口是不可能馬上停止使用的。例如：Login接口為例，

ASP.NET Core 3.0：將會擁有更少的依賴

在ASP.NET Core專案中，我們使用一個叫做Microsoft.AspNetCore.App的綜合包。它也被稱為ASP.NET Core Shared Framework，在ASP.NET Core Shared Framework之中包含了很多依賴項，它能滿足一般應用的需求。但是如果你檢視它的依賴項，

ASP.NET Core 3.0 上的gRPC服務模板初體驗(多圖)

XML 代碼管理 grpc 文件內容 作者 發送 需要 web 應用 創建 原文:ASP.NET Core 3.0 上的gRPC服務模板初體驗(多圖)早就聽說ASP.NET Core 3.0中引入了gRPC的服務模板，正好趁著家裏電腦剛做了新系統，然後裝了VS2019的功夫

[翻譯] 使用 .NET Core 3.0 創建一個 Windows 服務

onf 討論 pub pro studio 到來 wing nuget 記錄 原文:[翻譯] 使用 .NET Core 3.0 創建一個 Windows 服務原文: .NET Core Workers as Windows Services 在 .NET Core 3.0

.NET Core 3.0之Configuration原始碼探究(一)

Configuration總體介紹 微軟在.NET Core裡設計出了全新的配置體系，並以非常靈活、可擴充套件的方式實現。從其原始碼來看，其執行機制大致是，根據其Source，建立一個Builder例項，並會向其新增Provider，在我們使用配置資訊的時候，會從記憶體中獲取相應的Provider例項。 .N

.NET Core 3.0 可回收程式集載入上下文

一、前世今生 .NET誕生以來，程式集的動態載入和解除安裝都是一個Hack的技術，之前的NetFx都是使用AppDomain的方式去載入程式集，然而AppDomain並沒有提供直接解除安裝一個程式集的API，而是要解除安裝整個AppDomain才能解除安裝包含在其中的所有程式集。然而解除安裝整個Current