Sdílet prostřednictvím

Správa odkazů Protobuf pomocí dotnet-grpc

  • Článek

Poznámka:

Toto není nejnovější verze tohoto článku. Aktuální verzi najdete v tomto článku ve verzi .NET 9.

Upozorňující

Tato verze ASP.NET Core se už nepodporuje. Další informace najdete v zásadách podpory .NET a .NET Core. Aktuální verzi najdete v tomto článku ve verzi .NET 9.

Důležité

Tyto informace se týkají předběžného vydání produktu, který může být podstatně změněn před komerčním vydáním. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Aktuální verzi najdete v tomto článku ve verzi .NET 9.

dotnet-grpc je globální nástroj .NET Core pro správu odkazů Protobuf (.proto) v rámci projektu .NET gRPC. Nástroj lze použít k přidání, aktualizaci, odebrání a výpisu odkazů Protobuf.

Instalace

Pokud chcete nainstalovat dotnet-grpc globální nástroj .NET Core, spusťte následující příkaz:

dotnet tool install -g dotnet-grpc

Poznámka:

Ve výchozím nastavení architektura binárních souborů .NET, které se mají nainstalovat, představuje aktuálně spuštěnou architekturu operačního systému. Pokud chcete zadat jinou architekturu operačního systému, přečtěte si téma instalace nástroje dotnet, možnost --arch. Další informace najdete v tématu o problému GitHubu dotnet/AspNetCore.Docs #29262.

Přidání odkazů

dotnet-grpc lze použít k přidání odkazů Protobuf jako <Protobuf /> položek do .csproj souboru:

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

Odkazy Protobuf slouží k vygenerování prostředků klienta a/nebo serveru jazyka C#. Nástroj dotnet-grpc může:

  • Vytvořte odkaz Protobuf z místních souborů na disku.
  • Vytvořte odkaz Protobuf ze vzdáleného souboru určeného adresou URL.
  • Ujistěte se, že jsou do projektu přidány správné závislosti balíčků gRPC.

Balíček se například Grpc.AspNetCore přidá do webové aplikace. Grpc.AspNetCore obsahuje server gRPC a klientské knihovny a podporu nástrojů. Alternativně se Grpc.Net.ClientGrpc.Tools do konzolové aplikace přidají balíčky a Google.Protobuf balíčky, které obsahují pouze klientské knihovny gRPC a podporu nástrojů.

Přidat soubor

Příkaz add-file slouží k přidání místních souborů na disk jako odkazů Protobuf. Zadané cesty k souborům:

  • Může být relativní vzhledem k aktuálnímu adresáři nebo absolutním cestám.
  • Může obsahovat zástupné znaky pro globbing souborů založených na vzorech.

Pokud jsou některé soubory mimo adresář projektu, přidá se prvek pro Link zobrazení souboru ve složce Protos v sadě Visual Studio.

Využití

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

Argumenty

Argument Popis
files Protobuf soubor odkazuje. Může to být cesta k globu pro místní soubory protobuf.

Možnosti

Krátká možnost Dlouhá možnost Popis
-p --projekt Cesta k souboru projektu, na kterém se má pracovat. Pokud soubor není zadaný, příkaz vyhledá aktuální adresář.
-s --služby Typ služeb gRPC, které by se měly generovat. Pokud Default je zadána, Both používá se pro webové projekty a Client používá se pro projekty mimo web. Přijaté hodnoty jsou Both, , DefaultClient, None, Server.
-i --additional-import-dirs Další adresáře, které se mají použít při překladu importů pro soubory protobuf. Toto je středník oddělený seznam cest.
--přístup Modifikátor přístupu, který se má použít pro vygenerované třídy jazyka C#. Výchozí hodnota je Public. Přijaté hodnoty jsou Internal a Public.

Přidat adresu URL

Příkaz add-url slouží k přidání vzdáleného souboru určeného zdrojovou adresou URL jako odkaz Protobuf. Musí být zadána cesta k souboru, aby bylo možné určit, kam se má vzdálený soubor stáhnout. Cesta k souboru může být relativní vzhledem k aktuálnímu adresáři nebo absolutní cestě. Pokud je cesta k souboru mimo adresář projektu, přidá se prvek pro Link zobrazení souboru ve virtuální složce Protos v sadě Visual Studio.

Využití

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

Argumenty

Argument Popis
url Adresa URL vzdáleného souboru protobuf.

Možnosti

Krátká možnost Dlouhá možnost Popis
-o --output Určuje cestu ke stažení pro vzdálený soubor protobuf. Tato možnost je povinná.
-p --projekt Cesta k souboru projektu, na kterém se má pracovat. Pokud soubor není zadaný, příkaz vyhledá aktuální adresář.
-s --služby Typ služeb gRPC, které by se měly generovat. Pokud Default je zadána, Both používá se pro webové projekty a Client používá se pro projekty mimo web. Přijaté hodnoty jsou Both, , DefaultClient, None, Server.
-i --additional-import-dirs Další adresáře, které se mají použít při překladu importů pro soubory protobuf. Toto je středník oddělený seznam cest.
--přístup Modifikátor přístupu, který se má použít pro vygenerované třídy jazyka C#. Výchozí hodnota je Public. Přijaté hodnoty jsou Internal a Public.

Odebrat

Příkaz slouží k odebrání odkazů Protobuf remove ze .csproj souboru. Příkaz přijímá argumenty cesty a zdrojové adresy URL jako argumenty. Nástroj:

  • Odebere pouze odkaz Protobuf.
  • Neodstraní .proto soubor, i když byl původně stažen ze vzdálené adresy URL.

Využití

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

Argumenty

Argument Popis
odkazy Adresy URL nebo cesty k souborům odkazů protobuf, které chcete odebrat.

Možnosti

Krátká možnost Dlouhá možnost Popis
-p --projekt Cesta k souboru projektu, na kterém se má pracovat. Pokud soubor není zadaný, příkaz vyhledá aktuální adresář.

Aktualizovat

Příkaz refresh slouží k aktualizaci vzdáleného odkazu s nejnovějším obsahem ze zdrojové adresy URL. Cestu ke stažení souboru i zdrojovou adresu URL lze použít k určení odkazu, který se má aktualizovat. Poznámka:

  • Hodnoty hash obsahu souboru se porovnávají a určují, jestli se má místní soubor aktualizovat.
  • Nerovná se žádné informace o časovém razítku.

Pokud je potřeba aktualizace, nástroj vždy nahradí místní soubor vzdáleným souborem.

Využití

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

Argumenty

Argument Popis
odkazy Adresy URL nebo cesty k souborům vzdáleným odkazům protobuf, které by se měly aktualizovat. Chcete-li aktualizovat všechny vzdálené odkazy, ponechte tento argument prázdný.

Možnosti

Krátká možnost Dlouhá možnost Popis
-p --projekt Cesta k souboru projektu, na kterém se má pracovat. Pokud soubor není zadaný, příkaz vyhledá aktuální adresář.
--dry-run Vypíše seznam souborů, které by se aktualizovaly bez stahování nového obsahu.

List

Příkaz slouží k zobrazení všech odkazů Protobuf list v souboru projektu. Pokud jsou všechny hodnoty sloupce výchozími hodnotami, může být sloupec vynechán.

Využití

dotnet-grpc list [options]

Možnosti

Krátká možnost Dlouhá možnost Popis
-p --projekt Cesta k souboru projektu, na kterém se má pracovat. Pokud soubor není zadaný, příkaz vyhledá aktuální adresář.

Další materiály