C# 源代码生成器方法 C#如何创建自己的Source Generator

陌芳酱_2941

陌芳酱_2941

2026-01-31

897人浏览

原创

Source Generator 是 C# 9+ 的编译时代码生成机制,通过实现 IIncrementalGenerator 在 Roslyn 编译阶段注入 partial 类型,用于自动实现接口、生成 DTO、注入日志等,不修改源码、不支持运行时或已编译程序集。

c# 源代码生成器方法 c#如何创建自己的source generator

Source Generator 是什么,它能做什么

Source Generator 是 C# 9+ 提供的编译时代码生成机制,不是运行时反射或模板引擎。它在 Roslyn 编译器执行语法分析阶段介入,通过实现 IIncrementalGenerator 接口,在不修改原始源码的前提下,向编译流水线注入新的 C# 类型(如 partial class)。常见用途包括:自动实现 INotifyPropertyChanged、从 JSON Schema 生成 DTO、为标记了特定 Attribute 的类注入日志/验证逻辑。

它不能替代运行时代码生成(如 Reflection.Emit),也不处理已编译的程序集——只作用于当前项目正在编译的源码树。

创建一个最简 Source Generator 项目

需要两个分离的项目:一个是 generator 本身(类库),另一个是使用它的目标项目(通常为 .NET 6+ SDK 风格的 Console 或 Library)。

实操步骤:

  • 新建类库项目,目标框架设为 netstandard2.0(兼容性最好),添加 NuGet 包:Microsoft.CodeAnalysis.CSharp(v4.0+)、Microsoft.CodeAnalysis.Analyzers(可选但推荐)
  • 添加对 System.Collections.Immutable 的引用(.NET 5+ 已内置,旧版需显式添加)
  • 实现 IIncrementalGenerator,重写 Initialize 方法;不要用传统 ISourceGenerator(已过时)
  • 在目标项目中,以 ProjectReference 方式引用 generator 项目,并设置 OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false"

关键配置示例(目标项目的 .csproj 中):

<itemgroup><projectreference include="..\MyGenerator\MyGenerator.csproj" outputitemtype="Analyzer" referenceoutputassembly="false"></projectreference></itemgroup>

为什么 Initialize 方法里要用 IncrementalValueProvider

Roslyn 的增量编译模型要求 generator 显式声明依赖项(如语法树、语义模型、特定 Attribute),否则无法触发重生成。直接遍历 compilation.SyntaxTrees 会破坏增量性,导致每次编译都全量执行,拖慢构建速度。

正确做法是使用 context.SyntaxProvider + context.CompilationProvider 构建链式管道:

Build n8n workflows from node docs, templates, and schemas through MCP
Build n8n workflows from node docs, templates, and schemas through MCP

当代理需要在设计或调试工作流时结构化访问 n8n 节点、属性、操作和模板示例时,请使用 n8n-MCP,而不是通过原始文档猜测或手动点击 n8n UI。

下载
  • CreateSyntaxProvider 过滤出你关心的语法节点(比如所有带 [AutoLog] 的方法声明)
  • GetSemanticModelAsync 在后续阶段获取语义信息(如判断该方法是否在 partial class 中)
  • 最终用 RegisterSourceOutput 输出生成的代码字符串

错误写法(破坏增量性):

foreach (var tree in context.Compilation.SyntaxTrees) { ... }

正确起点示例:

context.RegisterSourceOutput(
    context.SyntaxProvider
        .CreateSyntaxProvider(
            predicate: static (s, _) => s is MethodDeclarationSyntax m && 
                m.AttributeLists.Any(al => al.Attributes.Any(a => a.Name.ToString() == "AutoLog")),
            transform: static (ctx, _) => ctx.Node as MethodDeclarationSyntax)
        .Where(m => m != null),
    Execute);

生成的代码必须是 partial 且命名空间/类名严格匹配

Source Generator 输出的代码会被 Roslyn 当作普通源文件参与编译,但它不能定义“全新”的非 partial 类——否则会和用户手写的类冲突,报 CS0101: The namespace 'X' already contains a definition for 'Y'。

所以必须遵守:

  • 生成的类型必须声明为 partial class、partial struct 或 partial record
  • 命名空间、类名、泛型参数数量与用户代码完全一致(大小写敏感)
  • 不能生成构造函数或已有成员的重复定义(如已有 public void Foo(),就不能再生成同签名方法)
  • 若需注入字段/方法,建议加唯一后缀(如 __autoLogHandler)避免命名污染

生成内容示例(字符串拼接,非 Roslyn SyntaxFactory):

var code = $$"""
namespace {{@namespace}};
partial class {{className}}
{
    private void __AutoLog_{{methodName}}() { /* ... */ }
}
""";

最容易被忽略的是命名空间嵌套层级和 using 指令缺失——generator 不自动继承目标文件的 using,所有类型引用必须写全名或手动拼 using 行。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json node microsoft c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.08.07

2355

5

json是什么
json是什么

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

2023.08.23

3902

1

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

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

2023.10.13

1296

3

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

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

2025.09.10

4539

7

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

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

2023.08.03

1958

5

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

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

2023.09.04

3224

5

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

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

2023.10.24

6424

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

6649

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

8154

16

热门下载

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

精品课程

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

共101课时 | 21.4万人学习

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

共39课时 | 4.9万人学习