Dart Protoc编译未生成gRPC客户端类问题求助

问题原因 #

你当前生成的GpioApi是基于通用RpcClient的包装类，而非适配grpc包的客户端实现——这是因为代码生成时未指定生成gRPC客户端的参数，仅生成了基础的protobuf相关代码。

解决方案 #

1. 确认依赖配置 #

确保pubspec.yaml中包含必要的依赖：

dependencies:
  grpc: ^3.2.0
  protobuf: ^3.1.0

dev_dependencies:
  build_runner: ^2.4.0
  protoc_plugin: ^21.0.0

执行flutter pub get完成依赖安装。

2. 正确生成gRPC客户端代码 #

有两种方式生成兼容grpc包的客户端类：

方式一：使用protoc命令行

在项目根目录执行以下命令（替换protos/gpio.proto为你的.proto文件路径，lib/src/generated为代码输出目录）：

protoc --dart_out=grpc:lib/src/generated -Iprotos protos/gpio.proto

关键是--dart_out=grpc:参数，它会触发生成gRPC客户端代码，而非仅生成通用RpcClient包装类。

方式二：使用build_runner（推荐Flutter项目）

在项目根目录创建build.yaml文件，添加以下配置：

targets:
  $default:
    builders:
      protoc_plugin:
        options:
          generate_grpc: true
          output_dir: lib/src/generated

然后运行生成命令：

flutter pub run build_runner build

3. 生成后的正确客户端类 #

执行上述操作后，会生成包含GpioClient的文件（通常命名为gpio.pbgrpc.dart），该类继承自grpc.Client，示例结构如下：

class GpioClient extends grpc.Client {
  GpioClient(grpc.ClientChannel channel, {grpc.CallOptions? options})
      : super(channel, options: options);

  @override
  Map<String, grpc.ClientMethod> get methods => _$GpioClientMethods;

  grpc.ResponseFuture<TimedOnResponse> timedOn(TimedOnRequest request, {grpc.CallOptions? options}) {
    return $createUnaryCall(
      _$GpioClientMethods['TimedOn']!,
      request,
      options: options,
    );
  }

  grpc.ResponseFuture<TimedOffResponse> timedOff(TimedOffRequest request, {grpc.CallOptions? options}) {
    return $createUnaryCall(
      _$GpioClientMethods['TimedOff']!,
      request,
      options: options,
    );
  }
}

final _$GpioClientMethods = <String, grpc.ClientMethod>{
  'TimedOn': grpc.ClientMethod<TimedOnRequest, TimedOnResponse>(
      '/gpio.Gpio/TimedOn',
      (TimedOnRequest value) => value.writeToBuffer(),
      (List<int> value) => TimedOnResponse.fromBuffer(value)),
  'TimedOff': grpc.ClientMethod<TimedOffRequest, TimedOffResponse>(
      '/gpio.Gpio/TimedOff',
      (TimedOffRequest value) => value.writeToBuffer(),
      (List<int> value) => TimedOffResponse.fromBuffer(value)),
};

4. 客户端使用示例 #

import 'package:grpc/grpc.dart';
import 'lib/src/generated/gpio.pbgrpc.dart';

void main() async {
  // 创建服务通道
  final channel = grpc.ClientChannel(
    '你的服务器地址',
    port: 50051, // 替换为你的gRPC服务端口
    options: const grpc.ChannelOptions(credentials: grpc.ChannelCredentials.insecure()),
  );

  // 实例化客户端
  final client = GpioClient(channel);

  try {
    // 调用TimedOn方法
    final request = TimedOnRequest()..pin = 1..seconds = 5.0;
    final response = await client.timedOn(request);
    print('请求结果: 成功=${response.success}, 消息=${response.message}');
  } catch (e) {
    print('请求失败: $e');
  } finally {
    // 关闭通道
    await channel.shutdown();
  }
}

内容的提问来源于stack exchange，提问作者Peter