Nuget一鍵打包上傳以及高級應用
Nuget是什麼不用多說,大家應該也沒少用過Nuget, 不少人也應該使用過工具打Nuget包,接下來先一步步說明如何使用腳本完成Nuget一鍵打包
Nuget一鍵打包
配置Nuget環境
- 下載地址://www.nuget.org/downloads
- 下載後可以直接放在System32文件夾下,之後便可以直接打開CMD,調用nuget指令,
調用如下圖,說明已經配置好
生成Nuget包必須包含的Nuspec文件
nuget spec ConsoleApp1
生成的nuspec文件如下,其中ConsoleApp1這個Id表示Nuget Package的唯一標識
下圖是我本地文件夾包含的文件
有些文件其實並不是我們想要打進nuget包里的,這時候我們可以編輯Nuspec文件,指定要包含的文件
可以參考官方文檔
nuspec文件描述://docs.microsoft.com/zh-cn/nuget/reference/nuspec
nuget package文件目錄://docs.microsoft.com/zh-cn/nuget/create-packages/creating-a-package#from-a-convention-based-working-directory 文中寫明了Nuget安裝是對不同的文件夾會有不同的操作
Nuget生成package
nuget pack ConsoleApp1.nuspec -Version 1.0.0.0
生成對應的package文件 ConsoleApp1.1.0.0.0.nupkg
大家可以直接將nupkg文件解壓縮,看看裡面具體的文件目錄
Nuget上傳
nuget push ConsoleApp1.*.nupkg -Source YourSourceUrl -ApiKey YourApiKey
其中:
- YourSourceUrl 指nuget伺服器地址
- YourApiKey 指通過伺服器校驗的密鑰
Nuget包刪除
nuget delete ConsoleApp1 1.0.0.0 -Source YourSourceUrl -ApiKey YourApiKey
完整的Nuget一鍵打包流程
現在軟體開發離不開程式碼版本管理,所以nuget一鍵打包也需要和程式碼版本管理結合,這裡以git管理舉例
@echo off
set AssemblyName=ConsoleApp1
set ApiKey=YourApiKey
set SourceUrl=YourSourceUrl
echo git tag (需要手動輸入tag版本號以及注釋)
set /p version=請輸入版本號(Tag名):
set /p comment=請輸入注釋(Tag注釋):
echo git tag -a "%version%" -m "%comment%"
git tag -a "%version%" -m "%comment%"
git push origin "%version%"
if %errorlevel% NEQ 0 exit
nuget pack %AssemblyName%.nuspec -Version %version%
nuget push %AssemblyName%.*.nupkg -Source %SourceUrl% -ApiKey %ApiKey%
del %AssemblyName%.*.nupkg /F /Q
pause
上述流程介紹了一個比較簡單的打包流程,Nuget Package也是相對簡單,但是往往實際情況要複雜的多。
現在問題來了,眾所周知,.NET可以調用C++的dll(實際上.NET的底層都是調用WindowsApi),當你的動態鏈接庫依賴一個或一組C++的dll的時候怎麼辦?如何讓別人在引用你的動態鏈接庫的時候,只需要Nuget安裝一下就行?
方法一:使用Nuget Package中的ContentFiles文件夾
ContentFiles文件夾在安裝的時候沒有任何行為
如何放入ContentFiles文件夾中
編輯Nuspec文件,在Files節點中指定
如何將ContentFiles中的文件輸出到編譯輸出目錄呢
可以自行添加編譯後指令將文件複製到輸出目錄中,以達到使用的目的
但是很顯然,此方法並不是很完美,難道每個引用該package的人都要寫一遍指令來複制文件嗎?
方法二:使用Nuget Package中的Content文件夾
Content文件夾對應的行為是內容複製到項目根目錄。 將「內容」文件夾視為最終使用包的目標應用程式的根目錄
用更直白的話語解釋一下:放在content文件夾的內容在安裝的時候,就像你手動在項目中添加文件一樣
如何放入Content文件夾
同ContentFiles一樣,這裡就不再贅述
如何將Content中的文件輸出到編譯輸出目錄呢
- 同ContentFiles一樣寫指令複製文件
- 因Content的文件會被引入到項目中,可以設置文件的屬性,修改輸出的行為,但是每次已更新就得重新設置
這種方法也不是很完美
方法三:使用Nuget Package中的Build文件夾+自定義的Targets文件
Nuget安裝的時候將Build目錄中的targets文件自動插入到項目中
如何放入Build文件夾中
下圖是我的文件夾目錄
其中components文件夾中包含了一組ConsoleApp1.dll依賴的C++組件
nuspec文件如下圖
targets文件如下
最終打出來的包目錄如下
這種方法只需要使用者直接引用nuget package即可,其他的均無需考慮,不管是依賴的是一個還是一組C++組件,不管是在根目錄下還是包含子目錄,都可以解決上面提到的問題。
實現的原理:nuget在安裝package的時候,將Build目錄中的targets文件直接導入到對應的project文件中,MSBuild執行的時候會將對應的文件輸出到輸出目錄
這裡重點提到一點便是
這個targets文件的名稱必須在當前package的Id一樣(非常重要)本文中都是ConsoleApp1
以上程式碼均為原創分享,若大家認為有不妥的地方,煩請留言指出,在下感激不盡