基于.NET Core的NuGet包制作、发布和运用流程解析(完整过程)

什么是NuGet包

NuGet 是一个基于 .NET 的开源包管理器，旨在帮助开发者能够更方便地添加、移除和更新项目中的依赖库。可以通过 NuGet 包管理器获取和安装其他开发者分发的 NuGet 包。NuGet 包中包含可重用的代码，该代码可以被添加到多个项目中使用，提高代码的重用性和开发效率。

准备工作

使用 .NET Core 制作 NuGet 包需要先安装 .NET Core SDK。在完成安装后，我们可以选择使用 Visual Studio、VS Code 或其他编辑器来编写 NuGet 包。

制作NuGet包

1. 创建一个.ClassLibrary(.NET Core)的新工程。

2. 安装NuGet包

   打开项目包管理器控制台，运行以下命令安装NuGet.Core和Microsoft.Net.Compilers：

   Install-Package NuGet.Core
Install-Package Microsoft.Net.Compilers

   NuGet.Core是用于创建、维护和分发NuGet包的工具库。

   Microsoft.Net.Compilers是用于将C#代码编译为.NET程序的Roslyn编译器的组件。

3. 编写代码并添加测试

   编写将要添加到NuGet包中的代码，并添加测试以确保其正常工作。在这里，我们不提供详细的代码实现，只需要确保代码可以编译，以便可以将其添加到NuGet包中。

4. 创建.nuspec文件

   使用命令行 nuget spec 创建一个 .nuspec 文件，命名为 ExamplePackage.nuspec。

   nuget spec ExamplePackage

   编辑 .nuspec 文件，填写包信息，特别需要关注的是：

   • <id>：包的唯一标识符。
   • <version>：包的版本号。NuGet 的版本控制遵循语义化版本控制规范，即 主版本号.次版本号.修订版本号。
   • <authors>：包作者。
   • <description>：包描述。
   • <dependencies>：包的依赖项。

   具体 nuspec 文件的格式可以参考 官方文档。

5. 打包NuGet包

   使用命令行 nuget pack 打包 NuGet 包并生成 .nupkg 文件。

   nuget pack ExamplePackage.nuspec

6. 验证NuGet包

   在 NuGet 包管理器中添加本地NuGet源并安装NuGet包。验证NuGet包是否正常工作。

发布NuGet包

1. 注册一个NuGet.org账户

   访问 nuget.org ，注册一个新账户。

2. API密钥

   在nuget.org网站个人中心，获取自己的 API 密钥。

3. 发布NuGet包

   在命令行中运行以下命令将包发布到NuGet.org：

   nuget push ExamplePackage.1.0.0.nupkg -Source https://www.nuget.org/api/v2/package -ApiKey <API Key>

   注意：要将 <API Key> 替换为自己的API密钥。

4. 验证发布

   访问管理的NuGet.org包页以查看刚刚发布的包。

使用NuGet包

1. 安装NuGet包

   在 Visual Studio 的“NuGet 包管理器”中或通过命令行安装NuGet包。

2. 使用NuGet包

   在项目中添加using语句即可使用刚刚安装的NuGet包。

示例

下面用两个示例来进一步说明如何制作和使用NuGet包。

示例1：创建自定义C#常量库

1. 创建一个新的项目，类型为“.NET Standard”类库：

   dotnet new classlib -lang C# -f netstandard2.0

2. 在项目中添加常量类：

   csharp
public static class Constants
{
public const string Hello = "Hello NuGet!";
public const string Goodbye = "Goodbye NuGet!";
}

3. 在项目的根目录中使用如下命令生成一个 .nuspec 文件：

   nuget spec

   编辑 .nuspec 文件，修改如下信息：

   xml
<?xml version="1.0"?>
<package >
<metadata>
<id>ConstantsNuGet</id>
<version>1.0.0</version>
<authors>你的名字</authors>
<owners>你的名字</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>常量类 NuGet 包</description>
<releaseNotes>一个简单的NuGet示例</releaseNotes>
<dependencies>
<dependency id="NETStandard.Library" version="2.0.0" />
</dependencies>
</metadata>
</package>

4. 制作NuGet包

   在命令行使用 nuget pack 命令，打包 .nuspec 文件：

   nuget pack ConstantsNuGet.nuspec

5. 验证NuGet包

   在 NuGet 包管理器中添加本地NuGet源并安装NuGet包：

   nuget sources Add -Name Local -Source C:\packages
nuget install ConstantsNuGet -Source Local -Verbose

6. 发布NuGet包

   登录 nuget.org 网站，创建一个新的 Package，填写相关的信息然后发布。

示例2：使用第三方开源NuGet包

1. 打开 Project.json 文件，添加对 RestSharp NuGet 包库的依赖。

   在项目的根目录中使用如下命令添加依赖：

   dotnet add package RestSharp

2. 创建 REST 客户端类，使用 RestSharp 库进行 RESTful API 调用：

   ```csharp
   public class ApiClient
   {
   private readonly RestClient _client;

   public ApiClient()
   {
       _client = new RestClient();
       _client.BaseUrl = new Uri("https://api.example.com/")
   }
   
   public string GetResources()
   {
       var request = new RestRequest("resources", Method.GET);
       var response = client.Execute(request);
       return response.Content;
   }
   

   }
   ```

3. 在项目中使用 RestSharp 库。

   在需要使用 RestSharp 库的代码文件中使用以下代码：

   csharp
using RestSharp;

   然后在代码中实例化 RestClient 对象，并使用它来调用 RESTful API：

   csharp
var client = new ApiClient();
var resources = client.GetResources();

总结

本文详细介绍了基于.NET Core的 NuGet 包制作、发布和使用流程，从创建类库项目开始，介绍了 NuGet 包的制作和发布过程，最后介绍了如何使用 NuGet 包。希望本文能够为您制作和使用 NuGet 包提供帮助。