为 .net 生态贡献力量——制作并上传 nuget 包(内有独家彩蛋)

C#

浏览数:40

2020-6-13

AD:资源代下载服务

前言

       nuget 是 .net 的常用包管理器,目前已经内置到 Visual Studio 2012 以后的版本。大多数 .net 包都托管在 nuget.org,包括 .net core 框架基础包,得益于 .net core 的模块化设计,很多非核心包都可以进行一定程度的独立升级。

       制作并上传 nuget 包也同时成为为 .net 生态做贡献的重要途经。因为 VS 2019 项目的 csproj 文件支持大量与 nuget 打包相关的配置,所以大多数时候常规的 nuget 包都可以直接用 VS 制作。nuget.org 也只需要上传生成的包文件即可,十分方便。

正文

说明

       在此以我上传到 nuget.org 的包 CoreDX.vJoy.Wrapper 为例进行说明。这个包是一个虚拟游戏手柄驱动的 C# SDK 包装,对应 .net core 3.0+ 平台。如果要使用,需要先安装 vJoy 软件。下载地址:http://vjoystick.sourceforge.net/site/index.php/download-a-install/download。叫 vJoy 的软件有好几个,要注意,有些是用来做键盘映射模拟手柄的用户软件,这个是面向开发者的纯编程控制的虚拟手柄,想做键盘映射得自己写软件。

基础操作

       1、新建类库项目,取名,然后一路下一步完成新建项目。

       2、打开 csproj 文件,调整类库的目标框架,一般情况下尽量使用 netstandard 框架,并尽量降低依赖版本保证兼容性,现在一般是 2.0 居多,早期版本的标准 API 缺失比较严重。也可以右键项目属性进行调整,只不过自由度不如直接编辑项目文件。不过,这些都不是重点,重点是如何同时支持多个框架,这个只能直接编辑项目文件。找到 <TargetFramework>netstandard2.0</TargetFramework>,把 TargetFramework 改成 TargetFrameworks,并用分号隔开不同的框架名。比如我的项目中就是这样:<TargetFrameworks>netcoreapp3.0;netcoreapp3.1</TargetFrameworks>。netcoreapp 也是可以输出为类库的哦。在不同框架使用不同代码实现功能时可以使用条件编译宏解决,例如:#if NETCOREAPP3_1 xxx代码 #endif #if NET461 xxx代码 #endif。然后愉快地写代码。

       3、右键项目属性,找到打包选项卡,编辑 nuget 包信息,比如包名、版本、作者、许可证、说明、版权等等信息。还有很多只能直接改项目文件,大多数都可以在 <PropertyGroup> 节点下输入 <Package,然后跳出来的智能提示就是能用的 nuget 包信息节点。其中如果要上传到 nuget.org,包名必须存在且不能与已有包重名;版本每次上传都必须修改且只能更大;许可证必须指定,比如我的:<PackageLicenseExpression>MIT</PackageLicenseExpression> 指定了使用 MIT 许可证授权。

       4、项目右键打包。注意如果是要上传的正式版包,需要切换到发行模式再打包。

       5、在浏览器打开 www.nuget.org,右上角登录账号,可以使用微软账号或 Github 账号登录。在顶部导航栏找到 Upload,上传,包一般生成到 bin 文件夹。上传完成后会做一些校验并展示预览信息,确认无误后到底部点发布。等待网站进行安全检查和索引创建,一般5到30分钟,就可以在网站和 VS 中找到了。

扩展操作

       像我的包,动态引用了 x86 和 x64 程序集,这些引用是在程序运行时动态加载的,也就是说 nuget 打包工具是不认识的,这些动态引用就不会被打包,等其他人安装包就会出错,文件缺失。如果我要把这些文件一起打包,需要编辑项目文件,就像这样:

  <ItemGroup>
    <Content Include="x64\*.dll" Pack="true" PackageCopyToOutput="true" PackagePath="x64">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="x86\*.dll" Pack="true" PackageCopyToOutput="true" PackagePath="x86">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="CoreDX.vJoy.Wrapper.targets" Pack="true" PackageCopyToOutput="true" PackagePath="build/">
      <CopyToOutputDirectory>Never</CopyToOutputDirectory>
    </Content>
  </ItemGroup>

       其中 Pack=”true” 表示要将 include 的文件一起打包,PackageCopyToOutput=”true” 表示要输出到指定位置, PackagePath 表示把文件输出到包的指定文件夹,因为 nuget 包实际上就是个 zip 压缩文件。

       其中 .targets 是个特殊文件,必须打包到 build 文件夹才有用。如果不打包这个文件,其他人安装包后就会发现依然报错,虽然包中确实有文件,但并不会复制到项目中,targets 文件就是负责告诉项目要怎么处理打包进去的额外文件的,是个 xml 文件,自己手动新建一个 xml 文件修改扩展名就行。内容像这样:

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <ItemGroup>
        <None Include="$(MSBuildThisFileDirectory)\..\x86\vJoyInterface.dll">
            <Link>x86\vJoyInterface.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x86\vJoyInterfaceWrap.dll">
            <Link>x86\vJoyInterfaceWrap.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x64\vJoyInterface.dll">
            <Link>x64\vJoyInterface.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x64\vJoyInterfaceWrap.dll">
            <Link>x64\vJoyInterfaceWrap.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
    </ItemGroup>
</Project>

       有了这个文件,其他人安装包后,项目会自动读取这个文件并把这些文件引用到项目,确保其他人使用正常。

结语

       本来这个东西只是自己写着玩的,结果突发奇想去 nuget 找了一下发现没有完善好用的类似的包,我就想要不上传一个去 nuget 吧。结果就被这个动态引用的 dll 给坑了,打包以后这些 dll 没有引用进来。百度找了半天也没找到解决方案,也懒得搞梯子去谷歌,就直接去 GitHub 找了类似的开源项目源码研究他们是怎么搞的,试了半天才搞定。写下这篇文章记录下心路历程。

       这篇文章也算是.Net Core 为 x86 和 x64 程序集编写 AnyCPU 包装的续集。

       转载请完整保留以下内容并在显眼位置标注,未经授权删除以下内容进行转载盗用的,保留追究法律责任的权利!

  本文地址:https://www.cnblogs.com/coredx/p/12578978.html

  完整源代码:Github

  里面有各种小东西,这只是其中之一,不嫌弃的话可以Star一下。

作者:coredx