Flutter功能未明确定义插件Tart的使用

描述

Tart 是一个用于 Dart 的 Twirp 库。它是一个运行时库，用于支持由 protoc-gen-tart Protocol Buffers 编译器插件生成的 .pbtwirp.dart 文件。该库、protoc 编译器插件和示例可以在 GitHub 上找到。

使用场景

Tart 主要用于简化通过 Twirp 协议进行远程过程调用（RPC）的应用程序开发。Twirp 是一种轻量级的 RPC 框架，旨在与 Protocol Buffers 一起工作。Tart 提供了在 Dart 和 Flutter 中使用 Twirp 的能力，使得开发者可以轻松地创建客户端和服务端应用程序。

示例代码解析

以下是一个简单的例子，展示了如何使用 Tart 进行 RPC 调用并处理错误：

/// This example is as simple as can be to make RPC calls and handle errors
/// Please go to https://github.com/syncapod/tart for a more thorough example

import 'dart:math';

import 'package:client/protos/haberdasher.pbtwirp.dart';
import 'package:client/protos/haberdasher.pb.dart';
import 'package:client/protos/suit.pb.dart';
import 'package:tart/tart.dart';

void main(List<String> arguments) async {
  try {
    // 创建 HaberdasherProtobufClient 客户端实例
    final client = HaberdasherProtobufClient("http://localhost:8080", "twirp");
    // 创建一个空的上下文对象
    final emptyCtx = Context();

    // 调用 makeHat 方法，并传入随机尺寸参数
    final hat = await client.makeHat(emptyCtx, Size(inches: Random().nextInt(4) + 6));
    print("Hat made: ${hat.inches}in ${hat.color} ${hat.name}");

    // 调用 makeSuit 方法，并传入 SuitSize.LG 尺寸参数
    final suit = await client.makeSuit(emptyCtx, SuitSizeReq(size: SuitSize.LG));
    print('Suit made: ${suit.size} ${suit.color}');
  } on TwirpError catch (e) {
    // 捕获 TwirpError 错误类型
    final method = e.getContext.value(ContextKeys.methodName);
    print('Error making $method rpc call: ${e.getCode}, ${e.getMsg}');
  } catch (e, stackTrace) {
    // 捕获其他类型的异常
    print('Unknown exception occurred $e');
    print('StackTrace: $stackTrace');
  }
}

关键点说明

• HaberdasherProtobufClient: 这是 Tart 生成的客户端类，用于与 Twirp 服务进行通信。
• Context: 用于传递上下文信息的对象，如请求超时等。
• makeHat 和 makeSuit: 这些方法是根据 Twirp 服务定义生成的，用于调用远程方法。
• TwirpError: 当 Twirp 请求失败时抛出的特定错误类型。

完整示例 Demo

为了更好地理解如何使用 Tart 插件，下面提供了一个更完整的示例应用。这个应用将展示如何设置客户端和服务端，并进行基本的 RPC 调用。

1. 设置环境

确保你已经安装了 protoc 编译器和 protoc-gen-tart 插件。你可以参考 GitHub 上的文档来完成这些步骤。

2. 定义 Protobuf 文件

创建一个名为 haberdasher.proto 的文件，内容如下：

syntax = "proto3";

package haberdasher;

service Haberdasher {
  rpc MakeHat(Size) returns (Hat);
  rpc MakeSuit(SuitSizeReq) returns (Suit);
}

message Size {
  int32 inches = 1;
}

message Hat {
  string name = 1;
  string color = 2;
  int32 inches = 3;
}

message SuitSizeReq {
  SuitSize size = 1;
}

enum SuitSize {
  XS = 0;
  S = 1;
  M = 2;
  L = 3;
  XL = 4;
  XXL = 5;
}

message Suit {
  SuitSize size = 1;
  string color = 2;
}

3. 生成 Dart 代码

使用 protoc-gen-tart 插件生成 Dart 代码：

protoc --tart_out=. haberdasher.proto

4. 创建 Flutter 客户端

在 Flutter 项目中添加依赖项：

dependencies:
  tart: ^latest_version
  protobuf: ^latest_version

创建 main.dart 文件，内容如下：

import 'dart:math';

import 'package:flutter/material.dart';
import 'package:tart/tart.dart';
import 'package:client/protos/haberdasher.pbtwirp.dart';
import 'package:client/protos/haberdasher.pb.dart';
import 'package:client/protos/suit.pb.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Tart Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Tart Example'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _result = '';

  void _makeRpcCall() async {
    try {
      final client = HaberdasherProtobufClient("http://localhost:8080", "twirp");
      final emptyCtx = Context();

      final hat = await client.makeHat(emptyCtx, Size(inches: Random().nextInt(4) + 6));
      setState(() {
        _result = "Hat made: ${hat.inches}in ${hat.color} ${hat.name}";
      });

      final suit = await client.makeSuit(emptyCtx, SuitSizeReq(size: SuitSize.LG));
      setState(() {
        _result += "\nSuit made: ${suit.size} ${suit.color}";
      });
    } on TwirpError catch (e) {
      final method = e.getContext.value(ContextKeys.methodName);
      setState(() {
        _result = 'Error making $method rpc call: ${e.getCode}, ${e.getMsg}';
      });
    } catch (e, stackTrace) {
      setState(() {
        _result = 'Unknown exception occurred $e\nStackTrace: $stackTrace';
      });
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Result:',
            ),
            Text(
              '$_result',
              style: Theme.of(context).textTheme.headline4,
            ),
            ElevatedButton(
              onPressed: _makeRpcCall,
              child: Text('Make RPC Call'),
            ),
          ],
        ),
      ),
    );
  }
}

5. 启动服务端

确保你的 Twirp 服务已经在本地运行，监听 http://localhost:8080。

6. 运行客户端

启动 Flutter 应用，点击按钮进行 RPC 调用，并查看结果。

通过以上步骤，你应该能够成功地在 Flutter 中使用 Tart 插件进行 Twirp RPC 调用。希望这个详细的解释对你有所帮助！如果有任何问题，请随时提问。