讲师中心 微信公众号
AI工具推荐 视频效率加速

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

陌芳酱_2941

陌芳酱_2941

发布时间:2026-01-31 09:31:20

|

877人浏览过

|

来源于php中文网

原创

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

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" />
</ItemGroup>

为什么 Initialize 方法里要用 IncrementalValueProvider

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

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

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
  • 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 行。

热门AI工具

更多
Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

2075

2023.08.07

json是什么
json是什么

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

3082

2023.08.23

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

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

1036

2023.10.13

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

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

3499

2025.09.10

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

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

1678

2023.08.03

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

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

2544

2023.09.04

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

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

5984

2023.10.24

字符串介绍
字符串介绍

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

5409

2023.11.24

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

共101课时 | 20.9万人学习

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

共39课时 | 4.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn