学习Source Generators之输出生成的文件

上一篇文章学习了通过获取和解析swagger.json的内容,来生成API的请求响应类。

但是其中无法移动与编辑。

那么本文将介绍如何输出生成的文件。

EmitCompilerGeneratedFiles

在控制台程序中,的PropertyGroup添加 true

再次编译,文件将会输出到obj/Debug/net8.0/generated/GenerateClassFromSwagger.Analysis/GenerateClassFromSwagger.Analysis.ClassFromSwaggerGenerator目录下。

打开目录我们可以看到如下文件:

指定生成目录

前面生成的文件在obj目录下,多少有一些不方便,那么如何指定输出目录呢。

可以通过添加CompilerGeneratedFilesOutputPath到PropertyGroup中来指定我们的输出目录。

如这里配置输出目录为SwaggerEntities:

xml 复制代码
<PropertyGroup>
  <OutputType>Exe</OutputType>
  <TargetFramework>net8.0</TargetFramework>
  <ImplicitUsings>enable</ImplicitUsings>
  <Nullable>enable</Nullable>
  <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
  <CompilerGeneratedFilesOutputPath>SwaggerEntities</CompilerGeneratedFilesOutputPath>
</PropertyGroup>

再次编译项目,可以看到文件输出在我们的项目内。

此时打开文件也是可编辑的状态。

动态目录

除了上面的方法,还可以通过一些环境变量来指定文件输出的目录。

xml 复制代码
	<PropertyGroup>
		<OutputType>Exe</OutputType>
		<TargetFramework>net8.0</TargetFramework>
		<ImplicitUsings>enable</ImplicitUsings>
		<Nullable>enable</Nullable>
		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
		<GeneratedFolder>Generated</GeneratedFolder>
		<CompilerGeneratedFilesOutputPath>$(GeneratedFolder)\$(TargetFramework)</CompilerGeneratedFilesOutputPath>
	</PropertyGroup>

比如我们添加 Generated 到PropertyGroup中,CompilerGeneratedFilesOutputPath的内容改成

(GeneratedFolder)(TargetFramework),那么我们的输出目录将变成Generated\net8.0。

利用这一点我们可以灵活的输出我们的代码文件。

缺点

通过这种方式也有一个缺点,就是我们只能编译一次成功。第二次则会出现报错提示。

所以这种方式适合需要修改输出文件和并且把文件移动到别的位置的情况。

结语

本文介绍了Source Generators生成和输出文件的方式。利用这些功能,我们可以灵活选择是否需要输出代码文件到我们的项目中。

本文代码仓库地址https://github.com/fanslead/Learn-SourceGenerator

相关推荐
何以解忧唯有撸码1 天前
开源】当桌面图标开始打台球:我用 WinForms 做了一桌“真的”台球
c#·winform·自定义控件·gdi
国家一级摸鱼选手1 天前
[Unity]几何碰撞检测:SAT 分离轴定理详解(从数学原理到 C# 实现)
unity·c#·游戏引擎·分离轴定理(sat)·多边形相交
汤姆宝库2 天前
BPE分词器的完整实现:字节对合并与词表构建
开发语言·人工智能·c#
Risehuxyc2 天前
C# 发展历史
开发语言·c#
kyle~2 天前
C# --- 反射
开发语言·c#
暴走约伯3 天前
【VFX工具链源码拆解 09】终极工业化闭环:基于 ID 规则驱动的全自动场景建档、骨骼挂载与男转女场景迁移
unity·c#·游戏引擎·材质
用户788477316344 天前
WinForms 迁移 WPF:Upgrade Assistant 覆盖 30%,剩下 70% 我手写了六周
c#
寂寞的船4 天前
【Unity知识速递】第13期 Unity 内存泄漏排查实战:从 Memory Profiler 到 Lua 引用泄漏的生产级全链路诊断
unity·junit·c#·游戏引擎·lua
用户3721574261355 天前
C# 提取 PDF 附件:包括文档附件和页面注释附件
c#
寂寞的船5 天前
【Unity Bug挑战】第12期 Awaitable 二次 await 死锁之谜 —— 为什么同一个异步操作等两次就卡死?
unity·c#·游戏引擎·bug