通过dotnet-grpc管理Protobuf

通过 dotnet-grpc 管理 Protobuf 参考

作者：John Luo

dotnet-grpc 是一种 .NET Core 全局工具，用于管理 .NET gRPC 项目中的Protobuf （proto）引用。 该工具可用于添加、刷新、删除和列出 Protobuf 引用。

安装

若要安装 dotnet-grpc .Net Core 全局工具，请运行以下命令：

dotnet tool install -g dotnet-grpc

添加引用

dotnet-grpc 可用于将 Protobuf 引用作为 <Protobuf /> 项添加到 .csproj文件：

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

Protobuf 引用用于生成C#客户端和/或服务器资产。 dotnet-grpc 工具可以：

  • 从磁盘上的本地文件创建 Protobuf 引用。
  • 从 URL 指定的远程文件创建 Protobuf 引用。
  • 确保将正确的 gRPC 包依赖项添加到项目。

例如，将 Grpc.AspNetCore 包添加到 web 应用。 Grpc.AspNetCore 包含 gRPC 服务器和客户端库以及工具支持。 另外，还会将 Grpc.Net.Client、Grpc.Tools 和 Google.Protobuf 包（其中仅包含 gRPC 客户端库和工具支持）添加到控制台应用。

添加文件

add-file 命令用于在磁盘上添加本地文件作为 Protobuf 引用。 提供的文件路径：

如果任何文件位于项目目录之外，则会添加一个 Link 元素，以在 Visual Studio 中的文件夹 Protos 下显示该文件。

用法

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

参数

参数 说明
文件 Protobuf 文件引用。 它们可以是本地 protobuf 文件的 glob 的路径。

选项

短选项 长选项 说明
-p --项目 要操作的项目文件的路径。 如果未指定文件，此命令将在当前目录中搜索一个。
-s --服务 应生成的 gRPC 服务的类型。 如果指定 Default，则 Both 用于 Web 项目，而 Client 用于非 Web 项目。 接受的值为 Both、Client、Default、None、Server。
-i --附加-import-目录 解析 protobuf 文件的导入时要使用的其他目录。 这是以分号分隔的路径列表。
--访问 要用于生成C#的类的访问修饰符。 默认值为 Public。 接受的值为 Internal，Public。

添加 URL

add-url 命令用于添加由源 URL 指定的远程文件作为 Protobuf 引用。 必须提供文件路径才能指定下载远程文件的位置。 文件路径可以是相对于当前目录的路径，也可以是绝对路径。 如果文件路径在项目目录之外，则会添加一个 Link 元素，以在 Visual Studio 中的虚拟文件夹 Protos 下显示该文件。

用法

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

参数

参数 说明
url 远程 protobuf 文件的 URL。

选项

短选项 长选项 说明
-o --output 指定远程 protobuf 文件的下载路径。 这是必需选项。
-p --项目 要操作的项目文件的路径。 如果未指定文件，此命令将在当前目录中搜索一个。
-s --服务 应生成的 gRPC 服务的类型。 如果指定 Default，则 Both 用于 Web 项目，而 Client 用于非 Web 项目。 接受的值为 Both、Client、Default、None、Server。
-i --附加-import-目录 解析 protobuf 文件的导入时要使用的其他目录。 这是以分号分隔的路径列表。
--访问 要用于生成C#的类的访问修饰符。 默认值为 Public。 接受的值为 Internal，Public。

删除

remove 命令用于从 .csproj文件中删除 Protobuf 引用。 命令接受路径自变量和源 Url 作为参数。 工具：

  • 仅删除 Protobuf 引用。
  • 不会删除proto文件，即使它最初是从远程 URL 下载的也是如此。

用法

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

参数

参数 说明
引用 要移除的 protobuf 引用的 Url 或文件路径。

选项

短选项 长选项 说明
-p --项目 要操作的项目文件的路径。 如果未指定文件，此命令将在当前目录中搜索一个。

刷新

refresh 命令用于使用源 URL 中的最新内容更新远程引用。 下载文件路径和源 URL 都可以用来指定要更新的引用。 注意：

  • 比较文件内容的哈希值，以确定是否应更新本地文件。
  • 不比较时间戳信息。

如果需要更新，此工具始终会将本地文件替换为远程文件。

用法

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

参数

参数 说明
引用 应更新的远程 protobuf 引用的 Url 或文件路径。 将此参数保留为空，以刷新所有远程引用。

选项

短选项 长选项 说明
-p --项目 要操作的项目文件的路径。 如果未指定文件，此命令将在当前目录中搜索一个。
--模拟运行 输出将更新但不下载任何新内容的文件的列表。

列表

list 命令用于显示项目文件中的所有 Protobuf 引用。 如果列的所有值均为默认值，则可以省略该列。

用法

dotnet-grpc list [options]

选项

短选项 长选项 说明
-p --项目 要操作的项目文件的路径。 如果未指定文件，此命令将在当前目录中搜索一个。

其他资源

目录
通过dotnet-grpc管理Protobuf