学习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

相关推荐
吾与谁归in36 分钟前
【C#设计模式(13)——代理模式(Proxy Pattern)】
设计模式·c#·代理模式
吾与谁归in37 分钟前
【C#设计模式(14)——责任链模式( Chain-of-responsibility Pattern)】
设计模式·c#·责任链模式
神仙别闹2 小时前
基于C#和Sql Server 2008实现的(WinForm)订单生成系统
开发语言·c#
向宇it11 小时前
【unity小技巧】unity 什么是反射?反射的作用?反射的使用场景?反射的缺点?常用的反射操作?反射常见示例
开发语言·游戏·unity·c#·游戏引擎
九鼎科技-Leo12 小时前
什么是 WPF 中的依赖属性?有什么作用?
windows·c#·.net·wpf
Heaphaestus,RC13 小时前
【Unity3D】获取 GameObject 的完整层级结构
unity·c#
baivfhpwxf202313 小时前
C# 5000 转16进制 字节(激光器串口通讯生成指定格式命令)
开发语言·c#
直裾13 小时前
Scala全文单词统计
开发语言·c#·scala
ZwaterZ14 小时前
vue el-table表格点击某行触发事件&&操作栏点击和row-click冲突问题
前端·vue.js·elementui·c#·vue
ZwaterZ17 小时前
el-table-column自动生成序号&&在序号前插入图标
前端·javascript·c#·vue