[官方文档](https://flutter.cn/docs/development/packages-and-plugins/plugin-api-migration)
自 1.12 版本发布后， Android 平台已可以使用新的 Android 插件 API 。基于 PluginRegistry.Registrar 的 API 不会立刻废弃，但我们鼓励您向基于 FlutterPlugin 的 API 进行迁移。
相较旧的 API 而言，新版 API 的优点是为生命周期的相关组件提供了更简洁清晰的访问方式。例如，在使用旧的 PluginRegistry.Registrar.activity() 时，如果 Flutter 尚未附加到任何 activites，可能会返回 null 。
换句话说，在使用旧的 API 进行 Flutter 嵌入 Android 应用时，可能会产生意外的行为。 Flutter 开发团队提供的大部分 Flutter 插件 已经完成了迁移。（了解如何成为 认证的发布者）作为参考， battery package 已经迁移到新版 API 。
看网上现有demo基本都是使用旧API,另外官网也未找到基于新API的完成示例（可能是我没注意）。
现结合官网文档，以弹出Toast为例整理出一demo。
前置知识
Package 和插件 (plugin) 有什么区别呢？ 插件 (plugin) 是 package 的一种，全称是 plugin package，我们简称为 plugin，中文叫插件。
Packages
Dart package 最低要求是包含一个 pubspec.yaml 文件。此外，一个 package 可以包含依赖关系 (在 pubspec.yaml 文件里声明)、 Dart 库、应用、资源、测试、图片和例子等。 pub.dev 上列出了很多 package，由 Google 工程师和 Flutter 和 Dart 社区的开发者开发和发布，你可以用在自己的应用里。
Plugins
插件 (plugin package) 是一种特别的 package，特别指那些帮助你获得原生平台特性的 package。插件可以为 Android (使用 Kotlin 或 Java 语言)、 iOS (使用 Swift 或 Objective-C 语言)、Web、macOS、Windows、Linux 平台，或其任意组合的平台编写。比如：某个插件可以为 Flutter 应用提供使用原生平台的摄像头的功能。
创建插件工程
-
通过命令
flutter create --org com.gqs --template=plugin --platforms=android,ios -a java show_toast -
IDE 直接创建
创建完成后，就会生成一个plugin模板工程。
FC37CA8D-BCB5-4161-8206-960F3670A2E4.png
增加功能
写代码前先整理下设计思路。
Flutter 功能引入plugin，调用plugin中的show toast 的API，native侧接收到flutter 调用，最后 通过native方法，弹 出toast。
修改Android 工程下的 ShowToastPlugin 类。该类 包名 及类名 与pubspec.yaml中的配置一致。
2824C4C3-59FA-449C-BBA7-11A929EA394A.png
基于以上思路，首先提供弹出toast的api，修改show_toast.dart 文件，如下
class ShowToast {
static Future<void> showToast({String? msg}) async {
}
}
该方法便可供外界调用，因工具方法 可直接通过静态方法实现。
后面我们需建立与native的通信。
Flutter 与native通信通过channel实现。
在Android工程下，可以看见生成了ShowToastPlugin类，该类实现了FlutterPlugin接口。这便是flutter 与native 建立关联的 类，在使用该插件时，便会自动注册到FlutterEngine中。
49FCAD52-1B1B-4E95-A0E7-C3718696E64D.png
现在我们在ShowToastPlugin中增加两个用于通信的channel。
MethodChannel 用于在 Flutter中以方法名的形式 向native侧发送消息。
MethodChannel则 用于native侧向flutter发送消息。查看源码其实可以发现MethodChannel 也是基于MethodChannel实现。在此不赘述。
修改后代码如下
private MethodChannel channel;
private ActivityPluginBinding binding;
private EventChannel eventChannel;
@Override
public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBinding) {
channel = new MethodChannel(flutterPluginBinding.getBinaryMessenger(), "show_toast");
channel.setMethodCallHandler(this);
eventChannel = new EventChannel(flutterPluginBinding.getBinaryMessenger(),"flutter_event_channel");
eventChannel.setStreamHandler(new ToastStreamHander());
}
为了接收MethodChannel 收到的消息，需为其设置MethodCallHandler, MethodCallHandler是以接口，我们通过ShowToastPlugin直接实现了，也可单独实现。实现接口方法
@Override
public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
if (call.method.equals("getPlatformVersion")) {
result.success("Android " + android.os.Build.VERSION.RELEASE);
}else if(call.method.equals("showToast")){
if(binding != null){
String msg = call.arguments();
Toast.makeText(binding.getActivity(), msg == null ? "null":msg, Toast.LENGTH_SHORT).show();
}
}else {
result.notImplemented();
}
}
通过 call.method属性判断调用的方法名，以此完成natvie方法的调用。
通过 FlutterPluginBinding 中的上下文对象，完成平台相关的调用。
最后增加对 EventChannel 消息的处理类 ToastStreamHander
public class ToastStreamHander implements EventChannel.StreamHandler{
@Override
public void onListen(Object arguments, EventChannel.EventSink events) {
dispatch(arguments, events);
}
@Override
public void onCancel(Object arguments) {
}
private void dispatch(Object arguments, EventChannel.EventSink events){
System.out.println("onListen===="+arguments);
events.success("send msg to dart "+arguments);
}
}
至此，插件的修改已经完成，后面通过模板工程里的 example工程进行验证。
功能验证
- 插件引用
ependencies:
flutter:
sdk: flutter
show_toast:
# When depending on this package from a real application you should use:
# show_toast: ^x.y.z
# See https://dart.dev/tools/pub/dependencies#version-constraints
# The example app is bundled with the plugin so we use a path dependency on
# the parent directory to use the current plugin's version.
path: ../
# The following adds the Cupertino Icons font to your application.
# Use with the CupertinoIcons class for iOS style icons.
cupertino_icons: ^1.0.2
- 创建页面
import 'package:flutter/material.dart';
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:show_toast/show_toast.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatefulWidget {
const MyApp({Key? key}) : super(key: key);
@override
State<MyApp> createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
String _platformVersion = 'Unknown';
final EventChannel _eventChannel =
const EventChannel('flutter_event_channel');
Future<void> registerEventChannel() async {
_eventChannel
.receiveBroadcastStream("com.gqs.android.event")
.listen((event) {
ShowToast.showToast(msg: 'event from ' + _platformVersion + ' ' + event.toString());
print('event from ' + _platformVersion + ' ' + event.toString());
});
}
@override
void initState() {
super.initState();
// registerEventChannel();
initPlatformState();
}
// Platform messages are asynchronous, so we initialize in an async method.
Future<void> initPlatformState() async {
String platformVersion;
// Platform messages may fail, so we use a try/catch PlatformException.
// WActivityPluginBindinge also handle the message potentially returning null.
try {
platformVersion =
await ShowToast.platformVersion ?? 'Unknown platform version';
} on PlatformException {
platformVersion = 'Failed to get platform version.';
}
// If the widget was removed from the tree while the asynchronous platform
// message was in flight, we want to discard the reply rather than calling
// setState to update our non-existent appearance.
if (!mounted) return;
setState(() {
_platformVersion = platformVersion;
});
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('Plugin example app'),
),
body: Center(
child: Text('Running on: $_platformVersion\n'),
),
floatingActionButton: FloatingActionButton(
onPressed: () => {
ShowToast.showToast(msg: 'Running on: $_platformVersion'),
registerEventChannel(),
}),
),
);
}
}
5903939D-71AF-4BF1-8B66-46DA00A9A4FD.png
以上就是创建插件的 完整流程，其中channel的使用没有细说，具体使用方式可以参考官方文档。
完结！
网友评论