教程：在 ASP.NET Core 中创建 gRPC 客户端和服务器

作者：John Luo

本教程演示了如何创建 .NET Core gRPC 客户端和 ASP.NET Core gRPC 服务器。

最后会生成与 gRPC Greeter 服务进行通信的 gRPC 客户端。

查看或下载示例代码（如何下载）。

在本教程中，你将了解：

系统必备

创建 gRPC 服务

运行服务

日志显示该服务正在侦听 https://localhost:5001。

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

检查项目文件

GrpcGreeter 项目文件：

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

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

添加所需的包

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

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

添加 greet.proto

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

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

• 编辑 GrpcGreeterClient.csproj 项目文件：

  • Visual Studio

    右键单击项目，并选择“编辑项目文件”。

  • Visual Studio Code

    选择 GrpcGreeterClient.csproj 文件。

  • Visual Studio for Mac

    右键单击项目，并选择“工具” > “编辑文件”。

• 添加具有引用 greet.proto 文件的 <Protobuf> 元素的项组：

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

创建 Greeter 客户端

构建项目，以在 GrpcGreeter 命名空间中创建类型。 GrpcGreeter 类型是由生成进程自动生成的。

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

using System;
using System.Net.Http;
using System.Threading.Tasks;
using GrpcGreeter;
using Grpc.Net.Client;

namespace GrpcGreeterClient
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // The port number(5001) must match the port of the gRPC server.
            using var channel = GrpcChannel.ForAddress("https://localhost:5001");
            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();
        }
    }
}

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

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

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

static async Task Main(string[] args)
{
    // The port number(5001) must match the port of the gRPC server.
    using var channel = GrpcChannel.ForAddress("https://localhost:5001");
    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 调用的结果：

static async Task Main(string[] args)
{
    // The port number(5001) must match the port of the gRPC server.
    using var channel = GrpcChannel.ForAddress("https://localhost:5001");
    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 客户端

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

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

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

info: Microsoft.Hosting.Lifetime[0]
      Now listening on: https://localhost:5001
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:5001/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 in 78.32260000000001ms 200 application/grpc

Azure 应用服务不支持 gRPC

后续步骤

• .NET Core 上的 gRPC 的简介
• 使用 C# 的 gRPC 服务
• 将 gRPC services 从 C 核迁移到 ASP.NET Core