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

  • Artykuł

dotnet-grpc to narzędzie globalne platformy .NET Core 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.

Instalacja

Aby zainstalować narzędzie globalne platformy dotnet-grpc.NET Core, uruchom następujące polecenie:

dotnet tool install -g dotnet-grpc

Uwaga

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.

Użycie

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

Argumenty

Argument opis
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 opis
-p --Projektu Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.
-s --Usług 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, NoneDefault, 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.
--Dostęp Modyfikator dostępu do użycia dla wygenerowanych klas języka C#. Wartość domyślna 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.

Użycie

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

Argumenty

Argument opis
Adres URL Adres URL zdalnego pliku protobuf.

Opcje

Krótka opcja Długa opcja opis
-o --output Określa ścieżkę pobierania dla zdalnego pliku protobuf. Ta opcja jest wymagana.
-p --Projektu Ścieżka do pliku projektu do działania. Jeśli plik nie zostanie określony, polecenie przeszukuje bieżący katalog.
-s --Usług 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, NoneDefault, 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.
--Dostęp Modyfikator dostępu do użycia dla wygenerowanych klas języka C#. Wartość domyślna to Public. Akceptowane wartości to Internal i Public.

Usuwanie

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.

Użycie

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

Argumenty

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

Opcje

Krótka opcja Długa opcja opis
-p --Projektu Ś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. Uwaga:

  • 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.

Użycie

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

Argumenty

Argument opis
odwołania 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 opis
-p --Projektu Ś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.

Użycie

dotnet-grpc list [options]

Opcje

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

Dodatkowe zasoby