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

C# Roslyn生成器与文件 C#如何使用Source Generator在编译时生成代码文件

星辰君_9469

星辰君_9469

发布时间:2026-02-21 09:49:02

|

280人浏览过

|

来源于php中文网

原创

不能。Source Generator 只能通过 context.AddSource 向编译器提供 SourceText,无法写入磁盘文件;其生成代码仅临时参与编译,不落地为物理 .cs 文件,否则破坏可重现性、增量编译及安全性。

c# roslyn生成器与文件 c#如何使用source generator在编译时生成代码文件

Source Generator 生成的代码能写入磁盘文件吗

不能。Source Generator 的核心限制就是:它只能向编译器提供 SourceText,不能创建或写入磁盘上的 .cs 文件。你看到的“生成代码”,其实是被编译器临时加载进当前编译单元的字符串内容,不会落地为项目里的物理文件。

常见错误现象是,在 Generator 里用 File.WriteAllText 或 Directory.CreateDirectory 尝试保存文件——这要么静默失败(因编译器沙箱限制),要么在 MSBuild 过程中抛出 UnauthorizedAccessException 或 NotSupportedException。

使用场景上,Generator 只适用于“参与编译”的需求:比如根据 [MyAttribute] 自动生成类型成员、补全接口实现、注入日志代码等。它不是代码模板工具,也不替代 T4 或 dotnet-sourcelink 这类文件生成器。

想让生成的代码出现在项目里,该怎么做

必须把生成的内容通过 context.AddSource 注入编译流程,由 Roslyn 自动参与后续解析、语义分析和 IL 生成。

  • context.AddSource("MyGenerated.g.cs", SourceText.From(content, Encoding.UTF8)) 是唯一合法入口;文件名后缀建议用 .g.cs(约定俗成,且能被 IDE 自动折叠)
  • 生成的字符串必须是合法 C# 语法,且不能有编译错误,否则整个项目编译失败(不是警告)
  • 不要拼接带 BOM 的字符串,SourceText.From 默认不带 BOM;若手动读取模板再替换,记得用 Encoding.UTF8 显式指定,避免编码错乱导致中文注释变乱码
  • 生成的类/成员必须满足命名空间与可见性规则:比如生成 internal 类时,确保宿主项目没开启 InternalsVisibleTo 外部访问需求,否则调用方看不到

为什么不能直接生成 .cs 文件到项目目录

Roslyn 编译是无状态、可重现的:每次构建都应从相同输入产出相同输出。如果 Generator 擅自写磁盘文件,会导致增量编译失效、CI 环境行为不一致、Git 脏工作区等问题。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

性能影响很实际:磁盘 I/O 会拖慢编译速度,而 Generator 设计目标是在毫秒级完成(通常要求 AD0001(Analyzer took longer than expected)。

兼容性方面,.NET SDK 6+ 的默认编译模式(UseSharedCompilation=false)下,Generator 运行在受限的 AssemblyLoadContext 中,对 System.IO 的多数 API 是禁用的——不是你不小心,而是 runtime 根本不让你调。

那调试 Generator 生成的代码很难看?

确实难,但有路可走。生成的 .g.cs 不会出现在 Solution Explorer,但可在调试时通过以下方式确认内容:

  • 在 Generator 里加断点,把 content 字符串复制出来,粘贴到临时 .cs 文件里手动检查语法
  • 启用 dotnet build -bl 生成 msbuild.binlog,用 MSBuild Structured Log Viewer 查看 “Source Generators” 节点下的输出源码
  • 在项目文件中添加 <emitcompilergeneratedfiles>true</emitcompilergeneratedfiles>,编译后会在 obj/Debug/netX.X/generated/ 下看到实际注入的文件(仅用于调试,勿提交)

最容易被忽略的一点:Generator 的执行时机在语法树绑定前,所以它看不到语义信息(比如某个 INamedTypeSymbol 是否实现了某接口),只能靠语法树遍历 + 属性标记推断。想做深度语义生成,得配合 ISymbol 分析,但必须确保符号已成功解析——否则拿到的是 null,不是报错。

热门AI工具

更多
WorkBuddy

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

蛙蛙写作

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

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

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

豆包大模型

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

DeepSeek

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

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

相关专题

更多
js 字符串转数组
js 字符串转数组

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

1878

2023.08.03

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

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

3024

2023.09.04

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

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

6304

2023.10.24

字符串介绍
字符串介绍

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

6289

2023.11.24

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

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

7854

2024.03.22

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

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

11974

2024.04.29

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

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

6199

2025.07.29

c++字符串相关教程
c++字符串相关教程

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

6907

2025.08.07

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

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