本教程演示如何创建 .NET gRPC 客户端和 ASP.NET Core gRPC 服务器。 最后会生成与 gRPC Greeter 服务进行通信的 gRPC 客户端。

本教程介绍以下操作：

先决条件

创建 gRPC 服务

运行服务

日志显示在 https://localhost:<port> 上侦听的服务，其中 <port> 是在 Properties/launchSettings.json 中创建和设置项目时随机分配的 localhost 端口号。

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:<port>
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development

检查项目文件

GrpcGreeter 项目文件：

• Protos/greet.proto：定义 Greeter gRPC，并用于生成 gRPC 服务器资产。 有关详细信息，请参阅 gRPC 介绍。
• Services 文件夹：包含 Greeter 服务的实现。
• appsettings.json：包含配置数据，如 Kestrel 使用的协议。 有关详细信息，请参阅 ASP.NET Core 中的配置。
• Program.cs，其中包含：
  • gRPC 服务的入口点。 有关详细信息，请参阅 ASP.NET Core 中的 .NET 通用主机。
  • 配置应用行为的代码。 有关详细信息，请参阅 应用启动。

在 .NET 控制台应用中创建 gRPC 客户端

添加所需的 NuGet 包

gRPC 客户端项目需要以下 NuGet 包：

• Grpc.Net.Client，其中包含 .NET 客户端。
• Google.Protobuf，其中包含适用于 C# 的 protobuf 消息 API。
• Grpc.Tools，其中包含对 protobuf 文件的 C# 工具支持。 运行时不需要工具包，因此依赖项标记为 PrivateAssets="All"。

dotnet add GrpcGreeterClient.csproj package Grpc.Net.Client
dotnet add GrpcGreeterClient.csproj package Google.Protobuf
dotnet add GrpcGreeterClient.csproj package Grpc.Tools

添加 greet.proto

• 在 gRPC 客户端项目中创建 Protos 文件夹。

• 将 Protos\greet.proto 文件从 gRPC Greeter 服务复制到 gRPC 客户端项目中的 Protos 文件夹。

• 将 greet.proto 文件中的命名空间更新为项目的命名空间：

  option csharp_namespace = "GrpcGreeterClient";
  

• 编辑 GrpcGreeterClient.csproj 项目文件：

• 添加一个项组，其中的 <Protobuf> 元素指向 Protos\greet.proto 文件：

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

创建 Greeter 客户端

• 构建客户端项目，以在 GrpcGreeterClient 命名空间中创建类型。

• 使用以下代码更新 gRPC 客户端 Program.cs 文件。

  using Grpc.Net.Client;
  using GrpcGreeterClient;
  
  // The port number must match the port of the gRPC server.
  using var channel = GrpcChannel.ForAddress("https://localhost:7042");
  var client = new Greeter.GreeterClient(channel);
  var reply = await client.SayHelloAsync(
      new HelloRequest { Name = "GreeterClient" });
  Console.WriteLine("Greeting: " + reply.Message);
  Console.WriteLine("Press any key to exit...");
  Console.ReadKey();
  

• 在前面突出显示的代码中，将 localhost 端口号 7042 替换为在 HTTPS 服务项目的 Properties/launchSettings.json 中指定的 GrpcGreeter 端口号。

Program.cs 包含 gRPC 客户端的入口点和逻辑。

通过以下方式创建 Greeter 客户端：

• 实例化 GrpcChannel，使其包含用于创建到 gRPC 服务的连接的信息。
• 使用 GrpcChannel 构造 Greeter 客户端：

// The port number must match the port of the gRPC server.
using var channel = GrpcChannel.ForAddress("https://localhost:7042");
var client = new Greeter.GreeterClient(channel);
var reply = await client.SayHelloAsync(
    new HelloRequest { Name = "GreeterClient" });
Console.WriteLine("Greeting: " + reply.Message);
Console.WriteLine("Press any key to exit...");
Console.ReadKey();

Greeter 客户端会调用异步 SayHello 方法。 随即显示 SayHello 调用的结果：

// The port number must match the port of the gRPC server.
using var channel = GrpcChannel.ForAddress("https://localhost:7042");
var client = new Greeter.GreeterClient(channel);
var reply = await client.SayHelloAsync(
    new HelloRequest { Name = "GreeterClient" });
Console.WriteLine("Greeting: " + reply.Message);
Console.WriteLine("Press any key to exit...");
Console.ReadKey();

使用 gRPC Greeter 服务测试 gRPC 客户端

通过添加以下突出显示的行来更新 appsettings.Development.json 文件：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning",
      "Microsoft.AspNetCore.Hosting": "Information",
      "Microsoft.AspNetCore.Routing.EndpointMiddleware": "Information"
    }
  }
}

客户端向服务发送问候语，其中包含其名称 GreeterClient 的消息。 该服务会发送“Hello GreeterClient”消息作为答复。 “Hello GreeterClient”答复将在命令提示符中显示：

Greeting: Hello GreeterClient
Press any key to exit...

gRPC 服务在写入命令提示符的日志中记录成功调用的详细信息：

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:<port>
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: C:\GH\aspnet\docs\4\Docs\aspnetcore\tutorials\grpc\grpc-start\sample\GrpcGreeter
info: Microsoft.AspNetCore.Hosting.Diagnostics[1]
      Request starting HTTP/2 POST https://localhost:<port>/greet.Greeter/SayHello application/grpc
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[0]
      Executing endpoint 'gRPC - /greet.Greeter/SayHello'
info: Microsoft.AspNetCore.Routing.EndpointMiddleware[1]
      Executed endpoint 'gRPC - /greet.Greeter/SayHello'
info: Microsoft.AspNetCore.Hosting.Diagnostics[2]
      Request finished HTTP/2 POST https://localhost:7042/greet.Greeter/SayHello - 200 - application/grpc 40.4615ms

后续步骤

• 查看或下载本教程中已完成的示例代码（下载方式）。
• .NET 上的 gRPC 概述
• 使用 C# 的 gRPC 服务
• 将 gRPC 从 C-core 迁移到 gRPC for .NET