dotnet restore

Ten artykuł dotyczy: ✔️ zestaw .NET Core 3.1 SDK i nowsze wersje

Nazwisko

dotnet restore — Przywraca zależności i narzędzia projektu.

Streszczenie

dotnet restore [<ROOT>] [--configfile <FILE>] [--disable-build-servers]
    [--disable-parallel]
    [-f|--force] [--force-evaluate] [--ignore-failed-sources]
    [--interactive] [--lock-file-path <LOCK_FILE_PATH>] [--locked-mode]
    [--no-cache] [--no-dependencies] [--packages <PACKAGES_DIRECTORY>]
    [-r|--runtime <RUNTIME_IDENTIFIER>] [-s|--source <SOURCE>]
    [--tl:[auto|on|off]] [--use-current-runtime, --ucr [true|false]]
    [--use-lock-file] [-v|--verbosity <LEVEL>]

dotnet restore -h|--help

opis

Projekt platformy .NET zwykle odwołuje się do bibliotek zewnętrznych w pakietach NuGet , które zapewniają dodatkowe funkcje. Do tych zależności zewnętrznych odwołuje się plik projektu (csproj lub vbproj). Po uruchomieniu polecenia interfejs wiersza polecenia platformy dotnet restore .NET używa narzędzia NuGet do wyszukiwania tych zależności i pobierania ich w razie potrzeby. Gwarantuje również, że wszystkie zależności wymagane przez projekt są ze sobą zgodne i że nie występują konflikty między nimi. Po zakończeniu wykonywania polecenia wszystkie zależności wymagane przez projekt są dostępne w lokalnej pamięci podręcznej i mogą być używane przez interfejs wiersza polecenia platformy .NET do kompilowania i uruchamiania aplikacji.

W większości przypadków nie trzeba jawnie używać dotnet restore polecenia, ponieważ jeśli przywracanie NuGet jest konieczne, następujące polecenia są uruchamiane niejawnie:

• dotnet new
• dotnet build
• dotnet build-server
• dotnet run
• dotnet test
• dotnet publish
• dotnet pack

Czasami może być niewygodne uruchomienie niejawnego przywracania NuGet za pomocą tych poleceń. Na przykład niektóre zautomatyzowane systemy, takie jak systemy kompilacji, muszą być dotnet restore wywoływane jawnie w celu kontrolowania czasu przywracania, aby mogły kontrolować użycie sieci. Aby zapobiec niejawnemu przywracaniu nuGet, możesz użyć --no-restore flagi z dowolnymi z tych poleceń.

Uwaga

Weryfikacja podpisanego pakietu podczas operacji przywracania wymaga magazynu głównego certyfikatu, który jest ważny zarówno w przypadku podpisywania kodu, jak i sygnatury czasowej. Aby uzyskać więcej informacji, zobacz Weryfikacja podpisanego pakietu NuGet.

Określanie kanałów informacyjnych

Aby przywrócić zależności, pakiet NuGet wymaga źródeł danych, w których znajdują się pakiety. Kanały informacyjne są zwykle dostarczane za pośrednictwem pliku konfiguracji nuget.config . Domyślny plik konfiguracji jest udostępniany podczas instalowania zestawu SDK platformy .NET. Aby określić dodatkowe kanały informacyjne, wykonaj jedną z następujących czynności:

• Utwórz własny plik nuget.config w katalogu projektu. Aby uzyskać więcej informacji, zobacz Typowe konfiguracje nuGet i różnice nuget.config w dalszej części tego artykułu.
• Użyj dotnet nuget poleceń, takich jak dotnet nuget add source.

Możesz zastąpić źródła danych nuget.config opcją -s .

Aby uzyskać informacje o sposobie używania uwierzytelnionych źródeł danych, zobacz Korzystanie z pakietów z uwierzytelnionych źródeł danych.

Folder pakietów globalnych

W przypadku zależności można określić, gdzie przywrócone pakiety są umieszczane podczas operacji przywracania przy użyciu argumentu --packages . Jeśli nie zostanie określona, zostanie użyta domyślna pamięć podręczna pakietów NuGet, która znajduje się w .nuget/packages katalogu głównym użytkownika we wszystkich systemach operacyjnych. Na przykład /home/user1 w systemie Linux lub C:\Users\user1 w systemie Windows.

Narzędzia specyficzne dla projektu

W przypadku narzędzi specyficznych dla projektu najpierw przywraca pakiet, dotnet restore w którym narzędzie jest pakowane, a następnie przechodzi do przywracania zależności narzędzia zgodnie z opisem w pliku projektu.

Różnice w pliku nuget.config

dotnet restore Zachowanie polecenia ma wpływ na ustawienia w pliku nuget.config, jeśli istnieje. Na przykład ustawienie w pliku globalPackagesFolder nuget.config umieszcza przywrócone pakiety NuGet w określonym folderze. Jest to alternatywa dla określenia --packages opcji w poleceniu dotnet restore . Aby uzyskać więcej informacji, zobacz dokumentację narzędzia nuget.config.

Istnieją trzy konkretne ustawienia, które dotnet restore ignorują:

• bindingRedirects

  Przekierowania powiązań nie działają z elementami <PackageReference> , a platforma .NET obsługuje <PackageReference> tylko elementy pakietów NuGet.

• rozwiązanie

  To ustawienie jest specyficzne dla programu Visual Studio i nie ma zastosowania do platformy .NET. Platforma .NET nie używa packages.config pliku i zamiast tego używa <PackageReference> elementów dla pakietów NuGet.

• trustedSigners

  Dodano obsługę weryfikacji podpisu pakietu międzyplatformowego w zestawie SDK platformy .NET 5.0.100.

Pobieranie manifestu obciążenia

Po uruchomieniu tego polecenia inicjuje asynchroniczne pobieranie manifestów reklamowych dla obciążeń. Jeśli pobieranie jest nadal uruchomione po zakończeniu tego polecenia, pobieranie zostanie zatrzymane. Aby uzyskać więcej informacji, zobacz Manifesty reklamowe.

Argumenty

• ROOT

  Opcjonalna ścieżka do pliku projektu w celu przywrócenia.

Opcje

• -a|--arch <ARCHITECTURE>

  Określa architekturę docelową. Jest to skrócona składnia ustawiania identyfikatora środowiska uruchomieniowego (RID), gdzie podana wartość jest połączona z domyślnym identyfikatorem RID. Na przykład na maszynie win-x64 określenie --arch x86 ustawia identyfikator RID na win-x86wartość . Jeśli używasz tej opcji, nie używaj -r|--runtime opcji . Dostępne od wersji zapoznawczej 7 platformy .NET 6.

• --configfile <FILE>

  Plik konfiguracji NuGet (nuget.config) do użycia. Jeśli zostanie określony, zostaną użyte tylko ustawienia z tego pliku. Jeśli nie zostanie określona, zostanie użyta hierarchia plików konfiguracji z bieżącego katalogu. Aby uzyskać więcej informacji, zobacz Typowe konfiguracje nuGet.

• --disable-build-servers

  Wymusza zignorowanie jakichkolwiek trwałych serwerów kompilacji. Ta opcja zapewnia spójny sposób wyłączania całego użycia buforowania kompilacji, co wymusza kompilację od podstaw. Kompilacja, która nie opiera się na pamięciach podręcznych, jest przydatna, gdy pamięci podręczne mogą być uszkodzone lub niepoprawne z jakiegoś powodu. Dostępne od zestawu .NET 7 SDK.

• --disable-parallel

  Wyłącza przywracanie wielu projektów równolegle.

• --force

  Wymusza rozwiązanie wszystkich zależności, nawet jeśli ostatnie przywracanie zakończyło się pomyślnie. Określenie tej flagi jest takie samo jak usunięcie pliku project.assets.json .

• --force-evaluate

  Wymusza przywrócenie w celu ponownego oceny wszystkich zależności, nawet jeśli plik blokady już istnieje.

• -?|-h|--help

  Wyświetla opis sposobu używania polecenia .

• --ignore-failed-sources

  Ostrzegaj tylko o źródłach, które zakończyły się niepowodzeniem, jeśli istnieją pakiety spełniające wymagania dotyczące wersji.

• --interactive

  Umożliwia zatrzymanie polecenia i oczekiwanie na wprowadzenie lub działanie użytkownika. Na przykład w celu ukończenia uwierzytelniania.

• --lock-file-path <LOCK_FILE_PATH>

  Lokalizacja wyjściowa, w której jest zapisywany plik blokady projektu. Domyślnie jest to PROJECT_ROOT\packages.lock.json.

• --locked-mode

  Nie zezwalaj na aktualizowanie pliku blokady projektu.

• --no-cache

  Określa, aby nie buforować żądań HTTP.

• --no-dependencies

  Podczas przywracania projektu przy użyciu odwołań typu project-to-project (P2P) przywraca projekt główny, a nie odwołania.

• --packages <PACKAGES_DIRECTORY>

  Określa katalog dla przywróconych pakietów.

• -r|--runtime <RUNTIME_IDENTIFIER>

  Określa środowisko uruchomieniowe przywracania pakietu. Służy to do przywracania pakietów dla środowisk uruchomieniowych, które nie zostały jawnie wymienione w tagu <RuntimeIdentifiers> w pliku csproj . Aby uzyskać listę identyfikatorów środowiska uruchomieniowego (RID), zobacz wykaz identyfikatorów RID.

• -s|--source <SOURCE>

  Określa identyfikator URI źródła pakietu NuGet do użycia podczas operacji przywracania. To ustawienie zastępuje wszystkie źródła określone w plikach nuget.config . Wiele źródeł można udostępnić, określając tę opcję wiele razy.

• --tl:[auto|on|off]

  Określa, czy rejestrator terminalu ma być używany dla danych wyjściowych kompilacji. Wartość domyślna to auto, która najpierw weryfikuje środowisko przed włączeniem rejestrowania terminalu. Sprawdzanie środowiska sprawdza, czy terminal może korzystać z nowoczesnych funkcji wyjściowych i nie używa przekierowanych standardowych danych wyjściowych przed włączeniem nowego rejestratora. on Pomija sprawdzanie środowiska i włącza rejestrowanie terminalu. off Pomija sprawdzanie środowiska i używa domyślnego rejestratora konsoli.

  Rejestrator terminalu pokazuje fazę przywracania, po której następuje faza kompilacji. W każdej fazie obecnie projekty budowlane są wyświetlane w dolnej części terminalu. Każdy projekt, który tworzy, generuje dane wyjściowe zarówno docelowy programu MSBuild, który jest obecnie kompilowany, jak i ilość czasu spędzonego na tym obiekcie docelowym. Możesz wyszukać te informacje, aby dowiedzieć się więcej o kompilacji. Po zakończeniu kompilowania projektu zostanie napisana pojedyncza sekcja "ukończona kompilacja", która przechwytuje:

  • Nazwa utworzonego projektu.
  • Struktura docelowa (jeśli jest przeznaczona dla wielu celów).
  • Stan tej kompilacji.
  • Podstawowe dane wyjściowe tej kompilacji (która jest hiperlinkowana).
  • Każda diagnostyka wygenerowana dla tego projektu.

  Ta opcja jest dostępna począwszy od platformy .NET 8.

• --use-current-runtime, --ucr [true|false]

  RuntimeIdentifier Ustawia na platformę przenośną RuntimeIdentifier na podstawie jednej z maszyn. Dzieje się to niejawnie z właściwościami, które wymagają RuntimeIdentifier, takich jak SelfContained, , PublishAotPublishSelfContained, , PublishSingleFilei PublishReadyToRun. Jeśli właściwość ma wartość false, ta niejawna rozdzielczość nie będzie już występować.

• --use-lock-file

  Umożliwia wygenerowanie i użycie pliku blokady projektu z przywracaniem.

• -v|--verbosity <LEVEL>

  Ustawia poziom szczegółowości polecenia. Dozwolone wartości to q[uiet], , n[ormal]m[inimal], d[etailed], i diag[nostic]. Wartość domyślna to minimal. Aby uzyskać więcej informacji, zobacz LoggerVerbosity.

Przykłady

• Przywróć zależności i narzędzia dla projektu w bieżącym katalogu:

  dotnet restore
  

• Przywróć zależności i narzędzia dla app1 projektu znajdującego się w podanej ścieżce:

  dotnet restore ./projects/app1/app1.csproj
  

• Przywróć zależności i narzędzia dla projektu w bieżącym katalogu przy użyciu ścieżki pliku podanej jako źródło:

  dotnet restore -s c:\packages\mypackages
  

• Przywróć zależności i narzędzia dla projektu w bieżącym katalogu przy użyciu dwóch ścieżek plików podanych jako źródła:

  dotnet restore -s c:\packages\mypackages -s c:\packages\myotherpackages
  

• Przywróć zależności i narzędzia dla projektu w bieżącym katalogu pokazujące szczegółowe dane wyjściowe:

  dotnet restore --verbosity detailed
  

Inspekcja pod kątem luk w zabezpieczeniach

Począwszy od platformy .NET 8, dotnet restore obejmuje inspekcję zabezpieczeń NuGet. Ta inspekcja generuje raport luk w zabezpieczeniach z nazwą pakietu, ważnością luki w zabezpieczeniach i linkiem do porady, aby uzyskać więcej szczegółów.

Aby zrezygnować z inspekcji zabezpieczeń, ustaw <NuGetAudit> właściwość MSBuild na false w pliku projektu.

Aby pobrać znany zestaw danych luk w zabezpieczeniach, upewnij się, że masz rejestr centralny NuGet.org zdefiniowany jako jedno ze źródeł pakietów:

<packageSources>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>

Można skonfigurować poziom, na którym inspekcja zakończy się niepowodzeniem, ustawiając <NuGetAuditLevel> właściwość MSBuild. Możliwe wartości to low, , highmoderatei critical. Jeśli na przykład chcesz wyświetlić tylko doradcy umiarkowane, wysokie i krytyczne, możesz ustawić właściwość na moderatewartość .

Począwszy od platformy .NET 9, narzędzie NuGet domyślnie przeprowadza inspekcję odwołań do pakietów bezpośrednich i przechodnich . W programie .NET 8 inspekcja dotyczy tylko odwołań do pakietów bezpośrednich . Tryb można zmienić, ustawiając <NuGetAuditMode> właściwość MSBuild na direct lub all.

Aby uzyskać więcej informacji, zobacz Inspekcja zależności pakietów pod kątem luk w zabezpieczeniach.