C#怎么创建和使用NuGet包 NuGet包制作与发布方法

14次阅读

最常用方式是基于c#类库项目生成NuGet包:配置PackageId、Version等属性后运行dotnet pack;本地测试需添加文件夹源并安装验证;发布需nuget.org账号及API Key,用dotnet nuget push推送。

C#怎么创建和使用NuGet包 NuGet包制作与发布方法

创建NuGet包:从项目到.nupkg文件

最常用的方式是基于已有的C#类库项目生成NuGet包。确保项目编译通过,且包含你希望对外公开的API(如public类、方法、资源等)。在项目文件(.csproj)中添加以下几行关键配置:

  • PackageId:包的唯一标识,一般用公司/组织名+功能名,如MyCompany.jsonHelper
  • Version:语义化版本号,如1.0.02.1.3-beta
  • TitleDescription:用于NuGet.org页面展示
  • Authors:作者或组织名称
  • PackageProjectUrl(可选):项目主页或gitHub地址

保存.csproj后,在命令行进入项目目录,运行:
dotnet pack --configuration Release
成功后会在bin/Release下生成.nupkg文件。

本地测试NuGet包:不上传也能验证

别急着发布,先本地验证是否能正常安装使用。创建一个空的测试项目(如console app),然后添加本地源:

  • 新建一个文件夹(如C:MyNuGets),把生成的.nupkg文件放进去
  • visual studio中:工具 → 选项 → NuGet包管理器 → 包源 → “+”号添加新源,路径填C:MyNuGets
  • 在测试项目中右键“管理NuGet包”,选择你刚加的源,搜索并安装即可

安装后调用包里的类或方法,确认无类型缺失、无运行时异常,说明包结构基本正确。

发布到NuGet.org:注册、打包、推送三步走

发布前需注册nuget.org账号并获取API Key:

  • 登录后进入“API Keys”页面,点击“Create”,设置Key名称和作用域(推荐限定为仅允许推送到特定包ID)
  • 复制生成的Key(只显示一次!)
  • 命令行执行:dotnet nuget push YourPackage.1.0.0.nupkg -k YOUR_API_KEY -s https://api.nuget.org/v3/index.json

推送成功后,约1–5分钟内包会出现在nuget.org网站上,其他人就能搜到并安装了。注意:包ID一旦被占用,后续版本必须保持相同ID,否则会被视为全新包。

进阶建议:符号包、多框架支持与依赖管理

实际项目中,几个细节容易影响体验:

  • 支持多目标框架:在.csproj里写net6.0;netstandard2.0,打包时自动适配不同环境
  • 嵌入xml文档:启用true,让IntelliSense显示注释
  • 发布符号包(.snupkg):便于调试,加上--include-symbols --symbol-package-format snupkg参数一起推送
  • 声明依赖项:若用到了Newtonsoft.Json等第三方库,在.csproj中用引入,它会自动写入.nuspec依赖节

基本上就这些。不复杂但容易忽略细节,比如版本号没改导致覆盖失败、描述为空影响搜索、没测本地安装就发线上——稳一点,多走一遍本地流程更省事。

text=ZqhQzanResources