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

C#如何使用Source Generators C#源生成器入门教程

大枫吖_8525

大枫吖_8525

发布时间:2025-12-13 22:21:21

|

623人浏览过

|

来源于php中文网

原创

Source Generators 是 C# 9 引入的编译时代码生成技术,可在编译阶段自动生成 C# 源文件,不依赖反射、不修改原代码,生成代码具备完整 IDE 支持。

c#如何使用source generators c#源生成器入门教程

Source Generators 是 C# 9 引入的编译时代码生成技术,它能在编译阶段自动为你生成 C# 源文件,不依赖运行时反射,也不修改原始代码——生成的代码会和手写代码一样参与编译、有完整 IDE 支持(跳转、补全、调试)。

一、确认环境与项目结构

确保你使用的是 .NET 5 或更高版本(推荐 .NET 6+),且 SDK 支持 Source Generator。你需要两个项目:

  • 一个“生成器项目”(Class Library,目标框架为 netstandard2.0 或 net6.0,引用 Microsoft.CodeAnalysis.CSharp 和 Microsoft.CodeAnalysis.Analyzers)
  • 一个“使用项目”(如 Console App,引用生成器项目作为 Analyzer,不是普通 ProjectReference)

关键点:生成器项目必须声明为 <packagereference include="Microsoft.CodeAnalysis.CSharp" version="4.0.1" privateassets="all"></packagereference>,并在使用项目中用 <projectreference include="路径\Generator.csproj" outputitemtype="Analyzer" referenceoutputassembly="false"></projectreference> 引入。

二、编写最简 Source Generator

新建一个类实现 ISourceGenerator,重写 Initialize 和 Execute 方法:

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;
using System.Text;
<p>[Generator]
public class HelloGenerator : ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context) { }</p><pre class="brush:php;toolbar:false;">public void Execute(GeneratorExecutionContext context)
{
    var source = @"namespace Generated

{ public static class Greeting { public static string SayHello() => ""Hello from generator!""; } }"; context.AddSource("Greeting.g.cs", SourceText.From(source, Encoding.UTF8)); } }

注意:[Generator] 特性标记必不可少;AddSource 的文件名建议以 .g.cs 结尾,便于识别是生成代码;内容必须是合法 C# 语法,否则编译报错。

outlook-microsoft
outlook-microsoft

微软 Outlook 邮箱和日历管理工具(支持世纪互联版 Office 365)。用于查看、发送、搜索邮件,管理日历日程,创建会议,查询忙闲状态。注意:此功能仅支持世纪互联(21Vianet)版 Microsoft 365,使用 login.chinacloudapi.cn。

下载

三、读取用户代码并生成响应式内容

真正实用的生成器需要分析用户代码。比如:扫描所有标记了 [AutoNotify] 的 partial class,自动生成 INotifyPropertyChanged 实现。

  • 在 Initialize 中注册语法/语义回调(如 context.RegisterForSyntaxNotifications(() => new AutoNotifySyntaxReceiver()))
  • 定义接收器类(ISyntaxContextReceiver)收集感兴趣节点(如 ClassDeclarationSyntax)
  • 在 Execute 中通过 context.Compilation 获取语义模型,检查 Attribute 应用情况
  • 用 SyntaxFactory 或字符串模板拼出新代码,再 AddSource

小技巧:调试生成器较难,可先用 Debugger.Launch()(需在开发机上允许调试),或把生成逻辑抽成独立方法 + 单元测试验证输出字符串是否符合预期。

四、发布与复用(可选但推荐)

想让团队或 NuGet 上其他人使用?把生成器打包成 NuGet 包:

  • 生成器项目设置 <ispackable>true</ispackable>
  • 在 .csproj 中添加 <none include="$(OutputPath)\$(AssemblyName).dll" pack="true" packagepath="analyzers/dotnet/cs"></none>
  • 用 dotnet pack 打包,使用者安装该 NuGet 即自动启用生成器

无需额外配置,也不需要用户手动添加 ProjectReference —— 这是 NuGet 分发生成器的标准方式。

基本上就这些。Source Generator 不复杂但容易忽略细节:版本兼容性、引用方式、调试手段。写好一个能读属性、生成方法、支持泛型的生成器后,你会发现很多重复样板代码(如 DTO 映射、序列化契约、接口实现)都能自动化掉。

热门AI工具

更多
AionClaw
AionClaw Hot

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

DeepSeek

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

蛙蛙写作

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

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

更多
string转int
string转int

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

6839

2023.08.02

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

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

1818

2023.08.03

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

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

2884

2023.09.04

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

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

6204

2023.10.24

字符串介绍
字符串介绍

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

6029

2023.11.24

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

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

7634

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

11454

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

5899

2025.07.29

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app从入门到实战教程
uni-app从入门到实战教程

共0课时 | 0人学习

uni-app x harmony开发指南
uni-app x harmony开发指南

共0课时 | 0人学习

uni-app鸿蒙运行和发行
uni-app鸿蒙运行和发行

共0课时 | 0人学习

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

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