.NET 7中System.Text.Json源生成器的重大变更解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00242/article/details/148550047

.NET 7中System.Text.Json源生成器的重大变更解析

docs This repository contains .NET Documentation. 项目地址: https://gitcode.com/gh_mirrors/docs2/docs

前言

在.NET 7中，System.Text.Json组件引入了一项重要的行为变更，这可能会影响使用JSON序列化的应用程序。本文将深入分析这一变更的技术细节、影响范围以及应对策略。

变更概述

在.NET 7之前，当使用System.Text.Json源生成器时，如果遇到未在上下文中声明的类型，系统会隐式回退到基于反射的序列化机制。从.NET 7开始，这种行为已被移除，系统将直接抛出异常。

技术背景

System.Text.Json源生成器是.NET 6引入的一项性能优化功能，它通过在编译时生成序列化代码来避免运行时反射，从而提高性能并增强剪裁安全性。

旧版行为示例

考虑以下.NET 6代码：

[JsonSerializable(typeof(Poco1))]
public partial class MyContext : JsonSerializerContext {}

public class Poco1 { }
public class Poco2 { }

// 情况1：使用上下文直接序列化
JsonSerializer.Serialize(new Poco2(), typeof(Poco2), MyContext.Default);
// 抛出InvalidOperationException，因为Poco2未在上下文中声明

// 情况2：使用上下文生成的Options序列化
JsonSerializer.Serialize(new Poco2(), MyContext.Default.Options);
// 成功序列化，因为Options隐式回退到反射

新版行为变化

在.NET 7中，上述两种情况都会抛出异常，确保行为一致性。这种变更使得源生成器的行为更加明确和可预测。

变更原因分析

这项变更主要基于以下考虑：

最小惊讶原则：隐式回退可能导致开发者难以理解实际使用的序列化机制
剪裁安全性：反射回退会破坏源生成器提供的剪裁安全保证
契约明确性：随着自定义序列化契约功能的引入，混合契约源变得更加不可取

影响评估

这项变更属于二进制兼容性变更，可能影响以下场景：

依赖反射回退机制的现有代码
动态类型序列化场景
未完全声明所有需要序列化类型的应用程序

解决方案

推荐方案：完善上下文声明

最佳实践是确保上下文包含所有需要序列化的类型：

[JsonSerializable(typeof(Poco1))]
[JsonSerializable(typeof(Poco2))]
public partial class MyContext : JsonSerializerContext {}

这种方法能充分利用源生成器的所有优势。

备用方案：自定义契约解析器

如果无法修改上下文声明，可以创建混合契约解析器：

var options = new JsonSerializerOptions
{
    TypeInfoResolver = JsonTypeInfoResolver.Combine(
        MyContext.Default,
        new DefaultJsonTypeInfoResolver()
    )
};

兼容性方案：启用全局回退

通过AppContext开关可以全局启用反射回退：

<ItemGroup>
  <RuntimeHostConfigurationOption 
    Include="System.Text.Json.Serialization.EnableSourceGenReflectionFallback" 
    Value="true" />
</ItemGroup>