.NET使用gRPC入门教程

傷城~ 2022-04-08 10:10 274阅读 0赞

gRPC是一个高性能、通用的开源RPC框架，其由Google主要面向移动应用开发并基于HTTP/2协议标准而设计，基于ProtoBuf(Protocol Buffers)序列化协议开发，且支持众多开发语言，能够基于语言自动生成客户端和服务端功能库。

### 1.新建工程GrpcClient、GrpcServer和GrpcLibrary ###

添加 - 新建项目 - 控制台应用 GrpcClient、GrpcServer。

添加 - 新建项目 - 类库 GrpcLibrary。 工程中的三个项目情况如下：

![20181210101419853.png][]

### 2.安装程序包Grpc ###

三个项目GrpcClient、GrpcServer、GrpcLibrary均安装程序包Grpc。

属性- 管理NuGet程序包 - 安装Grpc

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70][]

### 3.安装程序包Google.Protobuf  ###

三个项目GrpcClient、GrpcServer、GrpcLibrary均安装程序包Google.Protobuf 。

属性- 管理NuGet程序包 - 安装Google.Protobuf

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 1][]

### 4.安装程序包Grpc.Tools ###

类库GrpcLibrary安装程序包Grpc.Tools。

属性- 管理NuGet程序包 - 安装Grpc.Tools。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 2][]

### 5.自定义服务 ###

在项目GrpcLibrary里添加HelloWorld.proto用以生成代码。

syntax = "proto3";
    package GrpcLibrary;
    service GrpcService {
      rpc SayHello (HelloRequest) returns (HelloReply) {}
    }
    
    message HelloRequest {
      string name = 1;
    }
    
    message HelloReply {
      string message = 1;
    }

执行命令

packages\Grpc.Tools.1.17.0\tools\windows_x64\protoc.exe -IGrpcLibrary --csharp_out GrpcLibrary  GrpcLibrary\HelloWorld.proto --grpc_out GrpcLibrary --plugin=protoc-gen-grpc=packages\Grpc.Tools.1.17.0\tools\windows_x64\grpc_csharp_plugin.exe

命令执行成功后，GrpcLibrary目录下会生成HelloWorld.cs和HelloWorldGrpc.cs。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 3][]

将HelloWorld.cs和HelloWorldGrpc.cs都添加到项目GrpcLibrary中。

最后GrpcClient、GrpcServer分别引用类库GrpcLibrary。

### 6.服务端 ###

using Grpc.Core;
    using GrpcLibrary;
    using System;
    using System.Threading.Tasks;
    
    namespace GrpcServer
    {
        class GrpcImpl : GrpcService.GrpcServiceBase
        {
            // 实现SayHello方法
            public override Task<HelloReply> SayHello(HelloRequest request, ServerCallContext context)
            {
                return Task.FromResult(new HelloReply { Message = "Hello " + request.Name });
            }
        }
        class Program
        {
            const int Port = 9007;
    
            public static void Main(string[] args)
            {
                Server server = new Server
                {
                    Services = { GrpcService.BindService(new GrpcImpl()) },
                    Ports = { new ServerPort("localhost", Port, ServerCredentials.Insecure) }
                };
                server.Start();
    
                Console.WriteLine("GrpcService server listening on port " + Port);
                Console.WriteLine("任意键退出...");
                Console.ReadKey();
    
                server.ShutdownAsync().Wait();
            }
        }
    }

### 7.客户端 ###

using Grpc.Core;
    using GrpcLibrary;
    using System;
    
    namespace GrpcClient
    {
        class Program
        {
            static void Main(string[] args)
            {
                Channel channel = new Channel("127.0.0.1:9007", ChannelCredentials.Insecure);
    
                var client = new GrpcService.GrpcServiceClient(channel);
                var reply = client.SayHello(new HelloRequest { Name = "April" });
                Console.WriteLine("来自" + reply.Message);
    
                channel.ShutdownAsync().Wait();
                Console.WriteLine("任意键退出...");
                Console.ReadKey();
            }
        }
    }

8.测试

先启动服务的，再启动客户端。

![20181210113215134.png][]

![20181210113301741.png][]

[20181210101419853.png]: /images/20220406/12ca8a2fece746e3ae834ebcc7fd6086.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70]: /images/20220406/405c2d8891ef49bfadc8e25d3e50e200.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 1]: /images/20220406/a2411c2b49ae4ecea2b89731bbecf2ee.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 2]: /images/20220406/8f3820022da045238159c8fb6484e7cf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpeWF6aGVuMjAxMQ_size_16_color_FFFFFF_t_70 3]: /images/20220406/c476d3a7db394e0ea040e5d3811e56b7.png
[20181210113215134.png]: /images/20220406/c1cb4149201e4af18723653ab57a8f76.png
[20181210113301741.png]: /images/20220406/c363ae45d51f429c9bd4aea8aa9f44c2.png