从 Newtonsoft.Json 迁移到 System.Text.Json

2024-04-24 10:28
文章标签 json system 迁移 text newtonsoft

本文主要是介绍从 Newtonsoft.Json 迁移到 System.Text.Json，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一.写在前面#

System.Text.Json 是 .NET Core 3 及以上版本内置的 Json 序列化组件，刚推出的时候经常看到踩各种坑的吐槽，现在经过几个版本的迭代优化，提升了易用性，修复了各种问题，是时候考虑使用 System.Text.Json 了。本文将从使用层面来进行对比。

System.Text.Json 在默认情况下十分严格，避免进行任何猜测或解释，强调确定性行为。比如：字符串默认转义，默认不允许尾随逗号，默认不允许带引号的数字等，不允许单引号或者不带引号的属性名称和字符串值。 该库是为了实现性能和安全性而特意这样设计的。Newtonsoft.Json 默认情况下十分灵活。

Newtonsoft.Json 使用 13.0.2 版本，基于 .NET 7。

二.序列化#

1.序列化#

定义 Class

public class Cat
{public string? Name { get; set; }public int Age { get; set; }
}

序列化

var cat = new Cat() { Name = "xiaoshi", Age = 18 };Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat));
// output: {"Name":"xiaoshi","Age":18}
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat));
// output: {"Name":"xiaoshi","Age":18}

变化：JsonConvert.SerializeObject()->JsonSerializer.Serialize()

2.忽略属性#

2.1 通用#
[Newtonsoft.Json.JsonIgnore]
[System.Text.Json.Serialization.JsonIgnore]
public int Age { get; set; }

输出：

var cat = new Cat() { Name = "xiaoshi", Age = 18 };Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat));
// output: {"Name":"xiaoshi"}
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat));
// output: {"Name":"xiaoshi"}

变化：无

2.2 忽略所有只读属性#

代码：

public class Cat
{public string? Name { get; set; }public int Age { get;  }public Cat(int age){Age = age;}
}var cat = new Cat(18) { Name = "xiaoshi"};
var options = new System.Text.Json.JsonSerializerOptions
{IgnoreReadOnlyProperties = true,
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"Name":"xiaoshi"}

Newtonsoft.Json 需要自定义 ContractResolver 才能实现：c# - Newtonsoft JSON - Way of ignoring properties without adding [JsonIgnore] - Stack Overflow

2.3 忽略所有 null 属性#

代码：

var cat = new Cat() { Name = null,Age = 18};var op = new Newtonsoft.Json.JsonSerializerSettings()
{NullValueHandling =NullValueHandling.Ignore
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"Name":"xiaoshi"}var options = new System.Text.Json.JsonSerializerOptions
{DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"Name":"xiaoshi"}

默认情况下两者都是不忽略的，需要自行设置

2.4 忽略所有默认值属性#

代码：

var cat = new Cat() { Name = "xiaoshi",Age = };var op = new Newtonsoft.Json.JsonSerializerSettings()
{DefaultValueHandling = DefaultValueHandling.Ignore
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"Name":"xiaoshi"}var options = new System.Text.Json.JsonSerializerOptions
{DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingDefault
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"Name":"xiaoshi"}

不管是引用类型还是值类型都具有默认值，引用类型为 null，int 类型为 0。

两者都支持此功能。

3.大小写#

默认情况下两者序列化都是 Pascal 命名，及首字母大写，在 JavaScript 以及 Java 等语言中默认是使用驼峰命名，所以在实际业务中是离不开使用驼峰的。

代码：

var cat = new Cat() { Name = "xiaoshi",Age = };var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new CamelCasePropertyNamesContractResolver()
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"name":"xiaoshi","age":0}var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"name":"xiaoshi","age":0}

4.字符串转义#

System.Text.Json 默认会对非 ASCII 字符进行转义，会将它们替换为 \uxxxx，其中 xxxx 为字符的 Unicode 代码。这是为了安全而考虑（XSS 攻击等），会执行严格的字符转义。而 Newtonsoft.Json 默认则不会转义。

默认：

var cat = new Cat() { Name = "小时",Age = };var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new CamelCasePropertyNamesContractResolver()
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"name":"小时","age":0}var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"name":"\u5C0F\u65F6","age":0}

System.Text.Json 关闭转义：

var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"name":"小时","age":0}

Newtonsoft.Json 开启转义：

var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new CamelCasePropertyNamesContractResolver(),StringEscapeHandling = StringEscapeHandling.EscapeNonAscii
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"name":"\u5c0f\u65f6","age":0}

5.自定义转换器#

自定义转换器 Converter，是我们比较常用的功能，以自定义 Converter 来输出特定的日期格式为例。

Newtonsoft.Json:

public class CustomDateTimeConverter : IsoDateTimeConverter
{public CustomDateTimeConverter(){DateTimeFormat = "yyyy-MM-dd";}public CustomDateTimeConverter(string format){DateTimeFormat = format;}
}// test
var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new CamelCasePropertyNamesContractResolver(),Converters = new List<JsonConverter>() { new CustomDateTimeConverter() }
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"name":"xiaoshi","now":"2023-02-13","age":0}

System.Text.Json:

public class CustomDateTimeConverter : JsonConverter<DateTime>
{public override DateTime Read(ref Utf8JsonReader reader,Type typeToConvert,JsonSerializerOptions options) =>DateTime.ParseExact(reader.GetString()!,"yyyy-MM-dd", CultureInfo.InvariantCulture);public override void Write(Utf8JsonWriter writer,DateTime dateTimeValue,JsonSerializerOptions options) =>writer.WriteStringValue(dateTimeValue.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
}// test
var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,Converters = { new CustomDateTimeConverter() }
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"name":"xiaoshi","age":0,"now":"2023-02-13"}

两者的使用方法都是差不多的，只是注册优先级有所不同。

Newtonsoft.Json：属性上的特性>类型上的特性>Converters 集合

System.Text.Json：属性上的特性>Converters 集合>类型上的特性

6.循环引用#

有如下定义：

public class Cat
{public string? Name { get; set; }public int Age { get; set; }public Cat Child { get; set; }public Cat Parent { get; set; }
}var cat1 = new Cat() { Name = "xiaoshi",Age = };
var cat2 = new Cat() { Name = "xiaomao",Age = };cat1.Child = cat2;
cat2.Parent = cat1;

序列化 cat1 默认两者都会抛出异常，如何解决？

Newtonsoft.Json：

var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new CamelCasePropertyNamesContractResolver(),ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat1,op));

设置 ReferenceLoopHandling.Ignore 即可。

System.Text.Json：

var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,ReferenceHandler = ReferenceHandler.IgnoreCycles
};
Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat1, options));

等效设置

System.Text.JsonNewtonsoft.Json
ReferenceHandler = ReferenceHandler.PreservePreserveReferencesHandling=PreserveReferencesHandling.All
ReferenceHandler = ReferenceHandler.IgnoreCycles

ReferenceLoopHandling = ReferenceLoopHandling.Ignore

8.支持字段(Field)#

在序列化和反序列时支持字段，字段不能定义为 private。

public class Cat
{public string? Name { get; set; }public int _age;public Cat(){_age = 13;}
}var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver(),
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: {"_age":13,"name":"xiaoshi"}var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,IncludeFields = true // 或者 JsonIncludeAttribute
};Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: {"name":"xiaoshi","_age":13}

System.Text.Json 默认不支持直接序列化和反序列化字段，需要设置 IncludeFields = true或者 JsonIncludeAttribute 特性。

8.顺序#

自定义属性在 Json 输出中的顺序：

public class Cat
{public string? Name { get; set; }[System.Text.Json.Serialization.JsonPropertyOrder()][Newtonsoft.Json.JsonProperty(Order = )]public int Age { get; set; }
}

System.Text.Json 使用 JsonPropertyOrder，Newtonsoft.Json 使用 JsonProperty(Order)

9.字节数组#

Newtonsoft.Json 不支持直接序列化为字节数组，System.Text.Json 支持直接序列化为 UTF-8 字节数组。

System.Text.Json：

var bytes = JsonSerializer.SerializeToUtf8Bytes(cat)

序列化为 UTF-8 字节数组比使用基于字符串的方法大约快 5-10%。

10.重命名#

public class Cat
{public string? Name { get; set; }[System.Text.Json.Serialization.JsonPropertyName("catAge")][Newtonsoft.Json.JsonProperty("catAge")]public int Age { get; set; }
}

重命名 Json 属性名称，System.Text.Json 使用 JsonPropertyName，Newtonsoft.Json 使用 JsonProperty。

11.缩进#

Newtonsoft.Json：

var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver(),// this optionFormatting = Newtonsoft.Json.Formatting.Indented,
};Console.WriteLine(Newtonsoft.Json.JsonConvert.SerializeObject(cat,op));
// output: 
// {
//     "name": "xiaoshi",
//     "catAge": 0
// }

System.Text.Json

var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,// this optionWriteIndented = true,
};Console.WriteLine(System.Text.Json.JsonSerializer.Serialize(cat, options));
// output: 
// {
//     "name": "xiaoshi",
//     "catAge": 0
// }

三.反序列化#

1.反序列化#

定义：

public class Cat
{public string? Name { get; set; }public int Age { get; set; }
}var json = """{"name":"xiaoshi","age":16} """;
Cat cat;

Newtonsoft.Json：

var op = new Newtonsoft.Json.JsonSerializerSettings()
{ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver(),
};cat=Newtonsoft.Json.JsonConvert.DeserializeObject<Cat>(json, op);Console.WriteLine($"CatName {cat.Name}, Age {cat.Age}");
// output: CatName xiaoshi, Age 16

System.Text.Json：

var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,
};cat=System.Text.Json.JsonSerializer.Deserialize<Cat>(json,options);Console.WriteLine($"CatName {cat.Name}, Age {cat.Age}");
// output: CatName xiaoshi, Age 16

变化 JsonConvert.DeserializeObject->JsonSerializer.Deserialize

2.允许注释#

在反序列化过程中，Newtonsoft.Json 在默认情况下会忽略 JSON 中的注释。 System.Text.Json 默认是对注释引发异常，因为 System.Text.Json 规范不包含它们。

var json = """
{"name": "xiaoshi", // cat name"age": 16
}
""";
Cat cat;var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,// 不设置会引发异常ReadCommentHandling = System.Text.Json.JsonCommentHandling.Skip,
};cat=System.Text.Json.JsonSerializer.Deserialize<Cat>(json,options);Console.WriteLine($"CatName {cat.Name}, Age {cat.Age}");
// output: CatName xiaoshi, Age 16

设置 ReadCommentHandling=JsonCommentHandling.Skip即可忽略注释。

3.尾随逗号#

尾随逗号即 Json 末尾为逗号：

无尾随逗号：

{"name": "xiaoshi","age": 16
}

有尾随逗号：

{"name": "xiaoshi","age": 16,
}

System.Text.Json 默认对尾随逗号引发异常，可以通过 AllowTrailingCommas = true 来设置

var json = """
{"name": "xiaoshi","age": 16,
}
""";Cat cat;var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase,AllowTrailingCommas = true,
};cat=System.Text.Json.JsonSerializer.Deserialize<Cat>(json,options);Console.WriteLine($"CatName {cat.Name}, Age {cat.Age}");
// output: CatName xiaoshi, Age 16

尾随逗号一般和允许注释一起使用，因为行注释必须写在引号以后。

4.带引号数字#

在标准 Json 里，数字类型是不带引号的，如：{"Name":"xiaoshi","Age":18}，但有时我们可能会遇到不标准的异类，Newtonsoft.Json 默认是支持直接反序列化为数字类型的，而 System.Text.Json 基于严格的标准出发，默认不支持，但是可配置。

var options = new System.Text.Json.JsonSerializerOptions
{PropertyNamingPolicy = JsonNamingPolicy.CamelCase,NumberHandling = JsonNumberHandling.AllowReadingFromString
};// C# 11 原始字符串
var json="""{"name":"xiaoshi","age":"13"}""";Console.WriteLine(System.Text.Json.JsonSerializer.Deserialize<Cat>(json, options).Age);
// output: 13

设置 NumberHandling = JsonNumberHandling.AllowReadingFromString 即可。

5.Json DOM#

不直接反序列化为对象，比如 Newtonsoft.Json 里的 JObject.Parse。在 System.Text.Json 里可以使用 JsonNode、JsonDocument、JsonObject 等。

6.JsonConstructor#

通过 JsonConstructor 特性指定使用的反序列化构造方法，两者是一致的。

四.无法满足的场景#

官方给出了对比 Newtonsoft.Json 没有直接支持的功能，但是可以通过自定义 Converter 来支持。如果需要依赖这部分功能，那么在迁移过程中需要进行代码更改。

Newtonsoft.JsonSystem.Text.Json
支持范围广泛的类型⚠️ ⚠
将推断类型反序列化为 object 属性⚠️ ⚠
将 JSON null 文本反序列化为不可为 null 的值类型⚠️ ⚠
DateTimeZoneHandling、DateFormatString 设置⚠️ ⚠
JsonConvert.PopulateObject 方法⚠️ ⚠
ObjectCreationHandling 全局设置⚠️ ⚠
在不带 setter 的情况下添加到集合⚠️ ⚠
对属性名称采用蛇形命名法⚠️ ⚠

以下功能 System.Text.Json 不支持：

Newtonsoft.JsonSystem.Text.Json
支持 System.Runtime.Serialization 特性❌❌
MissingMemberHandling 全局设置❌❌
允许不带引号的属性名称❌❌
字符串值前后允许单引号❌❌
对字符串属性允许非字符串 JSON 值❌❌
TypeNameHandling.All 全局设置❌❌
支持 JsonPath 查询❌❌
可配置的限制❌❌

五.结束#

在 Ms Learn(Docs) 和 Google 之间频繁切换写完了这篇文章，希望对大家在从 Newtonsoft.Json 迁移到 System.Text.Json 有所帮助。就我个人而言我是打算使用 System.Text.Json 了。

这篇关于从 Newtonsoft.Json 迁移到 System.Text.Json的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/931496。

相关文章

MySQL查询JSON数组字段包含特定字符串的方法

MySQL查询JSON数组字段包含特定字符串的方法

《MySQL查询JSON数组字段包含特定字符串的方法》在MySQL数据库中,当某个字段存储的是JSON数组,需要查询数组中包含特定字符串的记录时传统的LIKE语句无法直接使用,下面小编就为大家介绍两种... 目录问题背景解决方案对比1. 精确匹配方案（推荐）2. 模糊匹配方案参数化查询示例使用场景建议性能优
阅读更多...
解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题

解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题

《解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘问题》：本文主要介绍解决未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4... 目录未解析的依赖项:‘net.sf.json-lib:json-lib:jar:2.4‘打开pom.XM
阅读更多...
Conda虚拟环境的复制和迁移的四种方法实现

Conda虚拟环境的复制和迁移的四种方法实现

《Conda虚拟环境的复制和迁移的四种方法实现》本文主要介绍了Conda虚拟环境的复制和迁移的四种方法实现,包括requirements.txt,environment.yml,conda-pack,... 目录在本机复制Conda虚拟环境相同操作系统之间复制环境方法一：requirements.txt方法
阅读更多...
SpringBoot排查和解决JSON解析错误(400 Bad Request)的方法

SpringBoot排查和解决JSON解析错误(400 Bad Request)的方法

《SpringBoot排查和解决JSON解析错误(400BadRequest)的方法》在开发SpringBootRESTfulAPI时,客户端与服务端的数据交互通常使用JSON格式,然而,JSON... 目录问题背景1. 问题描述2. 错误分析解决方案1. 手动重新输入jsON2. 使用工具清理JSON3.
阅读更多...
Springboot3+将ID转为JSON字符串的详细配置方案

Springboot3+将ID转为JSON字符串的详细配置方案

《Springboot3+将ID转为JSON字符串的详细配置方案》：本文主要介绍纯后端实现Long/BigIntegerID转为JSON字符串的详细配置方案,s基于SpringBoot3+和Spr... 目录1. 添加依赖2. 全局 Jackson 配置3. 精准控制（可选）4. OpenAPI (Spri
阅读更多...
MySQL JSON 查询中的对象与数组技巧及查询示例

MySQL JSON 查询中的对象与数组技巧及查询示例

《MySQLJSON查询中的对象与数组技巧及查询示例》MySQL中JSON对象和JSON数组查询的详细介绍及带有WHERE条件的查询示例,本文给大家介绍的非常详细,mysqljson查询示例相关知... 目录jsON 对象查询1. JSON_CONTAINS2. JSON_EXTRACT3. JSON_TA
阅读更多...
Java中JSON格式反序列化为Map且保证存取顺序一致的问题

Java中JSON格式反序列化为Map且保证存取顺序一致的问题

《Java中JSON格式反序列化为Map且保证存取顺序一致的问题》：本文主要介绍Java中JSON格式反序列化为Map且保证存取顺序一致的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未... 目录背景问题解决方法总结背景做项目涉及两个微服务之间传数据时，需要提供方将Map类型的数据序列化为co
阅读更多...
使用Java将实体类转换为JSON并输出到控制台的完整过程

使用Java将实体类转换为JSON并输出到控制台的完整过程

《使用Java将实体类转换为JSON并输出到控制台的完整过程》在软件开发的过程中,Java是一种广泛使用的编程语言,而在众多应用中,数据的传输和存储经常需要使用JSON格式,用Java将实体类转换为J... 在软件开发的过程中，Java是一种广泛使用的编程语言，而在众多应用中，数据的传输和存储经常需要使用j
阅读更多...
MySQL 中的 JSON 查询案例详解

MySQL 中的 JSON 查询案例详解

《MySQL中的JSON查询案例详解》：本文主要介绍MySQL的JSON查询的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录mysql 的 jsON 路径格式基本结构路径组件详解特殊语法元素实际示例简单路径复杂路径简写操作符注意MySQL 的 J
阅读更多...
Spring Boot中JSON数值溢出问题从报错到优雅解决办法

Spring Boot中JSON数值溢出问题从报错到优雅解决办法

《SpringBoot中JSON数值溢出问题从报错到优雅解决办法》：本文主要介绍SpringBoot中JSON数值溢出问题从报错到优雅的解决办法,通过修改字段类型为Long、添加全局异常处理和... 目录一、问题背景：为什么我的接口突然报错了？二、为什么会发生这个错误？1. Java 数据类型的“容量”限制
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2