0

0

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

幻夢星雲

幻夢星雲

发布时间:2025-12-03 17:37:33

|

703人浏览过

|

来源于php中文网

原创

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

.net中的代码生成技术:source generators入门与实战

.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());
}

}

PHP 网络编程技术与实例(曹衍龙)
PHP 网络编程技术与实例(曹衍龙)

PHP网络编程技术详解由浅入深,全面、系统地介绍了PHP开发技术,并提供了大量实例,供读者实战演练。另外,笔者专门为本书录制了相应的配套教学视频,以帮助读者更好地学习本书内容。这些视频和书中的实例源代码一起收录于配书光盘中。本书共分4篇。第1篇是PHP准备篇,介绍了PHP的优势、开发环境及安装;第2篇是PHP基础篇,介绍了PHP中的常量与变量、运算符与表达式、流程控制以及函数;第3篇是进阶篇,介绍

下载

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() 实现(可使用 StringBuilderMicrosoft.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 代码,尤其适合框架开发和高性能场景。虽然学习曲线略陡,但一旦上手,你会发现很多“样板代码”都可以交给编译器自动完成。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

318

2023.08.02

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

258

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

208

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1465

2023.10.24

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

41

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号