Tworzenie pakietu biblioteki klas Razor

Ukończone

Zadanie, które często wykonujesz, to pakowanie bibliotek do ponownego użycia przez innych deweloperów. Tworzenie pakietów NuGet sprawia, że każdy deweloper może w dowolnym miejscu uzyskiwać i prawidłowo konfigurować wszystkie odwołania platformy .NET dla swoich aplikacji.

W poprzedniej lekcji skompilujesz składnik modalnego okna dialogowego i użyto go we własnej aplikacji. Teraz chcesz użyć jej ponownie w innych aplikacjach.

W tej lekcji poznasz kroki niezbędne do skonfigurowania biblioteki klas Razor jako pakietu NuGet. Dowiesz się również, jak spakować bibliotekę do dystrybucji przy użyciu usługi repozytorium pakietów, takiej jak NuGet.org lub repozytoria GitHub.

Konfigurowanie biblioteki klas Razor na potrzeby tworzenia pakietów NuGet

Ekosystem platformy .NET ułatwia definiowanie właściwości niezbędnych dla innych deweloperów do identyfikowania i używania składników. Wszystkie te właściwości można zdefiniować w pliku projektu (*.csproj) biblioteki klas Razor, tak aby były one przesyłane z biblioteką i są odpowiednio aktualizowane po zaktualizowaniu biblioteki.

Możesz skonfigurować pola identyfikujące pakiet w oknie dialogowym Właściwości projektu programu Visual Studio — pakiet lub samodzielnie utworzyć wpisy bezpośrednio w pliku *.csproj .

Cztery pola wymagane do utworzenia pakietu to:

Pole opis Domyślna wartość
PackageId Identyfikator pakietu unikatowy w całym repozytorium NuGet. AssemblyName biblioteki
Wersja Określony numer wersji w postaci Major.Minor.Patch[-Sufiks], gdzie -Sufiks opcjonalnie definiuje wersje wstępne. 1.0.0
Autorzy Autorzy pakietu. AssemblyName
Firma Nazwa firmy odpowiedzialnej za tworzenie i publikowanie pakietu. AssemblyName

Niektóre z tych pól mają wartości domyślne i może wydawać się zabawne, aby opublikować pakiet z nazwą firmy MyFirstLibrary. Zdecydowanie zalecamy jawne zdefiniowanie tych wartości.

W poprzedniej lekcji przedstawiono, że zawartość statyczna biblioteki klas Razor jest dostępna w _content/[PACKAGE_ID]/lokalizacji , a teraz zobaczysz, gdzie PackageId skonfigurowano wartość.

Przykładowy plik projektu ze skonfigurowanymi wartościami może wyglądać następująco:

<PropertyGroup>
    <PackageId>Learn.MyFirstLibrary</PackageId>
    <Version>0.1.0-alpha1</Version>
    <Authors>Susan Developer, Terry Programmer</Authors>
    <Company>AdventureWorks</Company>
</PropertyGroup>

Podczas kompilowania projektu możesz również skonfigurować go tak, aby wygenerował pakiet NuGet, wybierając opcję Generuj pakiet NuGet w kompilacji w oknie dialogowym Właściwości projektu programu Visual Studio lub dodając GeneratePackageOnBuild wpis obok innych pól pakietu, jak pokazano poniżej:

<GeneratePackageOnBuild>True</GeneratePackageOnBuild>

Można skonfigurować wiele opcjonalnych właściwości projektu, w tym:

  • Element Description odpowiedni do wyświetlania w repozytorium NuGet
  • Powiadomienie o prawach autorskich
  • Informacje dotyczące licencjonowania
  • Ikony
  • Adresy URL projektów

Aby uzyskać pełną listę właściwości, zapoznaj się z dokumentacją firmy Microsoft dotyczącą docelowego pakietu MSBuild.

Spakuj bibliotekę

Po zapisaniu konfiguracji biblioteki w pliku *.csproj możesz wygenerować pakiet NuGet w programie Visual Studio, klikając prawym przyciskiem myszy projekt i wybierając polecenie Pack lub w folderze projektu, uruchamiając następujące polecenie:

dotnet pack

To dotnet pack polecenie generuje pakiet z identyfikatorem PackageID i numerem wersji i umieszcza go w standardowym folderze danych wyjściowych kompilacji projektu.

Sprawdź swoją wiedzę

1.

Jaka właściwość projektu jest wartością domyślną PackageId?