NuGet是什么？理解与使用（上）

如果你了解python，那么它类似pip。

如果你了解nodejs，那么它类似npm。

如果你了解ruby，那么它类似gem。

对，它就是一个包（package）管理平台，确切的说是 .net平台的包管理工具，它提供了一系列客户端用于生成，上传和使用包（package），以及一个用于存储所有包的中心库即NuGet Gallery，如果有需要也可以搭建自己的私有NuGet库。

NuGet 官方www.nuget.org

对于一个现代化的开发平台，建立一种让开发者创建，分享与使用可复用代码的机制是十分必要的。这种“可复用代码”被打包后的文件通常被称作“包”（package），对于.NET（包括 .NET Core）平台来说这个机制的实现就是NuGet平台。

NuGet的实现均为开源项目，包括了客户端工具，服务器，官方网站以及各语言的文档等。这些项目可以在下面的链接中找到。

NuGet on GitHubgithub.com

NuGet包的本质是一个以nupkg为后缀的zip压缩文件（你可以将后缀改为.zip后解压查看里面的内容），其中包含了编译后的Dll文件以及其他相关文件。下图显示nuget包从创建，上传到被使用的流程。

NuGet的客户端融合在各类开发工具中，包括但不限于：

.net core SDK中的nuget命令行；
Visual Studio中的nuget工具；
nuget.exe 命令行客户端；
Visual Studio Code中的nuget插件；

nuget客户端工具

在了解了nuget大致概念后我们可以通过发布一个nuget包来更仔细的了解如何使用nuget以及其中的重要概念。

下文会以开发中最常接触到的Visual Studio（本文使用Visual Studio 2017 Community ）做为演示工具来创建一个nuget包。要创建一个包首先需要一个 .net项目，可以看到项目的创建页面有很多选择，类库项目就可以选择三种（.net core的类库项目未显示在截图中） .Net Core；.Net Framework 还有 .Net Standard，到底应该选择哪一种呢？

Visual Studio 2017 项目创建窗口

为了做出选择，我们首先要深入理解TFMs和 .net standard这两个概念。首先创建一个 .net core类库项目。

.net core类库项目结构

在项目目录中打开csproj文件可以看见下面的内容。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netcoreapp2.0</TargetFramework>
  </PropertyGroup>

</Project>

可以看到该项目的TargetFramework为netcoreapp2.0，这里的netcoreapp2.0 就是TFMs，即Tagrget Framework Monikers 翻译过来就是“目标框架别名”，这个值指定了这个项目是跑在哪个Framework上的。

如今 .net平台有各种版本的Framework，在 .net core之前有 .Net Framework 1.0一直到现在的4.7等等各种版本， .net core现在有1.0/1.1/2.0/2.1。所有这些版本都有自己的代号/别名。全部的TFMs可以在下面的链接找到。

Target frameworksdocs.microsoft.com

这仍然没有解决我们的问题：如何决定使用哪个Framework？现在需要引入 .Net Standard，它是一个标准， .net API的标准，用来描述每个Framework的API实现情况。标准的版本越往后支持的API就越多，也就兼容了之前的版本。

当前各个Framework的 .Net Standard版本如下图（如果你曾经了解Portable Class Libraries（PCL），它已经被 .net standard替代了，所以这里不多做说明。)：

最新的内容可以在下面的链接中找到。

dotnet/standardgithub.com

所以要选择哪个Framework，首先要确定的是：1）你的项目要使用哪些API？2）你项目要兼容哪些Framework? 总的来说：

选择更高的版本，你将有更多的API可以使用。（更丰富的API）
选择更低的版本，有更多的项目可以使用你的库。（更好的兼容性）

所以 .net standard的选择原则就是：在API够用的情况下选择尽量低的 .net standard标准。这需要根据实际的项目需求来进行判断。

了解了TFMs和 .net standard后我们绕回来说NuGet，创建一个 .net standard 2.0 类库项目。

打开csproj我们可以看到

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>

</Project>

可以看到TargetFramework是netstandard2.0。如果我们需要更改TargetFraamework，可以选择项目【属性】在【应用程序】页面可以进行更改。

目标框架修改

为了演示我们为项目添加一个第三方包Newtonsoft.Json，右键点击项目选择管理NuGet程序包。

打开后可以在Visual Studio左侧看到下面的界面。

这里显示了项目已安装的包，这个包由我们选择的Target Framework隐式引用的。现在我们点击浏览，搜索Newtonsoft.Json。

120M的下载量，可见现在json的流行程度

点击安装。

安装完成后可以看到程序包管理器输出以下信息，并且引用中也添加了新的项目。

但是我并没有在项目文件夹下找到任何Newtonsoft.Json的程序集，包在哪？其实包被下载到了一个nuget公共目录，在我的Windows10系统上是 C:\Users\wangl\.nuget\packages，这样nuget包就不会被重复下载。而在项目中nuget仅仅将依赖信息写入了csproj项目文件与obj文件夹中的project.assets.json，其中csproj项目文件中的内容如下。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Newtonsoft.Json" Version="11.0.2" />
  </ItemGroup>

</Project>

包所依赖的内容并不会被打包到最后的.nupkg文件中，NuGet只是将依赖信息写入包，在最终使用这些包的应用程序编译时还原所有的依赖。

至此我们简单了解了NuGet给项目添加引用的过程。对于更复杂情况的引用，如下图

项目引用示例

这个项目的依赖树中有三个对B包的引用，而三个包的版本要求可能是不相同的，但幸好我们只需要关心我们项目直接引用的包，因为Nuget会帮我们管理所有包的依赖并且对于被多次引用的包，Nuget会找出满足该包所有使用者的版本（不过因为版本要求冲突而找不到适合包的情况是有可能的）。如果需要更详细的了解nuget如何解析项目包的引用可以前往下面的链接。

NuGet Package Dependency Resolutiondocs.microsoft.com

现在开始打包我们的类库项目，首先要为包设置一些诸如版本，作者等相关信息。右键点击项目选择【属性】，再选择【打包】页，可以在这里输入包的描述信息。

打开csproj项目文件，可以看到这些信息也是保存在其中的。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <ApplicationIcon />
    <OutputType>Library</OutputType>
    <StartupObject />
    <Authors>FishNo6</Authors>
    <Company>FishNo6</Company>
    <Product>DemoPackage</Product>
    <Version>1.0.1</Version>
    <AssemblyVersion>1.0.0.1</AssemblyVersion>
    <FileVersion>1.0.0.1</FileVersion>
    <Description>This package is a demonstration for Nuget package.</Description>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Newtonsoft.Json" Version="11.0.2" />
  </ItemGroup>

</Project>

填写好信息后保存。回到解决方案，右键点击项目选择【打包】，可以看到以下输出。

1>------ 已启动生成: 项目: FishNo6.DemoPackage, 配置: Debug Any CPU ------
1>FishNo6.DemoPackage -> E:\labs\FishNo6.DemoPackage\FishNo6.DemoPackage\bin\Debug\netstandard2.0\FishNo6.DemoPackage.dll
1>已成功创建包“E:\labs\FishNo6.DemoPackage\FishNo6.DemoPackage\bin\Debug\FishNo6.DemoPackage.1.0.1.nupkg”。
========== 生成: 成功 1 个，失败 0 个，最新 0 个，跳过 0 个 ==========

在对应目录就可以找到nupkg包文件了。如果你的电脑安装了NuGet Package Explorer可以直接双击打开包来查看信息，这个应用可以在Window Store中安装。

到此我们成功创建了一个NuGet包。

下篇内容包括如何将包上传到NuGet Gallary（NuGet官方库）以及更深入的了解NuGet平台。

最后附上NuGet官方文档。

NuGet Documentationdocs.microsoft.com

本文的目的是记录与分享自己的学习过程和个人你的看法。如果对你有任何帮助深感荣幸，若有任何纰漏烦请指正。如有任何问题请在评论里留言，我会尽量解答。

sinolover

发布了721 篇原创文章 · 获赞 71 · 访问量 9万+

私信关注

NuGet是什么？理解与使用（上）

猜你喜欢