通过 dotnet-grpc 管理 Protobuf 参考
注意
此版本不是本文的最新版本。 有关当前版本，请参阅本文的 .NET 9 版本。
警告
此版本的 ASP.NET Core 不再受支持。 有关详细信息，请参阅 .NET 和 .NET Core 支持策略。 对于当前版本，请参阅此文的 .NET 8 版本。
dotnet-grpc 是一种 .NET Core 全局工具，用于在 .NET gRPC 项目中管理 Protobuf (.proto) 引用。 该工具可以用于添加、刷新、删除和列出 Protobuf 引用。
安装
若要安装 dotnet-grpc .NET Core 全局工具，请运行以下命令：
dotnet tool install -g dotnet-grpc
注意
默认情况下，要安装的 .NET 二进制文件的体系结构表示当前运行的 OS 体系结构。 若要指定不同的 OS 体系结构，请参阅 dotnet tool install, --arch option。 有关详细信息，请参阅 GitHub 问题 dotnet/AspNetCore.Docs #29262。
添加引用
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>...
参数
| Argument | 描述 |
|---|---|
| 文件 | Protobuf 文件引用。 这些可以是本地 protobuf 文件的 glob 的路径。 |
选项
| 短选项 | 长选项 | 描述 |
|---|---|---|
| -p | --project | 要操作的项目文件的路径。 如果未指定文件，则该命令会在当前目录中搜索一个文件。 |
| -S | --services | 应生成的 gRPC 服务的类型。 如果指定 Default，则 Both 用于 Web 项目，而 Client 用于非 Web 项目。 接受的值包括 Both、Client、Default、None 和 Server。 |
| -o | --additional-import-dirs | 解析 protobuf 文件的导入时要使用的其他目录。 这是以分号分隔的路径列表。 |
| --access | 要用于生成的 C# 类的访问修饰符。 默认值为 Public。 接受的值为 Internal 和 Public。 |
添加 URL
add-url 命令用于将源 URL 指定的远程文件添加为 Protobuf 引用。 必须提供文件路径才能指定下载远程文件的位置。 文件路径可以是当前目录的相对路径，也可以是绝对路径。 如果文件路径处于项目目录之外，则会添加一个 Link 元素，以在 Visual Studio 中的虚拟文件夹 Protos 下显示该文件。
用法
dotnet-grpc add-url [options] <url>
参数
| Argument | 描述 |
|---|---|
| URL | 远程 protobuf 文件的 URL。 |
选项
| 短选项 | 长选项 | 描述 |
|---|---|---|
| -o | --output | 指定远程 protobuf 文件的下载路径。 这是必需选项。 |
| -p | --project | 要操作的项目文件的路径。 如果未指定文件，则该命令会在当前目录中搜索一个文件。 |
| -S | --services | 应生成的 gRPC 服务的类型。 如果指定 Default，则 Both 用于 Web 项目，而 Client 用于非 Web 项目。 接受的值包括 Both、Client、Default、None 和 Server。 |
| -o | --additional-import-dirs | 解析 protobuf 文件的导入时要使用的其他目录。 这是以分号分隔的路径列表。 |
| --access | 要用于生成的 C# 类的访问修饰符。 默认值是 Public。 接受的值为 Internal 和 Public。 |
删除
remove 命令用于从 .csproj 文件中删除 Protobuf 引用。 该命令接受路径参数和源 URL 作为参数。 工具：
- 仅删除 Protobuf 引用。
- 不会删除
.proto文件，即使它最初是从远程 URL 下载也是如此。
用法
dotnet-grpc remove [options] <references>...
参数
| Argument | 描述 |
|---|---|
| 引用 | 要删除的 protobuf 引用的 URL 或文件路径。 |
选项
| 短选项 | 长选项 | 描述 |
|---|---|---|
| -p | --project | 要操作的项目文件的路径。 如果未指定文件，则该命令会在当前目录中搜索一个文件。 |
刷新
refresh 命令用于使用来自源 URL 的最新内容更新远程引用。 下载文件路径和源 URL 都可以用于指定要更新的引用。 注意：
- 会比较文件内容的哈希，以确定是否应更新本地文件。
- 不会比较时间戳信息。
如果需要更新，则该工具始终将本地文件替换为远程文件。
用法
dotnet-grpc refresh [options] [<references>...]
参数
| Argument | 描述 |
|---|---|
| 引用 | 应更新的远程 protobuf 引用的 URL 或文件路径。 将此参数保留为空，以刷新所有远程引用。 |
选项
| 短选项 | 长选项 | 描述 |
|---|---|---|
| -p | --project | 要操作的项目文件的路径。 如果未指定文件，则该命令会在当前目录中搜索一个文件。 |
| --dry-run | 输出将更新的文件的列表，而不下载任何新内容。 |
列表
list 命令用于显示项目文件中的所有 Protobuf 引用。 如果某列的所有值都是默认值，则可以省略该列。
用法
dotnet-grpc list [options]
选项
| 短选项 | 长选项 | 描述 |
|---|---|---|
| -p | --project | 要操作的项目文件的路径。 如果未指定文件，则该命令会在当前目录中搜索一个文件。 |
