526互联

一统天下 flutter - 插件: flutter 与 android 原生之间的数据通信

发布时间 2023-04-10 09:11:29作者: webabcd

一统天下 flutter https://github.com/webabcd/flutter_demo
作者 webabcd

一统天下 flutter - 插件: flutter 与 android 原生之间的数据通信

示例如下:

lib\plugin\plugin.dart

/*
 * 插件
 * 本例用于演示 flutter 与 android/ios 原生之间的数据通信
 *
 * 一、android 插件开发
 * 1、主 flutter 项目要先在 android 平台中运行一下
 * 2、在 android 文件夹上，使用右键菜单，然后选择 Flutter -> Open Android module in Android Studio 即可开发插件
 * 3、参见 /android/app/src/main/kotlin/com/example/flutter_demo/MainActivity.kt
 *
 * 二、ios 插件开发
 * 1、主 flutter 项目要先在 ios 平台中运行一下
 * 2、在 android studio 或 visual studio code 中执行如下逻辑
 *    cd ios
 *    pod install
 * 3、用 xcode 中打开 /ios/Runner.xcworkspace 即可开发插件
 * 4、参见 /ios/Runner/AppDelegate.swift
 *
 *
 * 注：插件中实现的功能不支持 flutter 的 hot reload
 */

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:flutter_demo/helper.dart';

class PluginDemo extends StatefulWidget {
  const PluginDemo({Key? key}) : super(key: key);

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

class _PluginDemoState extends State<PluginDemo> {

  String text = "";

  @override
  Widget build(BuildContext context) {

    return Scaffold(
      appBar: AppBar(
        title: const Text('title'),
      ),
      backgroundColor: Colors.orange,
      body: Center(
        child: MyText(text),
      ),
      persistentFooterButtons: [
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method1();
            setState(() {
              text = result;
            });
          },
          child: const Text("method1"),
        ),
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method2();
            setState(() {
              text = result;
            });
          },
          child: const Text("method2"),
        ),
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method3();
            setState(() {
              text = result;
            });
          },
          child: const Text("method3"),
        ),
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method4();
            setState(() {
              text = result;
            });
          },
          child: const Text("method4"),
        ),
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method5();
            setState(() {
              text = result;
            });
          },
          child: const Text("method5"),
        ),
        MyButton(
          onPressed: () async {
            var result = await MyPlugin.method6();
            setState(() {
              text = result;
            });
          },
          child: const Text("method6"),
        ),
      ],
    );
  }
}


class MyPlugin {
  /// 获取指定名称的 MethodChannel（其用于 flutter 和插件之间的通信）
  static final MethodChannel _methodChannel = const MethodChannel("com.webabcd.flutter/channel1")
    ..setMethodCallHandler(_callHandler); /// 插件调用 flutter 时会执行这里

  /// 用于演示如何接收插件调用 flutter 时的方法名和参数值
  static Future<dynamic> _callHandler(MethodCall call) async {
    log("method:${call.method}, arguments:${call.arguments}");
  }

  static Future<String> method1() async {
    /// flutter 调用插件中的方法
    return await _methodChannel.invokeMethod("method1");
  }

  static Future<String> method2() async {
    /// flutter 调用插件中的方法，并传递一个字符串类型的参数
    return await _methodChannel.invokeMethod("method2", "abc");
  }

  static Future<String> method3() async {
    /// flutter 调用插件中的方法，并传递一个字典表类型的参数
    var map = {"name": "webabcd", "age": 43};
    return await _methodChannel.invokeMethod("method3", map);
  }

  static Future<String> method4() async {
    /// flutter 调用插件中的方法，并传递一个列表类型的参数
    var list = [1, 2, 3];
    return await _methodChannel.invokeMethod("method4", list);
  }

  static Future<String> method5() async {
    /// flutter 调用插件中的方法，并捕获异常
    try {
      return await _methodChannel.invokeMethod("method5");
    } on PlatformException catch(e) {
      return "调用 method5 异常 code:${e.code}, message:${e.message}, details:${e.details}";
    }
  }

  static Future<String> method6() async {
    /// flutter 调用插件中的方法，但是插件中没有这个方法
    try {
      return await _methodChannel.invokeMethod("method6");
    } on MissingPluginException catch(e) {
      return "调用 method6 异常 ${e.toString()}";
    }
  }
}

android\app\src\main\kotlin\com\example\flutter_demo\MainActivity.kt

/*
 * 本例用于演示 android 插件的开发
 */

package com.example.flutter_demo

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugins.GeneratedPluginRegistrant

class MainActivity: FlutterActivity() {

    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
        super.configureFlutterEngine(flutterEngine)

        val plugin1 = MyFlutterPlugin1()
        val plugin2 = MyFlutterPlugin2()

        // 注册自定义插件，用于演示 flutter 与 android 原生之间的数据通信
        flutterEngine.plugins.add(plugin1)

        // 注册自定义插件，用于演示 flutter 使用 android 原生控件，并做数据通信
        flutterEngine.plugins.add(plugin2)

        GeneratedPluginRegistrant.registerWith(flutterEngine)
    }
}

android\app\src\main\kotlin\com\example\flutter_demo\MyFlutterPlugin1.kt

/**
 * 自定义插件，用于演示 flutter 与 android 原生之间的数据通信
 */

package com.example.flutter_demo

import io.flutter.embedding.engine.plugins.FlutterPlugin
import io.flutter.plugin.common.MethodChannel

// 自定义插件
class MyFlutterPlugin1 : FlutterPlugin {

    override fun onAttachedToEngine(binding: FlutterPlugin.FlutterPluginBinding) {

        // 获取 android 的 application 级别的 context
        var applicationContext = binding.applicationContext;

        // 创建一个 MethodChannel 并指定其名称，它用于 flutter 和 android 插件之间的通信（在 flutter 中通过名称获取此 channel 后就可以通信了）
        // binding.binaryMessenger 的意思是这个 MethodChannel 用于传输二进制数据
        val methodChannel = MethodChannel(binding.binaryMessenger, "com.webabcd.flutter/channel1")

        // flutter 调用 android 插件中的方法时，会执行到这里
        methodChannel.setMethodCallHandler { call, result ->
            // flutter 调用 android 插件中的方法的名称
            val method = call.method

            if (method == "method1") {
                val returnValue = method1()
                // 返回给 flutter 的结果
                result.success(returnValue)

                // 用于演示 android 调用 flutter
                methodChannel.invokeMethod("nativeToFlutter", "param")
            }

            else if (method == "method2") {
                // 通过 call.arguments 获取 flutter 调用 android 插件中的方法时传递的参数
                val param = call.arguments as String
                val returnValue = method2(param)
                // 返回给 flutter 的结果
                result.success(returnValue)
            }

            else if (method == "method3") {
                // 通过 call.argument<T>(key) 获取 flutter 调用 android 插件中的方法时传递的字典表中的指定 key 的数据
                val name = call.argument<String>("name")!!
                val age = call.argument<Int>("age")!!
                val returnValue = method3(name, age)
                // 返回给 flutter 的结果
                result.success(returnValue)
            }

            else if (method == "method4") {
                // 通过 call.arguments<T>() 获取 flutter 调用 android 插件中的方法时传递的参数
                val param = call.arguments<List<Int>>()!!
                val returnValue = method4(param)
                // 返回给 flutter 的结果
                result.success(returnValue)
            }

            else if (method == "method5") {
                // 返回给 flutter 的自定义异常信息（flutter 中可以通过 try/catch 捕获到一个 PlatformException 类型的异常）
                result.error("errorCode", "errorMessage", "errorDetails")
            }

            else {
                // 如果 android 插件中没有 flutter 调用的方法，则可以返回如下异常（flutter 中可以通过 try/catch 捕获到一个 MissingPluginException 类型的异常）
                result.notImplemented()
            }
        }
    }

    private fun method1(): String {
        return "调用 method1 成功"
    }

    private fun method2(param:String): String {
        return "调用 method2 成功 param:$param"
    }

    private fun method3(name:String, age:Int): String {
        return "调用 method3 成功 name:$name, age:$age"
    }

    private fun method4(param:List<Int>): String {
        return "调用 method4 成功 ${param.joinToString(",")}"
    }

    override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) {

    }
}

一统天下 flutter https://github.com/webabcd/flutter_demo
作者 webabcd