System.Text.Json 原生支持深度嵌套反序列化,只需类结构匹配 JSON 即可一行获取最深层值;错误常因手动链式 GetProperty 或 PropertyNamingPolicy 未全局生效导致。

用 JsonSerializer.Deserialize 直接映射到嵌套类最稳
深层 JSON 解析出问题,八成是因为试图手动一层层 GetProperty 或拼字符串路径。C# 9+ 的 System.Text.Json 原生支持深度嵌套对象反序列化,只要类结构和 JSON 字段名、类型对得上,一行代码就能拿到最里层的值。
常见错误现象:NullReferenceException 出现在调用 GetProperty("data").GetProperty("items")[0].GetProperty("user").GetProperty("name") 这种链式调用里——任意一级字段缺失或类型不符就崩。
- 定义嵌套类时,所有中间层级必须是
class(不能是record除非显式标记[JsonConstructor]),且字段名默认严格匹配 JSON 键名(大小写敏感) - 如果 JSON 键名含连字符(如
"first-name"),用[JsonPropertyName("first-name")]修饰字段 - 可选字段加
?.或用JsonElement先判断是否存在,再取值;但更推荐直接让整个反序列化失败,暴露数据结构问题 - 性能影响:相比手动遍历
JsonElement,强类型反序列化略慢(约 10–15%),但可读性和维护性碾压,且避免运行时崩溃
示例:
var user = JsonSerializer.Deserialize<apiresponse>(json);
Console.WriteLine(user.Data.Items[0].User.Name); // 直接访问最深层
<p>public class ApiResponse
{
public DataObject Data { get; set; }
}
public class DataObject
{
public List<item> Items { get; set; }
}
public class Item
{
public UserObject User { get; set; }
}
public class UserObject
{
public string Name { get; set; }
}</item></p></apiresponse>
用 JsonDocument.Parse 查找动态路径时,别硬写多层 GetProperty
当 JSON 结构不固定、字段名来自配置或用户输入,就得用动态解析。但手写 root.GetProperty("a").GetProperty("b").GetProperty("c") 是自找麻烦——一来易错,二来无法处理中间字段为数组或 null 的情况。
使用场景:日志解析、第三方 API 返回结构波动、需要按路径字符串(如 "data.items[0].user.profile.avatarUrl")提取值。
- 用
JsonElement.GetProperty(string)前,先用TryGetProperty判断是否存在,避免异常 - 数组索引要单独处理:
GetProperty("items")[0]合法,但GetProperty("items[0]")不合法 —— JSON 路径不是 CSS 选择器 - 路径中含点号(
.)或方括号([])时,不能直接拆分字符串,得用递归解析逻辑或引入Newtonsoft.Json的SelectToken(见下一条) - 兼容性注意:
System.Text.Json不支持 JSONPath,JsonElement没有内置路径查找方法
真要按路径字符串查值?换 JObject.SelectToken 更省事
如果你已经引用了 Newtonsoft.Json,或者项目允许引入它,JObject.SelectToken 就是为这种需求设计的——它原生支持类似 "$.data.items[0].user.name" 的 JSONPath 表达式,自动处理缺失字段、数组越界、类型转换等边界情况。
常见错误现象:SelectToken("data.items[0].user.name") 返回 null,但实际字段存在——忘了加根前缀 $.;或用了单引号包裹字符串(JSONPath 不认单引号)。
- 路径必须以
$.开头,否则被当作相对路径,行为不可靠 - 数组索引支持负数(
[-1])和范围([0:2]),但System.Text.Json完全不支持 - 返回
JToken,可安全调用.ToString()、.Value、() .ToObject,空值不会抛异常() - 性能比
System.Text.Json低约 20–30%,但开发效率和健壮性提升明显,适合非高频解析场景
示例:
var jobj = JObject.Parse(json);
var name = jobj.SelectToken("$.data.items[0].user.name")?.ToString(); // 安全取值
JsonSerializerOptions.PropertyNamingPolicy 设错会导致深层字段全为空
很多人设了 JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase,以为能自动匹配小驼峰 JSON,结果嵌套类里所有字段都反序列化为 null 或默认值——问题不在最外层,而在中间某一级类没继承这个策略。
关键点:PropertyNamingPolicy 只影响**直接在该选项下反序列化的顶层类型**,嵌套子类不会自动继承,除非你显式传入同一 JsonSerializerOptions 实例。
- 全局配置:创建
static readonly JsonSerializerOptions Options = new() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase };,所有Deserialize都显式传它 - 子类字段命名不一致时(比如外层 camelCase,内层 snake_case),不要混用策略,统一用
[JsonPropertyName]标注 - 验证方式:打印
JsonSerializer.Serialize(obj, Options)看输出是否符合预期,比盲猜更可靠 - 容易被忽略的是:泛型方法
Deserialize不会自动捕获全局静态选项,必须显式传参
事情说清了就结束











