在VS 2017 下創建 Xamarin NuGet Package

最近在做一個Xamarin for android的項目，有個需求是一次可以從相冊中選擇多張圖片，但是 android API<19 的版本還不支持一次選擇多張圖片，在網上找了一下，發現原生的組件有很多並且都非常好用，也找到了很多原生的通過Binding 技術生成的 Xamarin for android的組件但是，都不好使，有的是Glide 版本沖突，我本身項目也是使用了Glide的（Glide 的每一個版本的升級，API的變化都很劇烈，上一個版本的方法在下一個版本里甚至沒有過度就直接去掉了）， 還有就是V4包和V7包沖突，搞得人很郁悶， 后來想將java原生的Binding一個來用，從網上直接下載下來的jar 或者 aar包，通過Binding項目創建出來dll后引進去所有設置都完成了，發現還是出現了各種包依賴的問題，用不了。 如果要想創建出來能用的Binding項目就需要對原項目使用的依賴和自己項目當前用的依賴包進行對比，並重新編譯生成新的jar或者arr文件然后再Binding才可以， 但是一個問題來了，如果以后我的項目的相關依賴包升級了，那么相關的包又會和現在Binding的包有沖突。 最后決定將Java原生的組件移植一個.Net 的版本。於是就將AwesomeImagePicker 這個組件移植了一份。源碼可以在這里下載， 下面是幾張screenshot,

 

我想把我寫的這個組件分享給他人使用，最好的方法就是放在www.nuget.org上，那么下面就進入正題：怎么創建一個.nupkg?

1. 安裝NuGet環境

在https://www.nuget.org/downloads下載最新的NuGet.exe, 放到本地機器的某個位置。然后在環境變量Path 。

比如我將nuget.exe 剛在 C:\nuget\nuget.exe. 那么Path環境變量里配置是這樣子的：

然后在命令行中輸入nuget 輸入如下信息則說明nuget已經安裝配置成功.

2、創建需要打包的Xamarin 類庫項目

打開VS 2017， 選擇 File->New->Project…打開項目創建窗口。然后在該窗口選擇 Installed->Visual C# –> Android –> Android Class Library(Xamarin).

然后給項目起個名字：Xamarin.Droid.ImagePicker， 如下圖所示：

點擊 OK 按鈕創建項目，成功后，在VS2017中看到的項目長這樣子：

這下就可以在這里封裝你的類庫了。

3、創建 .nuspec file

打開Package Manager Console 窗口輸入如下命令：

PM> nuget spec Xamarin.Droid.ImagePicker

提示：

在當前的solution中創建一個soluton 文件夾，然后把剛剛創建的 文件 Xamarin.Droid.ImagePicker.nuspec 包含進來,便於進行編輯， 雙擊nuspec文件，初始的文件長這樣：

<?xml version="1.0"?>
<package >
  <metadata>
    <id>Xamarin.Droid.ImagePicker</id>
    <version>1.0.0</version>
    <authors>michael</authors>
    <owners>michael</owners>
    <licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
    <projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
    <iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Package description</description>
    <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
    <copyright>Copyright 2018</copyright>
    <tags>Tag1 Tag2</tags>
    <dependencies>
      <dependency id="SampleDependency" version="1.0" />
    </dependencies>
  </metadata>
</package>

編輯文件，將相應的信息替換成實際的信息如下：

<?xml version="1.0"?>
<package >
  <metadata>
    <id>Xamarin.Droid.ImagePicker</id>
    <version>1.0.0</version>
    <authors>michael</authors>
    <owners>michael</owners>
    <licenseUrl>https://github.com/Xushlin/xamarin-ImagePicker/blob/master/LICENSE</licenseUrl>
    <projectUrl>https://github.com/Xushlin/xamarin-ImagePicker</projectUrl>
    <iconUrl>https://visualstudio.microsoft.com/wp-content/uploads/2016/05/[e-mail]</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description> Xamarin android image picker, support picker one or more images at once.</description>
    <releaseNotes>First relase only support picker picker image from Album.</releaseNotes>
    <copyright>Copyright 2018</copyright>
    <tags>xamarin android image-picker</tags>
    <dependencies>
      <dependency id="Glide.Xamarin" version="4.0.0" />
      <dependency id="Newtonsoft.Json" version="11.0.2" />
      <dependency id="Xamarin.Android.Support.Design" version="25.4.0.2" />
      <dependency id="Xamarin.Android.Support.v7.AppCompat" version="25.4.0.2" />
    </dependencies>
  </metadata>
</package>

這里加上了相關的依賴包，以及一些作者的相關信息。

4、生成 .nupkg

上面的設置都做好以后，在Package Manager Console 窗口輸入如下命令:

PM> nuget pack Xamarin.Droid.ImagePicker.nuspec

但是報下面一個錯誤：

於是在網上找了一下，發現在NuGet的官方Github  WIKI  https://github.com/NuGet/Home/issues/7020下面發現了一個OPEN的 Issues， 看來這個還真是有Bug，但是也有收獲，有位開發者的回復中說在VS 外面運行命令是可以的。

於是啟動了一個命令行，在命令行下運行下面的命令：

G:\git\xamarin-ImagePicker\src\Xamarin.Droid.ImagePicker>nuget pack Xamarin.Droid.ImagePicker.csproj

這下成功了：

G:\git\xamarin-ImagePicker\src\Xamarin.Droid.ImagePicker>nuget pack Xamarin.Droid.ImagePicker.csproj
Attempting to build package from 'Xamarin.Droid.ImagePicker.csproj'.
MSBuild auto-detection: using msbuild version '15.7.179.6572' from 'C:\Program Files (x86)\Microsoft Visual Studio\2017\Enterprise\MSBuild\15.0\bin'.
Packing files from 'G:\git\xamarin-ImagePicker\src\Xamarin.Droid.ImagePicker\bin\Debug'.
WARNING: NU5115: Description was not specified. Using 'Description'.
WARNING: NU5115: Author was not specified. Using 'michael'.
Successfully created package 'G:\git\xamarin-ImagePicker\src\Xamarin.Droid.ImagePicker\Xamarin.Droid.ImagePicker.1.0.0.nupkg'.

 

在Xamarin.Droid.ImagePicker 目錄下面生成了 Xamarin.Droid.ImagePicker.1.0.0.nupkg

但是注意命令中有幾個重要參數要注意：

-IncludeReferencedProjects 表示當前打包的項目的所有引用項目也會一起打包到當前的nupkg中來。

-properties Configuration=Release 表示當前是在Release 環境中打包，如果不帶這個參數選項默認情況下是在Debug環境中打包。

-symbols 這個參數選項表示你打的這個包，使用者可以在調試Debug環境下進入你的源碼，帶這個參數后會生成兩個包：一個帶-symbols后綴的。nupkg包，長得像這樣子。

Xamarin.Droid.ImagePicker.1.0.0.nupkg

Xamarin.Droid.ImagePicker.1.0.0.symbols.nupkg

所以我使用 的命令是：

nuget pack Xamarin.Droid.ImagePicker.csproj -IncludeReferencedProjects -properties Configuration=Release -symbols

5、測試 nupkg

包創建好了就要做一些測試工作,先將包存放在電腦上的一個位置,  我是存在 C：\LocalPackage 中。

然后創建測試項目，我創建的測試項目：

 

創建完測試項目后開始進行包的引用， 使用NuGet package 管理器。右鍵單擊測試項目-> Manage NuGet Packages…

 

打開包管理器界面，然后點擊包管理器右上角的設置

打開包管理器的選項設置界面，在這個界面上點擊添加按鈕,會在Package Resouce 列表里新添加一項：

 

選中新添加的那一項，修改Name 為“LocalPackage”（這個名字隨便起）。 並將Source 改為你本地存儲.nupkg 的路徑，我這里是C:\LocalPakage

如下圖：

然后點擊“Update'”按鈕：

最后點擊 “OK”按鈕回到包管理器界面，在右上角 選擇Package resource 為剛剛配置的LocalPackage，這樣左邊窗口就出現了本地的.nupkg

點解Install按鈕將包就添加到項目中來了：

6、分享.nupkg

測試完成后就可以將包發布到nuget.org 了，其他的開發人員就可以在包管理器中查找到你開發的組件或者類庫了。進而使用到項目中。