C# 怎么创建和使用 NuGet 包_C# NuGet 包创建与使用教程

创建类库项目并编写代码;2. 在.csproj中配置包信息,如PackageId、Version等;3. 生成项目以创建.nupkg文件;4. 将包发布到本地或nuget.org;5. 在其他项目中通过NuGet源安装并使用包。

创建和使用 C# 的 NuGet 包是开发中常见的需求,尤其在团队协作或复用代码时非常有用。下面详细介绍如何从零开始创建一个 NuGet 包,并在其他项目中引用它。

1. 创建要打包的类库项目

首先需要一个 .NET 类库项目,它是 NuGet 包的内容来源。

  • 打开 Visual Studio,选择“创建新项目”
  • 模板选择“类库 (.NET Standard 或 .NET Core/.NET 6+ 推荐)”
  • 命名项目,例如 MyLibrary
  • 编写你要公开的类和方法

示例代码:

namespace MyLibrary
{
    public class Calculator
    {
        public int Add(int a, int b) => a + b;
    }
}

2. 配置项目以支持生成 NuGet 包

NuGet 包信息可以直接写在 .csproj 文件中,无需单独的 .nuspec 文件(推荐方式)。

右键项目 → “编辑项目文件”,添加以下内容:


  
    net6.0
    MyCompany.MyLibrary
    1.0.0
    YourName
    MyCompany
    A simple calculator library.
    calculator;demo
    true
  
说明:
  • PackageId:包的唯一标识,在 nuget.org 上必须唯一
  • Version:版本号,遵循语义化版本(如 1.0.0)
  • GeneratePackageOnBuild:编译时自动生成 .nupkg 文件

3. 构建并生成 NuGet 包

保存项目文件后,重新构建项目:

  • 右键项目 → “重新生成”
  • 在 bin/Debug 或 bin/Release 目录下找到 .nupkg 文件

如果没生成,请检查是否设置了 GeneratePackageOnBuild 为 true。

4. 发布到本地或远程 NuGet 源

发布到本地源(测试用):

  • 创建一个本地文件夹作为源,例如 C:\LocalNuGet
  • 将生成的 .nupkg 文件复制进去
  • 在 Visual Studio 中配置该源:工具 → 选项 → NuGet 包管理器 → 程序包源 → 添加
  • 名称填 Local,源填文件路径(如 C:\LocalNuGet)

发布到 nuget.org(公开):

  • 注册 nuget.org 账号并获取 API Key
  • 使用命令行推送:
nuget push MyCompany.MyLibrary.1.0.0.nupkg YOUR_API_KEY -Source https://api.nuget.org/v3/index.json

确保已安装 NuGet CLI 工具。

5. 在其他项目中使用 NuGet 包

新建一个控制台项目或其他类型项目,然后:

  • 右键项目 → “管理 NuGet 包”
  • 在“浏览”选项卡中,选择你配置的源(如 Local 或 nuget.org)
  • 搜索你的包名(如 MyCompany.MyLibrary)
  • 点击“安装”

代码中引用并使用:

using MyLibrary;

var calc = new Calculator(); Console.WriteLine(calc.Add(2, 3)); // 输出 5

基本上就这些。整个流程不复杂,关键是把项目元数据配置清楚,测试本地包再发布。只要包能正常安装并调用方法,就算成功了。