还在手写重复代码?C# 源码生成器了解一下

引言：重复代码的困境

在软件开发中，编写重复的样板代码是每位开发者都会遇到的烦恼。无论是数据模型间的映射、依赖注入的逐个注册，还是手写验证和序列化逻辑，这些机械性的工作不仅耗费时间，更让代码库变得臃肿，后期维护如同走钢丝。

传统上，我们用反射（Reflection）在运行时动态生成代码来解决一部分问题，但反射带来的性能损耗和启动延迟，在追求极致性能的场景下又成了新的瓶颈。

那么，有没有一种方法，既能消灭样板代码，又能拥有出色的性能？答案是肯定的——C# 源码生成器（Source Generators）。

什么是C#源码生成器

源码生成器可以理解为一个“在编译时帮忙写代码”的插件。它能够在你按下“生成”按钮的那一刻，分析你现有的源代码，并动态地产生新的C#代码文件。

关键在于，它是在编译期间工作，而不是运行时。最终，这些新生成的代码与你的手写代码一起被编译成最终的程序集。这意味着：零运行时开销，高性能，且完全类型安全。

为什么需要源码生成器

让我们看一个具体场景：假设你有一个大型项目，包含200个数据模型。每个模型都需要：

• 一个用于数据传输的对象（DTO）
• 一个繁琐的对象映射逻辑
• 一套验证代码
• 在IoC容器中注册服务

如果手工编写，代码量是海量的，而且一旦模型属性变化，所有相关的样板代码都需要同步修改，极易出错。

源码生成器可以自动化这一切。你只需要定义模型，生成器在编译时就能自动产生所有配套代码，开发者只需要专注于核心业务逻辑。

源码生成器的工作原理

它的工作流程可以分为四步：

1. 编译开始：编译器读取你项目中的所有源代码。
2. 生成器介入：源码生成器被激活，分析编译器提供的语法树和语义信息（如类、属性、方法）。
3. 动态产出：生成器根据分析结果，创建新的C#代码字符串。
4. 合并编译：编译器将你手写的代码和生成器产出的代码合并，一起编译成最终的.dll或.exe文件。

因为代码在编译时就已经生成并固化，所以应用程序在启动后无需再执行任何“生成”操作。

创建一个简单的源码生成器

下面是一个最简示例，演示如何生成一个提供问候语的静态类。注意：现代开发更推荐使用性能更好的 IIncrementalGenerator，但为了清晰理解流程，我们先以基础接口 ISourceGenerator 为例。

using Microsoft.CodeAnalysis;using Microsoft.CodeAnalysis.Text;using System.Text;namespaceSimpleGenerator{    [Generator] // 标记这是一个源码生成器publicclassHelloGenerator : ISourceGenerator    {publicvoidInitialize(GeneratorInitializationContext context)        {// 初始化逻辑，通常留空或用于注册语法接收器        }publicvoidExecute(GeneratorExecutionContext context)        {// 要生成的源代码字符串var source = @"namespace GeneratedNamespace{    public static class GreetingService    {        public static string GetMessage() => ""Hello from Source Generator!"";    }}";// 将生成的代码添加到编译中，文件名通常以 .g.cs 结尾            context.AddSource("GreetingService.g.cs", SourceText.From(source, Encoding.UTF8));        }    }}

编译项目后，你就可以在代码中直接调用 GeneratedNamespace.GreetingService.GetMessage()，无需手动创建这个类。

源码生成器 vs. 反射：一场性能对决

这是开发者最关心的话题。我们来直接对比一下：

简单来说：能用源码生成器解决的问题，就尽量不用反射。尤其是在对性能敏感的基础库和中间件开发中，源码生成器已经成为主流选择①。

四大核心应用场景

源码生成器在实战中非常强大，以下是最有价值的四个应用场景：

1. 自动化对象映射代替AutoMapper等库的运行时反射，在编译时生成实体到DTO的转换代码，性能可以提升一个数量级。

// 传统手工/反射映射：繁琐或低效// dto.Name = user.Name; dto.Age = user.Age;// 源码生成器：自动生成上述代码，调用时性能与手写一致var userDto = Mapper.Map<UserDto>(user);

2. 依赖注入自动注册无需再手动 AddScoped<IUserService, UserService>()。通过扫描带有特定特性（如 [Service]）的类，生成器自动构建注册代码。

3. 高性能序列化System.Text.Json 从 .NET 6 开始就利用源码生成器，可以生成专门的 JSON 序列化代码，替代基于反射的默认实现，大幅提升序列化速度和内存效率。

// 使用源码生成器产生的序列化上下文var serialized = JsonSerializer.Serialize(user, MyJsonContext.Default.User);

4. 强类型日志记录微软的日志框架也支持源码生成器。你可以定义日志方法签名，生成器自动创建高性能的、无参数分配开销的日志扩展方法。

流行框架中的源码生成器

如今，源码生成器已成为 .NET 生态中诸多现代框架的“标配”：

• System.Text.Json：提供 JsonSerializerContext 用于高效序列化。
• ASP.NET Core：优化最小API（Minimal APIs）的路由和参数绑定。
• Microsoft.Extensions.Logging：生成高性能的日志方法。
• Mapperly：一个新兴的、基于源码生成器的高性能对象映射库。

这些框架的实践表明，源码生成器正在引领 .NET 性能优化的新潮流③。

最佳实践与注意事项

虽然源码生成器很强大，但使用不当也会带来问题。请遵循以下建议：

• **优先使用 IIncrementalGenerator**：它内置了缓存机制，能避免重复生成，大幅提升大型项目的编译速度②。
• 保持生成器纯粹：一个生成器只负责一类代码的生成，职责单一。
• 谨慎处理异常：生成器中的异常会导致编译失败，请做好 try-catch 并通过 context.ReportDiagnostic 优雅地报告错误。
• 控制生成代码的体积：只生成必要的代码，避免产生巨大的、难以调试的代码文件。
• 做好测试：为你的生成器编写单元测试，确保生成的代码语法正确、行为符合预期。

何时应该使用源码生成器？ 如果你的项目满足了以下大多数条件，就可以考虑引入：

• 存在大量结构相似的重复代码。
• 反射已经成为性能瓶颈（你可以通过性能分析工具确认）。
• 你希望将一些运行时错误（如类型不匹配）提前到编译时发现。
• 项目有一定规模，自动化带来的收益远大于其初始配置成本。

对于非常简单的小型项目，如果引入源码生成器带来的配置复杂度超过了其好处，那么传统的写法可能更合适。

总结

C# 源码生成器是一项革命性的特性，它从根本上改变了我们处理样板代码和性能问题的方式。通过将代码生成的时机从运行时提前到编译时，它让我们能够：

• 消灭样板代码，专注于业务。
• 获得接近手写代码的极致性能。
• 提供编译时的类型安全，杜绝反射带来的类型错误。

随着 .NET 生态的演进，源码生成器已从一个新特性成长为现代 C# 开发者工具箱中的核心武器。掌握它，你将能构建更简洁、更高效、更健壮的应用程序。

参考文献

① Microsoft Docs. "C# Source Generators". 链接: https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview

② Microsoft Docs. "IIncrementalGenerator Interface". 链接: https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.iincrementalgenerator

③ DevBlogs .NET. "Announcing source generators in .NET 6". 链接: https://devblogs.microsoft.com/dotnet/introducing-net-source-generators/