Flutter gRPC通信插件monarch_grpc的使用

monarch_grpc

包含Monarch CLI和Monarch Controller的gRPC接口。

安装gRPC proto buffer编译器

1. 安装Protocol Buffer编译器。
   • 对于Windows，安装预编译的二进制文件。
   • 对于macOS，你可以安装预编译的二进制文件或使用包管理器。

# 在macOS上
$ brew install protobuf

# 在Windows上
PS> choco install protobuf

1. 安装协议编译器的Dart插件：

$ dart pub global activate protoc_plugin

如果你需要更多的安装说明，请参考grpc.io文档。

重新生成gRPC代码

在macOS上：

$ sh tools/gen_grpc.sh

在Windows上：

PS> .\tools\gen_grpc.bat

gRPC资源

• gRPC Dart参考文档
• gRPC错误详情。上述链接包括HTTP状态码到gRPC状态码的映射。
• Protocol Buffers Well-Known Types

示例代码

以下是一个完整的示例代码，演示如何在Flutter项目中使用monarch_grpc插件进行gRPC通信。

1. 添加依赖

在pubspec.yaml文件中添加monarch_grpc和protobuf依赖：

dependencies:
  flutter:
    sdk: flutter
  monarch_grpc:
  protobuf:

2. 定义.proto文件

创建一个名为example.proto的文件，定义你的服务和消息类型。

syntax = "proto3";

package example;

// 定义请求消息
message ExampleRequest {
  string name = 1;
}

// 定义响应消息
message ExampleResponse {
  string message = 1;
}

// 定义服务
service ExampleService {
  rpc SayHello (ExampleRequest) returns (ExampleResponse);
}

3. 生成Dart代码

运行以下命令来生成Dart代码：

$ sh tools/gen_grpc.sh

或者在Windows上：

PS> .\tools\gen_grpc.bat

4. 创建gRPC客户端

在你的Flutter项目中创建一个gRPC客户端类来与服务端通信。

import 'dart:async';
import 'package:grpc/grpc.dart';
import 'package:example/example.pb.dart';
import 'package:example/example.pbgrpc.dart';

class GrpcClient {
  static const String _host = 'localhost';
  static const int _port = 50051;

  late ClientChannel _channel;
  late ExampleServiceClient _client;

  Future<void> init() async {
    _channel = ClientChannel(
      _host,
      port: _port,
      options: ChannelOptions(
        credentials: ChannelCredentials.insecure(),
      ),
    );
    _client = ExampleServiceClient(_channel);
  }

  Future<String> sayHello(String name) async {
    final request = ExampleRequest()..name = name;
    final response = await _client.sayHello(request);
    return response.message;
  }

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

5. 使用gRPC客户端

在你的Flutter页面中使用GrpcClient类来调用gRPC服务。

import 'package:flutter/material.dart';
import 'package:your_project/grpc_client.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatefulWidget {
  [@override](/user/override)
  _HomePageState createState() => _HomePageState();
}

class _HomePageState extends State<HomePage> {
  final _formKey = GlobalKey<FormState>();
  final _nameController = TextEditingController();

  String _response = '';

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('gRPC Example'),
      ),
      body: Padding(
        padding: EdgeInsets.all(16.0),
        child: Form(
          key: _formKey,
          child: Column(
            children: [
              TextFormField(
                controller: _nameController,
                decoration: InputDecoration(labelText: 'Name'),
                validator: (value) {
                  if (value == null || value.isEmpty) {
                    return 'Please enter your name';
                  }
                  return null;
                },
              ),
              SizedBox(height: 16.0),
              ElevatedButton(
                onPressed: () async {
                  if (_formKey.currentState!.validate()) {
                    final client = GrpcClient();
                    await client.init();
                    final response = await client.sayHello(_nameController.text);
                    setState(() {
                      _response = response;
                    });
                    client.close();
                  }
                },
                child: Text('Say Hello'),
              ),
              SizedBox(height: 16.0),
              Text(_response),
            ],
          ),
        ),
      ),
    );
  }
}