Udostępnij przez

Zarządzanie odwołaniami narzędzia Protobuf za pomocą narzędzia dotnet-GRPC

Note

Nie jest to najnowsza wersja tego artykułu. Aby zapoznać się z aktualną wersją, zobacz artykuł w wersji .NET 10.

Warning

Ta wersja ASP.NET Core nie jest już obsługiwana. Aby uzyskać więcej informacji, zobacz zasady pomocy technicznej platformy .NET i platformy .NET Core. Aby zapoznać się z aktualną wersją, zobacz artykuł w wersji .NET 10.

dotnet-grpc to narzędzie globalne platformy .NET do zarządzania odwołaniami protobuf (.proto) w projekcie gRPC platformy .NET. Za pomocą narzędzia można dodawać, odświeżać, usuwać i wyświetlać odwołania Protobuf.

Installation

Aby zainstalować dotnet-grpc .NET, uruchom następujące polecenie:

dotnet tool install -g dotnet-grpc

Note

Domyślnie architektura plików binarnych platformy .NET do zainstalowania reprezentuje obecnie uruchomioną architekturę systemu operacyjnego. Aby określić inną architekturę systemu operacyjnego, zobacz dotnet tool install, --arch option(Instalacja narzędzia dotnet). Aby uzyskać więcej informacji, zobacz problem z usługą GitHub dotnet/AspNetCore.Docs #29262.

Dodawanie odwołań

dotnet-grpc Może służyć do dodawania odwołań Protobuf jako <Protobuf /> elementów do .csproj pliku:

<Protobuf Include="Protos\greet.proto" GrpcServices="Server" />

Odwołania protobuf są używane do generowania zasobów klienta i/lub serwera języka C#. Narzędzie dotnet-grpc może wykonywać następujące czynności:

  • Utwórz odwołanie Protobuf z plików lokalnych na dysku.
  • Utwórz odwołanie Protobuf z pliku zdalnego określonego przez adres URL.
  • Upewnij się, że do projektu są dodawane poprawne zależności pakietów gRPC.

Na przykład Grpc.AspNetCore pakiet jest dodawany do aplikacji internetowej. Grpc.AspNetCore zawiera biblioteki i biblioteki klienta oraz obsługę narzędzi i serwera gRPC. Alternatywnie Grpc.Net.ClientGrpc.Tools pakiety iGoogle.Protobuf, które zawierają tylko biblioteki klienta gRPC i obsługę narzędzi, są dodawane do aplikacji konsolowej.

Dodawanie pliku

Polecenie add-file służy do dodawania plików lokalnych na dysku jako odwołań Protobuf. Podane ścieżki plików:

  • Może być względny względem bieżącego katalogu lub ścieżek bezwzględnych.
  • Może zawierać symbole wieloznaczne dla symboli wieloznacznych opartych na wzorcu.

Jeśli jakiekolwiek pliki znajdują się poza katalogiem projektu, Link zostanie dodany element w celu wyświetlenia pliku w folderze Protos w programie Visual Studio.

Usage

dotnet-grpc add-file [options] <files>...

Arguments

Argument Description
files Odwołania do pliku protobuf. Może to być ścieżka do biblioteki glob dla lokalnych plików protobuf.

Opcje

Krótka opcja Długa opcja Description
-p --project Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.
-s --services Typ usług gRPC, które powinny być generowane. Jeśli Default zostanie określony, Both jest używany dla projektów sieci Web i Client jest używany w projektach innych niż sieci Web. Akceptowane wartości to Both, , Client, DefaultNone, Server.
-i --additional-import-dirs Dodatkowe katalogi, które mają być używane podczas rozpoznawania importów dla plików protobuf. Jest to rozdzielona średnikami lista ścieżek.
--access Modyfikator dostępu do użycia dla wygenerowanych klas języka C#. Domyślna wartość to Public. Akceptowane wartości to Internal i Public.

Dodaj adres URL

Polecenie add-url służy do dodawania pliku zdalnego określonego przez źródłowy adres URL jako odwołanie Protobuf. Należy podać ścieżkę pliku, aby określić miejsce pobierania pliku zdalnego. Ścieżka pliku może być względna względem bieżącego katalogu lub ścieżki bezwzględnej. Jeśli ścieżka pliku znajduje się poza katalogiem projektu, Link dodawany jest element w celu wyświetlenia pliku w folderze Protos wirtualnym w programie Visual Studio.

Usage

dotnet-grpc add-url [options] <url>

Arguments

Argument Description
url Adres URL zdalnego pliku protobuf.

Opcje

Krótka opcja Długa opcja Description
-o --output Określa ścieżkę pobierania dla zdalnego pliku protobuf. Ta opcja jest wymagana.
-p --project Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.
-s --services Typ usług gRPC, które powinny być generowane. Jeśli Default zostanie określony, Both jest używany dla projektów sieci Web i Client jest używany w projektach innych niż sieci Web. Akceptowane wartości to Both, , Client, DefaultNone, Server.
-i --additional-import-dirs Dodatkowe katalogi, które mają być używane podczas rozpoznawania importów dla plików protobuf. Jest to rozdzielona średnikami lista ścieżek.
--access Modyfikator dostępu do użycia dla wygenerowanych klas języka C#. Wartość domyślna to Public. Akceptowane wartości to Internal i Public.

Remove

Polecenie remove służy do usuwania odwołań Protobuf z .csproj pliku. Polecenie akceptuje argumenty ścieżki i źródłowe adresy URL jako argumenty. Narzędzie:

  • Usuwa tylko odwołanie Protobuf.
  • Nie usuwa .proto pliku, nawet jeśli został on pierwotnie pobrany ze zdalnego adresu URL.

Usage

dotnet-grpc remove [options] <references>...

Arguments

Argument Description
references Adresy URL lub ścieżki plików odwołań protobuf do usunięcia.

Opcje

Krótka opcja Długa opcja Description
-p --project Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.

Refresh

Polecenie refresh służy do aktualizowania odwołania zdalnego przy użyciu najnowszej zawartości ze źródłowego adresu URL. Zarówno ścieżka pliku pobierania, jak i źródłowy adres URL mogą służyć do określenia odwołania do aktualizacji. Note:

  • Skróty zawartości pliku są porównywane w celu określenia, czy plik lokalny ma zostać zaktualizowany.
  • Nie jest porównywana żadna informacja sygnatury czasowej.

Narzędzie zawsze zastępuje plik lokalny plikiem zdalnym, jeśli jest wymagana aktualizacja.

Usage

dotnet-grpc refresh [options] [<references>...]

Arguments

Argument Description
references Adresy URL lub ścieżki plików do zdalnych odwołań protobuf, które powinny zostać zaktualizowane. Pozostaw ten argument pusty, aby odświeżyć wszystkie odwołania zdalne.

Opcje

Krótka opcja Długa opcja Description
-p --project Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.
--dry-run Zwraca listę plików, które zostaną zaktualizowane bez pobierania nowej zawartości.

List

Polecenie list służy do wyświetlania wszystkich odwołań Protobuf w pliku projektu. Jeśli wszystkie wartości kolumny są wartościami domyślnymi, kolumna może zostać pominięta.

Usage

dotnet-grpc list [options]

Opcje

Krótka opcja Długa opcja Description
-p --project Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.

Dodatkowe zasoby

  • Last updated on