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

相关推荐
圆滚滚肉肉11 分钟前
后端MVC(控制器与动作方法的关系)
后端·c#·asp.net·mvc
我是唐青枫1 小时前
C#.NET NLog 详解
开发语言·c#·.net
向宇it1 小时前
【unity游戏开发——网络】网络游戏通信方案——强联网游戏(Socket长连接)、 弱联网游戏(HTTP短连接)
网络·http·游戏·unity·c#·编辑器·游戏引擎
一线码农2 小时前
MinHook 如何对 .NET 母体 CoreCLR 进行拦截
c#·.net·代码注入
小老鼠爱大米5 小时前
[C#] WPF - 资源URI
c#·wpf·uri
阿蒙Amon10 天前
《C#图解教程 第5版》深度推荐
开发语言·c#
暖馒10 天前
C#委托与事件的区别
开发语言·c#
JosieBook10 天前
【C#】C#异步编程:异步延时 vs 阻塞延时深度对比
c#·多线程·异步·阻塞
甄天10 天前
WPF中MVVM和MVVMLight模式
c#·wpf·visual studio
冰茶_10 天前
ASP.NET Core API文档与测试实战指南
后端·学习·http·ui·c#·asp.net