爲 .net 生態貢獻力量——製作並上傳 nuget 包(內有獨家彩蛋)

前言

       nuget 是 .net 的常用包管理器,目前已經內置到 Visual Studio 2012 以後的版本。大多數 .net 包都託管在 nuget.org,包括 .net core 框架基礎包,得益於 .net core 的模塊化設計,很多非核心包都可以進行一定程度的獨立升級。

       製作並上傳 nuget 包也同時成爲爲 .net 生態做貢獻的重要途經。因爲 VS 2019 項目的 csproj 文件支持大量與 nuget 打包相關的配置,所以大多數時候常規的 nuget 包都可以直接用 VS 製作。nuget.org 也只需要上傳生成的包文件即可,十分方便。

正文

說明

       在此以我上傳到 nuget.org 的包 CoreDX.vJoy.Wrapper 爲例進行說明。這個包是一個虛擬遊戲手柄驅動的 C# SDK 包裝,對應 .net core 3.0+ 平臺。如果要使用,需要先安裝 vJoy 軟件。下載地址:http://vjoystick.sourceforge.net/site/index.php/download-a-install/download。叫 vJoy 的軟件有好幾個,要注意,有些是用來做鍵盤映射模擬手柄的用戶軟件,這個是面向開發者的純編程控制的虛擬手柄,想做鍵盤映射得自己寫軟件。

基礎操作

       1、新建類庫項目,取名,然後一路下一步完成新建項目。

       2、打開 csproj 文件,調整類庫的目標框架,一般情況下儘量使用 netstandard 框架,並儘量降低依賴版本保證兼容性,現在一般是 2.0 居多,早期版本的標準 API 缺失比較嚴重。也可以右鍵項目屬性進行調整,只不過自由度不如直接編輯項目文件。不過,這些都不是重點,重點是如何同時支持多個框架,這個只能直接編輯項目文件。找到 <TargetFramework>netstandard2.0</TargetFramework>,把 TargetFramework 改成 TargetFrameworks,並用分號隔開不同的框架名。比如我的項目中就是這樣:<TargetFrameworks>netcoreapp3.0;netcoreapp3.1</TargetFrameworks>。netcoreapp 也是可以輸出爲類庫的哦。在不同框架使用不同代碼實現功能時可以使用條件編譯宏解決,例如:#if NETCOREAPP3_1 xxx代碼 #endif #if NET461 xxx代碼 #endif。然後愉快地寫代碼。

       3、右鍵項目屬性,找到打包選項卡,編輯 nuget 包信息,比如包名、版本、作者、許可證、說明、版權等等信息。還有很多隻能直接改項目文件,大多數都可以在 <PropertyGroup> 節點下輸入 <Package,然後跳出來的智能提示就是能用的 nuget 包信息節點。其中如果要上傳到 nuget.org,包名必須存在且不能與已有包重名;版本每次上傳都必須修改且只能更大;許可證必須指定,比如我的:<PackageLicenseExpression>MIT</PackageLicenseExpression> 指定了使用 MIT 許可證授權。

       4、項目右鍵打包。注意如果是要上傳的正式版包,需要切換到發行模式再打包。

       5、在瀏覽器打開 www.nuget.org,右上角登錄賬號,可以使用微軟賬號或 Github 賬號登錄。在頂部導航欄找到 Upload,上傳,包一般生成到 bin 文件夾。上傳完成後會做一些校驗並展示預覽信息,確認無誤後到底部點發布。等待網站進行安全檢查和索引創建,一般5到30分鐘,就可以在網站和 VS 中找到了。

擴展操作

       像我的包,動態引用了 x86 和 x64 程序集,這些引用是在程序運行時動態加載的,也就是說 nuget 打包工具是不認識的,這些動態引用就不會被打包,等其他人安裝包就會出錯,文件缺失。如果我要把這些文件一起打包,需要編輯項目文件,就像這樣:

  <ItemGroup>
    <Content Include="x64\*.dll" Pack="true" PackageCopyToOutput="true" PackagePath="x64">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="x86\*.dll" Pack="true" PackageCopyToOutput="true" PackagePath="x86">
      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
    </Content>
    <Content Include="CoreDX.vJoy.Wrapper.targets" Pack="true" PackageCopyToOutput="true" PackagePath="build/">
      <CopyToOutputDirectory>Never</CopyToOutputDirectory>
    </Content>
  </ItemGroup>

       其中 Pack="true" 表示要將 include 的文件一起打包,PackageCopyToOutput="true" 表示要輸出到指定位置, PackagePath 表示把文件輸出到包的指定文件夾,因爲 nuget 包實際上就是個 zip 壓縮文件。

       其中 .targets 是個特殊文件,必須打包到 build 文件夾纔有用。如果不打包這個文件,其他人安裝包後就會發現依然報錯,雖然包中確實有文件,但並不會複製到項目中,targets 文件就是負責告訴項目要怎麼處理打包進去的額外文件的,是個 xml 文件,自己手動新建一個 xml 文件修改擴展名就行。內容像這樣:

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <ItemGroup>
        <None Include="$(MSBuildThisFileDirectory)\..\x86\vJoyInterface.dll">
            <Link>x86\vJoyInterface.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x86\vJoyInterfaceWrap.dll">
            <Link>x86\vJoyInterfaceWrap.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x64\vJoyInterface.dll">
            <Link>x64\vJoyInterface.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
        <None Include="$(MSBuildThisFileDirectory)\..\x64\vJoyInterfaceWrap.dll">
            <Link>x64\vJoyInterfaceWrap.dll</Link>
            <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
        </None>
    </ItemGroup>
</Project>

       有了這個文件,其他人安裝包後,項目會自動讀取這個文件並把這些文件引用到項目,確保其他人使用正常。

結語

       本來這個東西只是自己寫着玩的,結果突發奇想去 nuget 找了一下發現沒有完善好用的類似的包,我就想要不上傳一個去 nuget 吧。結果就被這個動態引用的 dll 給坑了,打包以後這些 dll 沒有引用進來。百度找了半天也沒找到解決方案,也懶得搞梯子去谷歌,就直接去 GitHub 找了類似的開源項目源碼研究他們是怎麼搞的,試了半天才搞定。寫下這篇文章記錄下心路歷程。

       這篇文章也算是.Net Core 爲 x86 和 x64 程序集編寫 AnyCPU 包裝的續集。

 

       轉載請完整保留以下內容並在顯眼位置標註,未經授權刪除以下內容進行轉載盜用的,保留追究法律責任的權利!

  本文地址:https://www.cnblogs.com/coredx/p/12578978.html

  完整源代碼:Github

  裏面有各種小東西,這只是其中之一,不嫌棄的話可以Star一下。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章