NuGet是什么?理解与使用
如果你了解python,那么它類似pip。
如果你了解nodejs,那么它類似npm。
如果你了解ruby,那么它類似gem。
對,它就是一個包(package)管理平臺,確切的說是 .net平臺的包管理工具,它提供了一系列客戶端用于生成,上傳和使用包(package),以及一個用于存儲所有包的中心庫即NuGet Gallery,如果有需要也可以搭建自己的私有NuGet庫。
NuGet 官方
對于一個現代化的開發平臺,建立一種讓開發者創建,分享與使用可復用代碼的機制是十分必要的。這種“可復用代碼”被打包后的文件通常被稱作“包”(package),對于.NET(包括 .NET Core)平臺來說這個機制的實現就是NuGet平臺。
NuGet的實現均為開源項目,包括了客戶端工具,服務器,官方網站以及各語言的文檔等。這些項目可以在下面的鏈接中找到。
NuGet on GitHub
NuGet包的本質是一個以nupkg為后綴的zip壓縮文件(你可以將后綴改為.zip后解壓查看里面的內容),其中包含了編譯后的Dll文件以及其他相關文件。下圖顯示nuget包從創建,上傳到被使用的流程。
NuGet的客戶端融合在各類開發工具中,包括但不限于:
.net core SDK中的nuget命令行;
Visual Studio中的nuget工具;
nuget.exe 命令行客戶端;
Visual Studio Code中的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 frameworks
這仍然沒有解決我們的問題:如何決定使用哪個Framework?現在需要引入 .Net Standard,它是一個標準, .net API的標準,用來描述每個Framework的API實現情況。標準的版本越往后支持的API就越多,也就兼容了之前的版本。
當前各個Framework的 .Net Standard版本如下圖(如果你曾經了解Portable Class Libraries(PCL),它已經被 .net standard替代了,所以這里不多做說明。):
最新的內容可以在下面的鏈接中找到。
dotnet/standard
所以要選擇哪個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隱式引用的?,F在我們點擊瀏覽,搜索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 Resolution
現在開始打包我們的類庫項目,首先要為包設置一些諸如版本,作者等相關信息。右鍵點擊項目選擇【屬性】,再選擇【打包】頁,可以在這里輸入包的描述信息。
打開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.dll1>已成功創建包“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 Documentation
那么開始,
一,如何解讀NuGet Gallery上的包信息?
我們先以Newtonsoft.Json為例,在其NuGet頁面上可以看到如下頁面,其中包含了作者,描述,依賴等等信息。
其中重要的依賴關系(部分)如下,
較大字體顯示內容如.NETFramework 2.0表示Target Framework(目標框架),在Target Framework下面的為此Target Framework對應的依賴,所以用一句話可以解讀為:“如果你項目的目標框架也是.NETFramework 2.0,那么你就不需要依賴任何其它包就可以使用這個包”。同樣的下面.NETFramework 1.0的含義就是:“如果你的項目的目標框架為.NETFramework 1.0那么需要引用下面的包后才能使用該包?!辈贿^這些都不需要你手動去引用,NuGet會在你安裝該包時自動安裝其依賴的包。
Newtonsoft.Json這樣的包是NuGet平臺上的典型,除此之外還有一些比較特殊但也非常重要的包。我們來看一下Microsoft.NETCore.Platforms,下面是這個包的頁面。
可以看到這個包竟然沒有任何依賴,這是因為這個包并不包含任何DLL,所以也不需要依賴任何目標框架,NuGet的包可以包含任何你想發布的文件而不僅僅是DLL程序集。
下面在介紹另一種比較特殊的包,元包(Meta Package), Microsoft.AspNetCore.All就是一個元包 ,下面是它的頁面。
頁面上顯示和普通的包并沒有區別,為了更直觀的演示我們把這個包的nupkg文件下載到本地,解壓后可以看到在其lib目錄下面只包含了一個空文件。
其實這個包本身并不包含內容,它通過對其他包的依賴定義自己。元包是一個NuGet包的約定,描述了一組放在一起有意義的包(Metapackages are a NuGet package convention for describing a set of packages that are meaningful together.)
這樣做的原因首先是因為NuGet的包管理是“細粒度”的,原則上每個程序集(DLL)都應該是一個包,這樣可以帶來以下幾個好處:
細粒度的包在開發、測試的過程中與其它包的關聯有限。
細粒度的包可以提供對不同操作系統和CPU的支持。
細粒度的包可以只依賴某個特定的庫。
在發布應用時,未被引用的包不會成為應用的一部分,因此應用程序的體積會有更小。
但是對于某些情況,元包則有更多好處:
在引用大量細粒度包時有更好的用戶體驗
定義了一組經過測試且運行良好的包(包括指定的各種版本)
而下面這個元包比較特殊:Microsoft.NETCore.App,因為它不僅是元包也定義了框架,也就是我們項目里的目標框架(Tagrget Framework)。這會在解讀這類目標框架的元包時造成一定的困惑,以 Microsoft.NETCore.App上的頁面為例,因為他本身定義了目標框架。不過我們應該不會手動去引用這些包,這些包通常是在是設置目標框架是被項目隱式應用的。
下面這張圖描述了這種關系:API定義了框架,框架用于元包中包的選擇,而這些包給你提供了API的實現。
更多資料可以查看下面這篇文章和其中文譯文,對你理解NuGet平臺和包,元包,框架的設計很有幫助。
Packages, metapackages and frameworks
二,如何上傳NuGet包?
要上傳NuGet包到NuGet Gallery,首先你需要一個NuGet賬號或者微軟賬號,然后準備好你的nupkg文件就可以開始上傳了。
下面簡單介紹三種方式:
1,在NuGet Gallery網頁上傳包,這是最方便快捷的方式。登錄NuGet Gallery 點擊Upload菜單進入上傳頁面。
nuget gallery包上傳頁面點擊Browse選擇你的包文件,頁面將讀取你的包信息并顯示在頁面上。
填寫包的文檔相關信息。
填寫包的文檔相關信息確保所有信息正確后就可以點擊Submit發布你的包了!
2,在NuGet Package Expolrer中上傳包,這個應用可以在Windows Store中免費安裝。在使用該工具上傳包之前你需要一個API Key,因為除使用官方上傳頁面的方式外所有其他方式上傳包都需要使用一個API Key,這個Key可以在官方網站獲取。在個人帳號的下拉菜單中選擇API Keys。
進入API Key管理頁面,點擊如下圖的Create,開始創建一個API Key。
填寫好Key的名稱,過期時間,再選擇該Key可以使用的功能和對應的包,點擊確認成功創建后可以看到如下圖的頁面。
點擊Copy就可以拷貝你的Key到剪貼板。有了API Key之后我們使用NuGet Explorer打開我們的包,在File菜單中選擇Publish.
點擊Publish后出現如下界面。
輸入所需的API Key點擊Publish。
3,使用 .net core SDK命令行上傳包,可以執行dotnet nuget push的命令,其中第一個參數為包所在目錄,若再當前目錄可直接填入文件名, -k參數就是我們在上面所獲取到的API Key,如下面的命令行示例。
dotnet nuget push foo.nupkg -k 4003d786-cc37-4004-bfdf-c4f3e8ef9b3a該命令還有許多其他參數,更多信息可前往下面的鏈接:
dotnet nuget push command - .NET Core CLI
需要注意的是包上傳后是不能被刪除的,只能被unlist。鑒于此我沒有真的上傳我的包,因為知道一個完全沒有意義的包在我的賬號里還無法刪除會讓我寢食難安的。大家可以自己動手嘗試。
三,如何安裝本地NuGet包?
以Visual Studio 2017 Community為例,打開你的項目,右鍵點擊項目選擇【管理NuGet程序包】。
然后點擊NuGet程序包管理界面右上角的齒輪,出現下面的設置窗口。
點擊+號新建一個可用程序包源,設置你想要的名稱并選擇源的所在目錄,點擊確定。
再次打開NuGet程序包器,你可以在程序包源選項中看到看添加的源,選中后就可以看到你在該本地路徑中放置的包了!
四,NuGet包的內容與目錄結構?
我們仍以Newtonsoft.Json包為例,將后綴改為.zip并解壓后可以看到以下目錄結構。
其中lib目錄如下圖,它保存了各個目標框架下對應的程序集。
Newtonsoft.Json.nuspec為xml格式的manifest文件保存了包的元數據,如作者,版本,包含內容等等信息。rels,[Content_Types].xml,package為打包時生成的文件。
除了這些目錄外,包內還可以包含runtimes,content,build,tools等文件夾,下面介紹runtimes和content文件夾。
如果你的程序集對不同的操作系統有不同的實現,你需要將這些程序集按照下面的目錄結構放入runtimes文件夾中。
\runtimes \win10-arm \native \lib\uap10.0 \win10-x86 \native \lib\uap10.0 \win10-x64 \native \lib\uap10.0而對于content文件夾,你可以把它看做是目標項目的根目錄,也就是該文件夾下的內容會在包被安裝時拷貝到項目的目錄下。比如包里的content/images目錄在包被安裝之后就會在你的項目目錄下放置一個images目錄。
除了這些主要的文件夾,NuGet包里還可以包含build,tools等文件夾和文件,更多詳細內容可查看下面的文檔。
How to create a NuGet package
希望本篇能讓你對.net的包管理平臺有基本的了解,利用好NuGet平臺會給你以后的項目開發提供很大的幫助。
原文地址:https://zhuanlan.zhihu.com/p/36767572
.NET社區新聞,深度好文,歡迎訪問公眾號文章匯總?http://www.csharpkit.com?
總結
以上是生活随笔為你收集整理的NuGet是什么?理解与使用的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: C# 8.x 先睹为快
- 下一篇: 你竟然没用 Nuget 构建项目?