flutter pigeon如何使用

Flutter Pigeon的具体使用步骤是什么？有没有详细的教程或者示例代码可以参考？我在配置过程中遇到了问题，不知道如何正确设置通道和方法调用，希望能得到一些指导。

2 回复

Flutter Pigeon 用于生成类型安全的平台间通信代码。步骤：

  1. 在 pubspec.yaml 添加依赖。
  2. 创建 .dart 接口文件定义方法。
  3. 运行 flutter pub run pigeon 生成代码。
  4. 在 Flutter 和原生平台实现接口。

更多关于flutter pigeon如何使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


Flutter Pigeon 是一个用于在 Flutter 和原生平台（如 Android 和 iOS）之间生成类型安全通信代码的工具。它通过定义接口来自动生成消息通道代码，简化平台通道的使用。

基本使用步骤：

  1. 添加依赖
    在 pubspec.yaml 中添加：

    dev_dependencies:
  pigeon: ^13.0.0

  2. 创建 Pigeon 定义文件
    新建 pigeons/message.dart，定义接口：

    import 'package:pigeon/pigeon.dart';

// 示例：定义从 Flutter 调用原生的方法
[@HostApi](/user/HostApi)()
abstract class MessageApi {
  String getMessage(String text);
}

  3. 生成代码
    运行命令生成平台代码：

    flutter pub run pigeon --input pigeons/message.dart \
  --dart_out lib/message_api.dart \
  --objc_header_out ios/Runner/MessageApi.h \
  --objc_source_out ios/Runner/MessageApi.m \
  --java_out android/app/src/main/java/com/example/app/MessageApi.java \
  --java_package "com.example.app"

  4. 在 Flutter 中调用

    import 'message_api.dart';

final api = MessageApi();
String result = await api.getMessage("Hello");

  5. 原生端实现

    • Android：在 MainActivity 中实现 MessageApi 接口。
    • iOS：在 AppDelegate 中实现 MessageApi 协议。

注意事项：

  • 确保接口定义路径正确，生成命令中的包名和路径需匹配项目结构。
  • 支持复杂数据类型（如 List、Map）和自定义类（需用 [@HostApi](/user/HostApi)() 或 @FlutterApi() 标注）。

通过 Pigeon，可减少手动编写平台通道代码的错误，提升开发效率。

回到顶部