.NET中的代码生成技术：Source Generators入门与实战

Source Generators是.NET 5引入的编译时代码生成技术，通过实现ISourceGenerator接口在编译阶段分析语法树并生成C#代码，1. 具备编译时执行、IDE友好和类型安全优势，2. 可用于自动生成ToString、INotifyPropertyChanged、DTO映射等重复代码，3. 结合Roslyn API收集语法节点并生成源文件，4. 支持通过EmitCompilerGeneratedFiles调试生成结果，提升性能且无运行时开销。

.NET 中的 Source Generators 是一种强大的编译时代码生成技术，它允许你在编译过程中自动生成 C# 代码，从而减少重复劳动、提升性能并增强类型安全。与传统的运行时反射不同，Source Generators 在编译阶段工作，生成的代码会直接嵌入到最终程序集中，不会带来额外的运行时开销。

什么是 Source Generators？

Source Generators 是 .NET 5 引入的一项功能，属于 Compiler-as-a-Service 特性的一部分。它通过实现 ISourceGenerator 接口，在 Roslyn 编译器解析语法树时介入，分析现有代码并注入新的 C# 源文件。

它的核心优势包括：

• 编译时执行：不依赖运行时反射，避免性能损耗。
• IDE 友好：生成的代码可在 Visual Studio 或其他编辑器中查看和调试。
• 类型安全：生成的代码参与完整编译流程，错误能在编译期暴露。

如何创建一个简单的 Source Generator

下面通过一个实际例子展示如何构建一个基础的 Source Generator：自动为带有特定属性的类生成 ToString() 方法。

1. 创建项目结构
新建一个 .NET 类库项目，并修改 .csproj 文件以支持源生成器：

  
    netstandard2.0
    preview
  

2. 定义标记属性
在主项目或共享库中定义一个特性用于标识需要处理的类：

[AttributeUsage(AttributeTargets.Class)]
public class AutoToStringAttribute : Attribute { }

3. 实现 Source Generator
添加一个新类实现 ISourceGenerator：

[Generator]
public class ToStringGenerator : ISourceGenerator
{
    public void Initialize(GeneratorInitializationContext context) { }
public void Execute(GeneratorExecutionContext context)
{
    context.RegisterForPostInitialization(pi => pi.AddSource(
        "AutoToString.g.cs",
        SourceText.From(@"
namespace Generated
{
internal static class Welcome
{
public static string Get() => ""Hello from Source Generator!"";
}
}", LanguageNames.CSharp)));
    context.RegisterForSyntaxNotifications(() => new SyntaxReceiver());
}
}
4. 收集目标类并生成代码

使用内部类收集被标记的类：
class SyntaxReceiver : ISyntaxReceiver
{
    public List CandidateClasses { get; } = new();
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
    if (syntaxNode is ClassDeclarationSyntax cds &&
        cds.AttributeLists.SelectMany(al => al.Attributes)
           .Any(a => a.Name.ToString().Contains("AutoToString")))
    {
        CandidateClasses.Add(cds);
    }
}
}
接着在 Execute 中遍历这些类并生成 ToString() 实现（可使用 StringBuilder 或 Microsoft.CodeAnalysis.Text.SourceText 构建字符串）。
实战场景：DTO 映射、INotifyPropertyChanged、序列化优化
Source Generators 在以下常见场景中非常实用：


自动化属性通知：为 ViewModel 自动生成 INotifyPropertyChanged 代码，无需手动触发事件。

DTO 到实体映射：根据命名规则生成高效转换方法，替代 AutoMapper 的反射开销。

JSON 序列化辅助：为特定类型生成定制化的 JsonConverter，提高反序列化速度。

路由注册生成：在 Minimal API 或插件系统中，扫描标记控制器并生成路由配置代码。

调试与测试技巧
由于 Source Generators 运行在编译期间，调试相对复杂。推荐做法包括：

使用 context.ReportDiagnostic() 输出日志信息帮助排查问题。
借助 Roslyn SDK 提供的测试工具进行单元测试。
在调用项目中启用 EmitCompilerGeneratedFiles 查看实际生成的代码：
true
生成的文件通常位于 obj/Debug/netX.X/generated 目录下。

基本上就这些。掌握 Source Generators 能让你写出更聪明、更高效的 .NET 代码，尤其适合框架开发和高性能场景。虽然学习曲线略陡，但一旦上手，你会发现很多“样板代码”都可以交给编译器自动完成。
 
		


# js 
# json 
# node 
# app 
# 工具 
# ai 
# 路由 
# microsoft 
# c# 
# .net 
# Static 
# String 
# 字符串 
# 接口 
# class 
# public 
# internal 
# Namespace 
# 事件 
# ide 
# visual studio 
# 自动化 
# 自动生成 
# 序列化 
# 是一种 
# 你在 
# 遍历 
# 能在 
# 可在 
# 能让 
# 或其他 
# 高性能 
 




相关文章：
 道歉网站制作流程,世纪佳缘致歉小吴事件，相亲网站身份信息伪造该如何稽查？ 
 免费公司网站制作软件,如何申请免费主页空间做自己的网站？ 
 相册网站制作软件,图片上的网址怎么复制？ 
如何在Tomcat中配置并部署网站项目？ 
 网站制作难吗安全吗,做一个网站需要多久时间？ 
 太平洋网站制作公司,网络用语太平洋是什么意思？ 
如何在云虚拟主机上快速搭建个人网站？ 
实现虚拟支付需哪些建站技术支撑？ 
 css网站制作参考文献有哪些,易聊怎么注册？ 
 ,怎么用自己头像做动态表情包？ 
香港服务器如何优化才能显著提升网站加载速度？ 
如何在宝塔面板中创建新站点？ 
 如何制作一个表白网站视频,关于勇敢表白的小标题？ 
 ,网站推广常用方法？ 
建站VPS推荐：2025年高性能服务器配置指南 
建站主机与虚拟主机有何区别？如何选择最优方案？ 
广州网站建站公司选择指南：建站流程与SEO优化关键词解析 
 武清网站制作公司,天津武清个人营业执照注销查询系统网站？ 
javascript中的try catch异常捕获机制用法分析 
 北京专业网站制作设计师招聘,北京白云观官方网站？ 
Android滚轮选择时间控件使用详解 
 早安海报制作网站推荐大全,企业早安海报怎么每天更换？ 
如何快速搭建高效简练网站？ 
MySQL查询结果复制到新表的方法(更新、插入) 
 制作网站软件推荐手机版,如何制作属于自己的手机网站app应用？ 
 教学网站制作软件,学习*后期制作的网站有哪些？ 
如何使用Golang table-driven基准测试_多组数据测量函数效率 
如何快速搭建高效WAP手机网站吸引移动用户？ 
 教学论文网站制作软件有哪些,写论文用什么软件
？ 
韩国服务器如何优化跨境访问实现高效连接？ 
nginx修改上传文件大小限制的方法 
 如何制作算命网站,怎么注册算命网站？ 
 胶州企业网站制作公司,青岛石头网络科技有限公司怎么样？ 
建站之星云端配置指南：模板选择与SEO优化一键生成 
 深圳网站制作费用多少钱,读秀，深圳文献港这样的网站很多只提供网上试读，但有些人只要提供试读的文章就能全篇下载，这个是怎么弄的？ 
 江苏网站制作公司有哪些,江苏书法考级官方网站？ 
如何用5美元大硬盘VPS安全高效搭建个人网站？ 
如何基于云服务器快速搭建网站及云盘系统？ 
 较简单的网站制作软件有哪些,手机版网页制作用什么软件？ 
如何通过虚拟主机快速搭建个人网站？ 
如何在Golang中引入测试模块_Golang测试包导入与使用实践 
 免费制作统计图的网站有哪些,如何看待现如今年轻人买房难的情况？ 
PHP正则匹配日期和时间(时间戳转换)的实例代码 
如何在IIS中新建站点并解决端口绑定冲突？ 
简单实现Android验证码 
 桂林网站制作公司有哪些,桂林马拉松怎么报名？ 
 测试制作网站有哪些,测试性取向的权威测试或者网站？ 
 海南网站制作公司有哪些,海口网是哪家的？ 
 动图在线制作网站有哪些,滑动动图图集怎么做？ 
建站之星如何助力企业快速打造五合一网站？