当前位置: 首页 > news >正文

实现“拼好库”,让你的 NuGet 包同时支持库调用和源生成器解析

实现“拼好库”,让你的 NuGet 包同时支持库调用和源生成器解析

CommunityToolkit.Mvvm 同时能够被调用和使用源生成器,但是它是如何实现的呢?本文将提供一个简单的教程。

一、省流

其实像 CommunityToolkit.Mvvm 这样的包看似是一个单独的包,其实是由两部分组成的。

一个项目是无法实现同时支持 API 调用和源生成器的,而实现它们的秘诀就是在 csproj 将两个项目“黏”起来。

示例源码:https://gitee.com/fanbal/pin_source_generator

二、准备“拼好库”

我们需要准备以下三个项目:

  1. 纯源生成器项目
  2. 纯类库项目
  3. 测试用的控制台(用来看我们的源生成器和类库载入是否生效了)

三、纯源生成器项目的大致代码

这个源生成器的功能是解析项目中名为 hello.txt 的附加文件(一定是附加文件!附加文件的概念在我们后面第五节有详细的说明),它会解析其中的文本,并生成一个对应文本作为类名的空的类,第五节我们可以看到相关的效果图。

我们把项目叫做:HelloGen

image

csproj的部分是这样的。

<Project Sdk="Microsoft.NET.Sdk"><PropertyGroup><TargetFramework>netstandard2.0</TargetFramework><EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules><AllowUnsafeBlocks>true</AllowUnsafeBlocks><IsRoslynComponent>true</IsRoslynComponent></PropertyGroup><ItemGroup><PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0"><PrivateAssets>all</PrivateAssets><IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets></PackageReference><PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.14.0" PrivateAssets="all" /></ItemGroup></Project>

这个项目有且仅有一个源生成器:

using Microsoft.CodeAnalysis;
using System.IO;
using System.Linq;namespace HelloGen
{[Generator]public class OHHHGen : IIncrementalGenerator{public void Initialize(IncrementalGeneratorInitializationContext context){var hello = context.AdditionalTextsProvider.Where(i => Path.GetFileName(i.Path) == "hello.txt").Collect();context.RegisterSourceOutput(hello, (ctx, arr) =>{foreach (var item in arr){var text = item.GetText();ctx.AddSource($"{text}.g.cs", $"public class {text}{{public int OHHHHH = 0;}}");}});}}
}

四、纯类库的内容

我们的类库名为 HelloLib,它的结构也及其的简单。

image-1

其中,HelloClass 的内容实在是太简单了,就不另外贴代码了,各位看截图吧。

image-2

重点在于 csproj 的部分喵。

重点如下!

<Project Sdk="Microsoft.NET.Sdk"><PropertyGroup><TargetFramework>netstandard2.0</TargetFramework></PropertyGroup><ItemGroup><None Include="..\HelloGen\bin\$(Configuration)\netstandard2.0\HelloGen.dll"PackagePath="analyzers\dotnet\roslyn4.0\cs"Pack="true"Visible="false" /></ItemGroup>
</Project>

特别是其中的 <None Include="xxxx.dll" PackagePath="analyzers\dotnet\roslyn4.0\cs" Pack="true" Visible="false" /> 这一段。

这一段我是抄自 CommunityToolkit.Mvvm 的,实际上似乎 PackagePath="analyzers/dotnet/cs" 这样的写法也没有问题,可以参考 https://roslyn-analyzers.readthedocs.io/en/latest/create-nuget-package.html 上面的说法喵。

通过这个配置,你就可以将两者拼起来了。

当你完成了这两个之后你就可以导出成 NuGet 包了。
就像这样,至于是 Debug 还是 Release 无所谓的。

image-4

五、测试用的控制台

总之你要一个控制台,然后安装上我们的 NuGet 包,在我们项目就是 HelloLib

这是我们的结构。
image-5

1. 创建一个 hello.txt 的附加文件

总之你需要先放一个 hello.txt 在这里,然后,csproj 的地方你可以参考这个:

<Project Sdk="Microsoft.NET.Sdk"><PropertyGroup><OutputType>Exe</OutputType><TargetFramework>net9.0</TargetFramework><ImplicitUsings>enable</ImplicitUsings><Nullable>enable</Nullable></PropertyGroup><ItemGroup><AdditionalFiles Include="hello.txt" /></ItemGroup><ItemGroup><PackageReference Include="HelloLib" Version="1.0.0" /></ItemGroup></Project>

你有注意到 AdditionalFiles 那一块了吗?

文本的内容非常的简单:

image-6

简单的一句 HelloWorld。

2. 观察源生成器的反应

我们打开分析器,你可以发现这里有一个 HelloWorld.g.cs
image-7

生成的代码如下:

public class HelloWorld{public int OHHHHH = 0;}

3. 直接在代码中使用吧

image-8

你可以发现在智能提示中有自动生成的 HelloWorld 类,当然也包括来自纯类库的 HelloLib。

可喜可贺啊。我们也把代码也会贴到了 gitee 中哦。

六、总结

为了实现这样的“拼好库”,<None Include="xxxx.dll" PackagePath="analyzers\dotnet\roslyn4.0\cs" Pack="true" Visible="false" /> 这一段真的非常重要哦喵。

http://www.zskr.cn/news/49241.html

相关文章:

  • [忘发了]P3710 方方方的数据结构
  • 仿手绘画流程图工具 excalidraw
  • Java CountDownLatch
  • 详细介绍:JVM Java虚拟机
  • [电调]AM32电调调参系列 —— Active brake on stop power 和 Brake on stop的区别
  • 2025年市场上桥洞力学板开发公司排名背后故事:技术与实力的深度解析
  • 2025年重庆脊柱矫正服务权威推荐榜单:中医理疗/经络/正脊服务精选
  • 大气模式
  • 2025年阻燃泡沫批发厂家权威推荐榜单:防水泡沫/密封海绵/阻燃棉源头厂家精选
  • 2025年青年旅舍太空舱源头厂家综合推荐:太空舱民宿/旅游太空舱民宿/景观移动太空舱酒店设备精选指南
  • JAVA根据对象属性名和对象实体获取对象中该属性名的某个注解
  • 2025年11月储能/新能源汽车/机器人/低空飞行器/工业线束生产厂家排行榜:技术实力与品质保障的全面解析
  • Spring Boot Security 实现后台权限管理系统(三)
  • ubuntu开机强制挂载windows分区
  • TOMCAT Docker 容器化部署指南
  • RustFS 重要变更,让容器化部署更安全
  • 2025年口碑好的风冷一体化加热器厂家实力及用户口碑排行榜
  • vscode python2代码debug
  • 2025年知名的远红外节能加热圈厂家推荐及采购指南
  • 2025 年 11 月干燥机厂家推荐排行榜,离心喷雾干燥机,压力喷雾干燥机,气流干燥机,振动流化床干燥机,旋转闪蒸干燥机,回转滚筒干燥机公司推荐
  • 无法获得锁 /var/lib/dpkg/lock-frontend
  • 2025年成都殡仪一条龙公司权威推荐榜单:殡仪/殡仪一条龙/陵园墓地源头公司精选
  • 2025年AI营销服务怎么选
  • 2025年膜结构景观订做厂家口碑推荐
  • 2025年糖果上浆机厂商口碑推荐榜单
  • 2025年汽车棚订做厂家口碑排行榜单
  • linux命令ll显示结果的含义
  • 2025年高精度珩磨机订做厂家推荐榜单
  • Unicode “包含” GB18030吗?
  • 2025年口碑好的呼吸三型瓶四型瓶厂家推荐及采购指南