第三步:实现实现gRPC方法

在HelloWorldClient类中，为每个定义在.proto文件中的rpc方法实现对应的Dart方法。

简单的分析下dart实现grpc客户端的流程,以helloworld为例

这里给出helloworld的proto文件,grpc协议下客户端和服务端都只需要关注相同的proto文件并以自己的代码实现,客户端和服务端彼此都不关心对方的实现形式

项目目录

C:.
│  .gitignore
│  analysis_options.yaml
│  CHANGELOG.md
│  pubspec.lock
│  pubspec.yaml // 依赖管理,记得加入grpc和protobuf依赖项
│  README.md
│  
├─.dart_tool
│      package_config.json
│      
├─example
│      g_client_example.dart
│      
├─lib  // 这个目录是公共的,实现package最主要就是实现这里
│  │  g_client.dart
│  │  
│  ├─bin
│  └─src
│      │  g_client_base.dart
│      │  helloworld_client.dart
│      │  user_client.dart
│      │  
│      └─generated
│          ├─helloworld   // 由proto工具生成的代码集合
│          │      helloworld.pb.dart
│          │      helloworld.pbenum.dart
│          │      helloworld.pbgrpc.dart
│          │      helloworld.pbjson.dart
│          │
│          └─user
│                  user.pb.dart
│                  user.pbenum.dart
│                  user.pbgrpc.dart
│                  user.pbjson.dart
│
├─protos
│  ├─helloworld
│  │      helloworld.proto // 这是关键的proto文件
│  │
│  └─user
│          user.proto
│
└─test

helloworld.proto

syntax = "proto3";
//指定了 Go 语言代码生成后应该放置在名为 "github.com/rn-consider/grpcservice/helloworld" 的包中,
//会影响生成的 .pb.go 文件的 package 声明
option go_package = "github.com/rn-consider/grpcservice/helloworld";
option java_multiple_files = true;
option java_package = "io.helloworld_server.examples.helloworld_server";
option java_outer_classname = "HelloWorldProto";package helloworld;// 此处定义服务,为协议缓冲区中的服务定义
service Greeter {/*提供SayHello函数,接受HelloRequest类型的消息,返回HelloReply类型的消息在grpc中,函数必须始终具有输入消息并返回输出消息*/// Sends a greetingrpc SayHello (HelloRequest) returns (HelloReply) {}// Sends another greetingrpc SayHelloAgain (HelloRequest) returns (HelloReply) {}}// 要求传入参数必须要name
message HelloRequest {/*字段的设计十分重要,应谨慎分配字段编号,切勿更改,且在设计时考虑未来的修订消息中的字段定义必须指定三件事:类型,名称,编号字段的类型可以是当前支持的整数类型(int32,int64等),float,double,bool,字符串,字节(用于任何数据)要注意的是字段名称必须全部小写,并使用_分隔多个单词.如first_name,字段编号表示字段在消息中的位置,如name = 1表示name在返回信息中占第一位字段编号可以从1到2^29推荐在字段编号内留下间距,例如将第一个字段编号为1,然后将10用于下一个字段这意味着可在稍后添加任何其他字段而不需要对字段进行编号*/string name = 1;
}// 要求返回参数必须要是message
message HelloReply {string message = 1;
}

第一步:导入生成的pb文件

import 'package:grpc/grpc.dart'; // 导入dart grpc包
import 'generated/helloworld/helloworld.pb.dart'; //导入生成的pb文件
import 'generated/helloworld/helloworld.pbgrpc.dart';

第二步:创建grpc客户端类

在helloworld_client.dart文件中，创建一个gRPC客户端类，你可以命名为HelloWorldClient。这个类应该包括以下属性：

• ClientChannel对象用于与gRPC服务器建立连接。

• GreeterClient对象，它是gRPC服务的客户端实例。

• // 构造HelloWorldClient用于grpc,类名应该大驼峰命名
  class HelloWorldClient {// 定义 gRPC 客户端所需的属性// 客户端通道，用于与 gRPC 服务器建立连接// late用于延时变量的初始化,非空变量使用 late 关键字声明的变量会被视为非空变量，// 这意味着它们在被访问之前必须被初始化，否则会引发运行时异常。late ClientChannel _channel;// Greeter 客户端，它是 gRPC 服务的客户端实例,late GreeterClient _stub;// 构造函数(必须与类名完全一致)，用于初始化客户端HelloWorldClient(String host, int port) {// 创建客户端通道，指定主机和端口，使用不安全的凭据(仅测试时使用)// 下划线表示变量私有_channel = ClientChannel(host,port: port,options: const ChannelOptions(credentials: ChannelCredentials.insecure(),),);_stub = GreeterClient(_channel);}// ...
  } 
  

第三步:实现实现gRPC方法

在HelloWorldClient类中，为每个定义在.proto文件中的rpc方法实现对应的Dart方法。

在我们的proto文件中定义了SayHello和SayHelloAgain两个rpc方法所以我们应当实现它们

/* gRPC方法：向服务器发送问候消息，并返回服务器的响应Future 表示一个异步操作的结果。异步操作是指不会立即返回结果，而是在后续某个时刻返回结果的操作。Future 类型表示一个值，该值可能在未来某个时间点可用。在上面的代码中，Future<HelloReply> 表示这个方法会返回一个 HelloReply 类型的对象，但是这个对象不会立即返回，而是在将来的某个时间点返回。
*/
Future<HelloReply> sayHello(String name) async {final request = HelloRequest()/*'..'它是Dart中的一种级联操作（cascade）。级联操作允许您在同一个对象上执行一系列操作，而不必重复引用对象。在这里，..name = name 表示在 HelloRequest 对象上设置 name 字段的值为传入的 name 参数。这样做的好处是可以连续地对同一个对象进行多次操作，而不必重复引用对象。*/ ..name = name;return _stub.sayHello(request);
}Future<HelloReply> sayHelloAgain(String name) async {final request = HelloRequest()..name = name;return _stub.sayHelloAgain(request);
}

4.关闭客户端通道

最后，在客户端类中添加一个方法来关闭客户端通道，以释放资源。

void close() { _channel.shutdown(); }

完整代码

import 'package:grpc/grpc.dart';
import 'generated/helloworld/helloworld.pbgrpc.dart';class HelloWorldClient {late ClientChannel _channel;late GreeterClient _stub;HelloWorldClient(String host, int port) {_channel = ClientChannel(host,port: port,options: const ChannelOptions(credentials: ChannelCredentials.insecure(), // 这里使用不安全的连接，仅供测试),);_stub = GreeterClient(_channel);}Future<HelloReply> sayHello(String name) async {final request = HelloRequest()..name = name;return _stub.sayHello(request);}Future<HelloReply> sayHelloAgain(String name) async {final request = HelloRequest()..name = name;return _stub.sayHelloAgain(request);}void close() {_channel.shutdown();}
}