526互联

如何将项目打包上传到NuGet服务器？

发布时间 2023-09-03 17:59:40作者: 西瓜程序猿

cover.png

作者：西瓜程序猿
主页传送门：https://www.cnblogs.com/kimiliucn


前言

在我写[在.NET Framework中使用RocketMQ(阿里云版)]这篇博客的时候，因为封装了很多代码在单独的DLL中，包括生产者、消费者以及官方SDK等等，然后都在博客中体现出来导致博客大量代码，然后有位读者就建议打包成NuGet包，大家也可以直接安装引入调用，我也觉得很不错，于是就有了这篇文章啦！
image.png

那NuGet是什么呢？NuGet是.NET的包管理器，NuGet客户端工具提供了生成和使用包的能力，NuGet库是所有包作者和消费者使用的中心包存储库。那来看一下如何将代码打包上传到NuGet服务器吧！


一、提前准备

1.1-登录NuGet官网

（1）打开官方网址，然后点击【Sign in with Microsoft】使用微软账号登录。

登录网址：https://www.nuget.org/users/account/LogOn

image.png
（2）输入微软邮箱，然后点击【下一步】进行登录。
image.png


1.2-创建API Key秘钥

（1）点击右上角用户名称，然后点击【API Keys】。
image.png
（2）然后点击【Create】，在输入必填的信息。【KeyName】可以填项目包名，也可以自定义命名，唯一就行了。然后【Glob Pattern】可以填写"*"来替换任何序列。
image.png
API密钥是一种令牌，可以向NuGet Gallery识别身份。NuGet命令行实用程序允许使用API密钥向库提交NuGet包以进行身份验证。
注意要对API密钥保密！如果某个密钥意外泄露，可以随时生成一个新密钥。如有必要，还可以删除现有的API密钥。

注意：要将包推送到nuget.org，必须使用nuget.exe v4.1.0或更高版本，它实现了所需的nuget协议。

（3）然后点击【Copy】复制秘钥，请自行将秘钥保存好，后面会用到。
image.png


二、创建与打包项目

（1） [西瓜程序猿]创建一个名为【Kimi.RocketMQ.NET】类库，目标框架使用【.NET Framework 4.8】，输出类型为【类库】。
image.png
（2）代码编写后，然后使用Release模式生成dll。（我这没有依赖其他任何外部包，如果依赖了，上传打包前需要进行配置）
image.png
image.png
（3） 打开【AssemblyInfo.cs】文件，设置相关属性值和版本。
image.png
（4）为了方便管理文件，我们可以单独新建一个文件夹保存要上传的文件。[西瓜程序猿]这里新建名为【Kimi.RocketMQ.NET】的文件夹。
将编译好的DLL，放在此文件夹。
image.png
然后新建一个【readme.md】用来介绍文件，会在包管理中显示此文件的内容
image.png
在设计一个ICON（图标需要上传到线上，然后将外网能访问的图片地址进行上传到NuGet），作为nuget包的图标。大小建议是128px或256px（注意：文件格式必须是.png）。
image.png
文件夹截图：
image.png


三、上传NuGet

[西瓜程序猿]准备了要上传NuGet上传使用的资源包，如果大家要下载最新版请去官网下载。可以访问下载（如果失效了，请联系我）。

下载地址（编码：0m7AToKX）：https://yongteng.lanzoub.com/ip4nN17bdtbi
密码： 5jh4

文件截图：
image.png


3.1-使用可视化方式【推荐】

3.1.1-下载工具

（1）首页将下载好资源包里面的【PackageExplorer.4.4.72】文件夹，复制到一个固定的地方，不要删除了。[西瓜程序猿]放在【D:\RuanjianAnzhuang\PackageExplorer.4.4.72】路径下了，我们打开【NuGetPackageExplorer.exe】应用程序。
image.png
如果需要在官网下载最新版，可以点击这个链接：

官方下载：https://www.microsoft.com/zh-cn/p/nuget-package-explorer/9wzdncrdmdm3?activetab=pivot:overviewtab

（2）然后点击【Create a new package (CtrI+N)
】创建一个新Package。
image.png


3.1.2-配置相关包

（1）新增【lib】文件夹。
image.png
image.png
（2）然后新选择响应的框架版本，会自动创建版本文件夹，比如[西瓜程序猿]创建的【Kimi.RocketMQ.NET】包是给.NET Framework使用的，我这边就先创建这些。
image.png
image.png
也可以自己创建文件夹，比如没有4.8版本，那可以自行创建一个为【net48】文件夹。
image.png
image.png
（3）然后再每个文件夹中，添加之前打包后的DLL包。
image.png
添加好文件后，目录是这样的：
image.png
（3）然后编辑上传数据，选择【Edit】——>【Edit Metadata】，然后填写相关信息。
image.png
image.png
（4）然后如果有依赖性，还需添加项目依赖，依赖哪些框架比如.NETFramework，.NETStandard等。
image.png
（5）然后编辑完成，看一下效果。
image.png
（5）点击这个可以看到配置的源代码。
image.png
代码：

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
  <metadata>
    <id>Kimi.RocketMQ.NET</id>
    <version>1.0.9</version>
    <title>Kimi.RocketMQ.NET</title>
    <authors>西瓜程序猿</authors>
    <owners>西瓜程序猿</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
    <projectUrl>https://www.cnblogs.com/kimiliucn/p/17662052.html</projectUrl>
    <iconUrl>http://xxx.xxx.xxx.192:7980/Temp_Storage/Images/2023-08-31/9dd8dbcccd314a31835c69ea344b0216.png</iconUrl>
    <description>.NET Framework使用RocketMQ(阿里云版)</description>
    <summary>.NET Framework使用RocketMQ(阿里云版)</summary>
    <releaseNotes>发布1.0.9</releaseNotes>
    <copyright>Copyright © 2023 西瓜程序猿</copyright>
    <language>zh-CN</language>
    <tags>Kimi.RocketMQ.NET</tags>
    <dependencies>
      <group targetFramework=".NETFramework4.8" />
    </dependencies>
  </metadata>
</package>

（6）点击【File】——>【Save As】保存nupkg文件。
image.png
文件截图：
image.png


3.3-上传到nuget服务器

（1）点击【File】——>【Publish】。
image.png
（2）【Publish key or PAT】填写秘钥Key，然后点击【Publish】发布，只要没报错就表示上传成功了。
image.png
（3）稍等1-3分钟，然后会收到上传成功的邮件通知。
image.png
（4）然后可以去官网看看是否此版本发布成功了。

[西瓜程序猿]案例：https://www.nuget.org/packages/Kimi.RocketMQ.NET/

image.png


3.2-使用命令方式

3.2.1-下载软件配置环境

（1）点击下面地址下载软件，选择比较新的版本即可（如果是通过上面的链接下载了资源包，就可以跳过这一步了，直接看第二步骤）。

官网下载：https://www.nuget.org/downloads

image.png
下载好后得到：
image.png
（2）把下载好的【nuget.exe】这个文件，放在一个固定的地方，不要删了。[西瓜程序猿]放在这个目录【D:\RuanjianAnzhuang\nuget_client】。
image.png
（3）然后来配置环境变量。点击【此电脑】，右击【属性】——>高级系统设置——>环境变量——>系统变量——>选择Path——>编辑——>新建——>填写【D:\RuanjianAnzhuang\nuget_client】，大家根据自己路径配置哈。
image.png
（4）测试是否配置成功。按【win+R】键，然后输入cmd，在输入【nuget】命令查看。

命令：nuget

配置成功截图：
image.png
配置失败截图：
image.png


3.2.2-配置全局Push源地址

配置模拟的push源为nuget.org，输入以下命令：

nuget config -Set DefaultPushSource=nuget.org


3.2.3-设置API Key秘钥

使用下面命令进行设置Nuget的API Key（将my_api_key参数替换成自己生成的APIKey）

nuget setApiKey my_api_key

成功截图：
image.png


3.2.4-生成nuspec文件

使用【nuget spec】命令生产.nuspec 文件，文件xml格式的。

命令：nuget spec

成功截图：
image.png


3.2.5-生成nupkg文件

使用【nuget pack】命令生成.nupkg文件。

命令：nuget pack

成功截图：
image.png


3.2.6-上传到nuget服务器

输入以下命令，可以将.nupkg包上传发布到NuGet服务器上（将my_api_key参数替换成自己生成的APIKey）。

命令：nuget push Kimi.RocketMQ.NET.1.0.0.nupkg my_api_key -Source https://api.nuget.org/v3/index.json

上传成功后的邮件：
image.png
上传成功后，需要等待10几分钟。官方需要先审核，审核通过后还需要进行重新索引，然后还需要同步。等待10多分钟后，就可以搜索到上传的包了。
image.png


四、NuGet包的管理

4.1-删除NuGet包

NuGet包无法删除，但是隐藏对应的版本。
image.png
选择要隐藏的版本后，然后取消勾选【List in search results】，然后点击【Save】保存即可。
image.png
效果（隐藏后就搜索不到1.0.0的版本了）：image.png


五、防踩坑指南

5.1-响应状态代码不指示成功: 403

详细错误：

响应状态代码不指示成功: 403 (The specified API key is invalid, has expired, or does not have permission to access the specified package.)。

解决方案：提示秘钥Key无效或者过期了，可以去后台重新生成一个，按照【1.2】步骤操作。


5.2-This package has not been indexed yet

详细错误：

This package has not been indexed yet. It will appear in search results and will be available for install/restore after indexing is complete.

错误截图：
image.png
解决方案：错误提示说"此程序包尚未编制索引。它将出现在搜索结果中，并可在索引完成后进行安装/还原"。所以需要等10分钟左右就行了，等程序包编制好索引就可以在NuGet客户端搜索到了。


5.3-在以下主源中找不到包“Kimi.RocketMQ.NET 1.0.5”

详细错误：

在以下主源中找不到包“Kimi.RocketMQ.NET 1.0.5”:“https://api.nuget.org/v3/index.json”。请验证你的所有联机包源是否都可用，以及是否正确指定了包 ID、版本。

解决方案：等待10分钟左右就能找到了。因为上传成功后需要进行编制索引、同步等操作。


5.4-响应状态代码不指示成功: 409

详细错误：

响应状态代码不指示成功: 409 (A package with ID 'Kimi.RocketMQ.NET' and version '1.0.5' already exists and cannot be modified.)。

错误截图：
image.png
解决方案：说明这个【1.0.9】的版本已经存在了，修改版本号重新发布即可。



原文链接：https://www.cnblogs.com/kimiliucn/p/17675287.html