system.text.json自定义转换器需手动处理token推进、类型校验和null分支,read/write必须成对实现且不可依赖自动逻辑;注册转换器须类型完全匹配;只读属性需复用默认反序列化逻辑;多态需手动解析$type字段。

System.Text.Json 的自定义转换器不是“加个特性就能跑”,必须手动处理 token 推进、类型校验和 null 分支——漏掉任意一个,JsonSerializer 就会在运行时抛出 InvalidOperationException 或静默丢数据。
怎么写一个基础 JsonConverter<t></t> 类
继承 JsonConverter<t></t> 后,Read 和 Write 方法必须成对实现,且不能依赖“自动跳过”逻辑。比如把 "enabled"/"disabled" 字符串转为 bool:
-
Read中先检查reader.TokenType != JsonTokenType.String,否则直接 throw;再用reader.GetString()获取值,手动比对字符串(注意大小写) -
Write中必须调用writer.WriteStringValue("enabled")或"disabled",不能写writer.WriteBooleanValue(value) - 遇到
reader.TokenType == JsonTokenType.Null时,Read应返回default(T)或null(若 T 是可空引用类型),否则反序列化null字段会崩溃
为什么 JsonSerializerOptions.Converters.Add() 不生效
注册转换器只是第一步,真正决定是否调用它的,是 typetoconvert 是否与泛型参数完全匹配——包括可空修饰、泛型实参、甚至是否是 ref struct。常见失效场景:
- 给
int?注册了JsonConverter<int></int>:不匹配,int?需要JsonConverter<int></int>或泛型工厂 - 类里有个
public List<person> Items { get; set; }</person>,但只注册了PersonConverter:List 本身走默认 converter,不会递归调用 Person 的 converter - 使用
[JsonConverter(typeof(MyConverter))]标记属性,但该属性类型是object:System.Text.Json 不支持为object类型注册 converter,会忽略该特性
如何安全处理只读属性或私有字段
System.Text.Json 默认跳过只读属性和私有字段,强行启用 IncludeFields = true 或 AllowReadOnlyProperties = true 只是“让字段可见”,不代表能正确反序列化。关键在 converter 内部:
- 反序列化只读属性时,
Read方法不能 new 对象再赋值,必须用JsonSerializer.Deserialize(ref reader, options)复用默认逻辑读取子结构,再手动构造目标对象 - 私有字段若带
[field: JsonPropertyName("name")],需确保字段名与 JSON key 一致,否则 converter 里用reader.ReadPropertyName()匹配不到 - .NET 6+ 支持
AllowReadOnlyProperties = true,但前提是类有无参构造函数或标记了[JsonConstructor]的构造函数;否则仍报NotSupportedException: Cannot create an instance of type T
多态反序列化必须自己解析 $type 字段
Newtonsoft.Json 的 $type 是开箱即用的,System.Text.Json 没有等价机制。想支持接口/抽象类反序列化,必须在 Read 中手动读取 $type 字段,再根据字符串决定创建哪个具体类型:
- 先调用
reader.ReadPropertyName()判断是否为"$type",再用reader.GetString()获取类型名 - 用
Type.GetType(typeName)或预注册的类型映射表查到实际 Type,再调用JsonSerializer.Deserialize(ref reader, targetType, options) - 注意:此时不能再用当前 converter 的
Read方法递归调用,否则栈溢出;必须切换上下文,用新targetType触发对应 converter - 序列化时也要在
Write开头手动写入"$type"字段,否则下游无法还原类型
最易被忽略的一点:所有手动推进 Utf8JsonReader 的操作都不可逆——reader.Skip() 会跳过整个 token,但如果你在判断分支里忘了调用它,下一次 Read 就会卡在同一个位置,导致无限循环或错位解析。写完 converter 必须用含嵌套对象、null、异常格式的 JSON 样本全覆盖测试。










