对我这段时间Flutter plugin的学习开发做一个记录。
主要参考官方的文档。
也可以看看微信的flutter plugin。Fluwx
就我个人理解，flutter即是一个桥梁，构建一个可以同时沟通IOS，Android等的通道。
而Plugin就是赋予我们能够去开发完善这个桥梁的能力，构建flutter中所没有的，但又需要的功能。
如何开始
成功安装Flutter和dart插件后，可以new Flutter project，
AndroidX建议勾上，如果使用Kotlin或Swift开发的话可以勾上Kotlin和Swift，这样默认生成的Plugin就是使用的相应的语言。
项目结构
这里就可以选择构建Plugin项目，Flutter会帮你自动构建一个plugin，包括通道Channel的搭建，flutter端，Native端的基础配置。
（什么是Channel可以百度看看，因为都自动生成好了我就不说了）
打开后是下面这样的项目结构
android和ios即是Native的编写部分，lib即是flutter的编写部分。还有example，就是字面上的意思，用来测试你的功能的demo，在编写完导入到其他项目后一般情况下这部分内容不会影响项目，需要注意的是example中就相当于一个项目，同样包括lib，android，ios，不要写错地方。
如何编写flutter端
lib下会有一个基础文件，一般内容如下：
static MethodChannel _channel =
const MethodChannel('location_service_check')..setMethodCallHandler(_handler);
static Future get platformVersion async {
final String version = await _channel.invokeMethod('getPlatformVersion');
return version;
}
channel即是给桥梁构建一个专门的key，对应的Native中的。也可以自定义，也可以建立新的。
初始的platformVersion方法即是官方给的例子，这里是用来获取平台版本。其他的方法也可以按他的样子照葫芦画瓢
假如要带上参数，可以像下面这样填写
static Future testMessage(String testString, bool testBool) async {
Map map = await _channel.invokeMethod("testMessage", {
"testString" : testString,
"testBool" : testBool,
});
return map["success"];
}
Flutter主动与Native主要是通过channel.invokeMethod,
@optionalTypeArgs
Future invokeMethod(String method, [ dynamic arguments ]) {
return _invokeMethod(method, missingOk: false, arguments: arguments);
}
method是与Native所对应的名称，唯一；arguments是传一个map，其他类型容易导致类型不正确，没有响应等问题。
Flutter与Native对应的类型可以由下图：
主动给Native发信息是通过invokeMethod，那么Native主动给flutter发消息是通过什么接收呢？
通过setMethodCallHandler ，_channel前的const去掉
static MethodChannel _channel =
const MethodChannel('location_service_check')..setMethodCallHandler(_handler);
static Future _handler(MethodCall methodCall) {
if ("testBack" == methodCall.method) {
// 监听
}
return Future.value(true);
}
方法跟传过去差不多，也是对应method名称，就调用对应方法。
要注意的是，传过去的时候（invokeMethod）可以接收返回值（需await），可以看到我testMessage中也接收了一个Map，Native中通过Resul返回，但仅能返回一次，即原生中是持续返回的数据，第二次调用返回就会报错。Handler中可以接收多次的数据，即相当于一个listener。即可以简单理解invokeMethod是函数方法，Handler是一个listener监听。
如何获取这个Handler获取的数据，有多种方法，比如Fluwx中是使用Stream（事件流）的方法，具体可以去看看Fluwx的源码。
也可以使用自定义listener的方式
/// 监听
abstract class TestListener {
/// 收到Native传递的[message]
void onTestBack(String message);
}
/// 测试监听
static final testListeners = List();
static Future _handler(MethodCall methodCall) {
if ("testBack" == methodCall.method) {
// 监听
addTestBack(methodCall.arguments);
}
return Future.value(true);
}
/// [map]即Native传回来的arguments
static void addTestBack(Map map) {
var message = map["message"];
for (var listener in testListeners) {
listener.onTestBack(message);
}
}
/// 添加该监听[testListener]
static void addTestBackListener(TestListener testListener) {
testListeners.add(testListener);
}
使用该Listener：
在需要使用的页面add该listener
这种方式可以由自己决定在哪里进行监听，什么时候监听，也可以在需要的时候remove监听，而且也不难理解，不需要去使用Stream这种相对比较复杂的东西。
监听可以实现，回调也是可以实现的，只需要稍微改一下方法：
static void testMessage(String testString, Function onSuccess ,Function onError) async {
Future res = _channel.invokeMethod("testMessage",{
"testString" : testString,
});
res.then((args) {
if (args["status"] == "success") {
onSuccess(args["message"]);
} else {
onError(args["errorCode"]);
}
});
}
如何编写Android原生
项目右键有个Flutter-Open Android Model可以进入到Android原生中，Android中的项目结构如下
要注意的是，在location_service_check(flutter项目名称)下编写，app是example的原生模块。假如添加了其他pub插件，也会有对应的模块。
在其下的xxxPlugin文件中进行相应的编写，假如不想挤在一个页面中，也可以建立新的文件，但凡是想要使用相关的registrar，最好在该页面中进行注册，或者建立新的channel。
之前的Flutter插件 plugin中注册使用的是
public static void registerWith(Registrar registrar) {
final MethodChannel channel = new MethodChannel(registrar.messenger(), "location_service_check");
channel.setMethodCallHandler(new LocationServiceCheckPlugin());
}
最新的Flutter插件中默认使用的是下面这个，但依旧保留了registerWith方法，方便之前版本的项目使用，所以最好两块都写上一样的操作
@Override
public void onAttachedToEngine(@NonNull FlutterPluginBinding flutterPluginBinding) {
channel = new MethodChannel(flutterPluginBinding.getFlutterEngine().getDartExecutor(), "location_service_check");
channel.setMethodCallHandler(this);
}
在Registrar或FlutterPluginBinding都能拿到对应的上下文Context，
registrar.context()
or
flutterPluginBinding.getApplicationContext()
只有通过这个Context，才能进行如startActivity，getSystemService等，这个context也就是MainActivity的context，对应要进行原生操作，特别是在原生中进行页面跳转等，这个Context是必不可少的。
同时，获取Flutter中的信息，也是通过Registrar或FlutterPluginBinding，比如获取Asset中的文件：
registrar.lookupKeyForAsset("name");
以及
flutterPluginBinding.getFlutterAssets().getAssetFilePathByName("name");
除了注册，就是接收到Flutter的信息进行处理，即onMethodCall
@Override
public void onMethodCall(@NonNull MethodCall call, @NonNull Result result) {
if ("getPlatformVersion".equals(call.method)) {
result.success("Android " + android.os.Build.VERSION.RELEASE);
} else if ("testMessage".equals(call.method)) {
testMessage(call.arguments, result);
} else {
result.notImplemented();
}
}
call.method即与Flutter中的invokeMethod中的method对应，然后调用对应的方法。
private void testMessage(Object args, Result result) {
JSONObject map = (JSONObject) args;
try {
String testMessage = map.getString("testString");
Map resMap = new HashMap<>();
resMap.put("status", "success");
resMap.put("message", "我收到了：" + testMessage);
// resMap.put("status", "error");
// resMap.put("errorCode", "出现错误了");
// 主动返回数据给Flutter
channel.invokeMethod("testBack", resMap);
// 返回数据，也有error方法，但一般只是用success进行处理也够了
result.success(resMap);
} catch (JSONException e) {
e.printStackTrace();
}
}
返回数据使用result.succes() ，主动给Flutter传数据是使用channel.invokeMethod()，注意区别。
result是该方法下的，Flutter调用哪个方法，就返回数据到该方法下，仅能返回一次，但不是必须的。
invokeMethod即跟Flutter中的类似，是基于通道channel的，可以在任何时间地点使用，没有次数限制，只要channel正确。即监听的主要获取参数方法（也有EventMethod方法，但感觉没那么方便）。
至此，一个简单的Flutter与Android的Plugin就完成了。其他原生操作与以上功能结合即可能实现相应的原生功能。
如何编写iOS原生
要编写ios，首先需要macOS系统并配置好相应的环境。
经过Pods下对应文件夹后一大串的目录即可找到相应的文件。
根据创建是选项生成OC或Swift文件及相关内容，同理可以建立其他文件来构建想要的结构，但不要忘了相应的注册。
主要.m文件：
+ (void)registerWithRegistrar:(NSObject*)registrar {
FlutterMethodChannel* channel = [FlutterMethodChannel
methodChannelWithName:@"location_service_check"
binaryMessenger:[registrar messenger]];
LocationServiceCheckPlugin* instance = [[LocationServiceCheckPlugin alloc] init];
[registrar addMethodCallDelegate:instance channel:channel];
}
与Android同理，也是通过registrar进行相关原生的操作或者获取Flutter中的信息。
在handleMethodCall接收Flutter传送的数据
- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
if ([@"getPlatformVersion" isEqualToString:call.method]) {
result([@"iOS " stringByAppendingString:[[UIDevice currentDevice] systemVersion]]);
} else if ([@"testMessage" isEqualToString:call.method]) {
[self checkLocationIsOpen:result];
} else {
result(FlutterMethodNotImplemented);
}
}
invokeMethod与result与Android端同理（channel要改一下以获取到）
- (void)testMessage:(NSDictionary*)args result:(FlutterResult)result {
NSString *testString = args[@"testString"];
NSMutableDictionary *resArgs = [NSMutableDictionary dictionary];
resArgs[@"status"] = @"success";
resArgs[@"message"] = [@"我收到了：" stringByAppendingString:testString];
//resArgs[@"status"] = @"error";
//resArgs[@"errorCode"] = @"出现错误了";
//主动返回数据给Flutter
[channel invokeMethod:@"testBack" arguments:resArgs];
//返回数据
result(resArgs);
}
static FlutterMethodChannel *channel = nil;
channel = [FlutterMethodChannel
methodChannelWithName:@"location_service_check"
binaryMessenger:[registrar messenger]];
至此，一个基本的Plugin项目就完成了。可以在example的lib编写个demo调用测试。
最后
Plugin的搭建并不困难，主要的Native的统一，即Android与iOS端的数据类型的统一，尽量保持一致，假如无法一致，或者说一端可以实现，另一端无法实现，该以怎样的方式处理。
导入项目方法，可以git或者本地：
location_service_check:
git:
url: https://github.com/...
location_service_check:
path: ../location_service_check
（../是与项目同一路径下，./是项目下）
以上主要是个人的实践理解，所以不讲述原理这一块，想了解更多的可以去看看官方文档，或者搜一下。
补充 - 2020.10.12
iOS端相关
FlutterPluginRegistrar跟Android端一样同样重要，也有lookupKeyForAsset方法。
若是想要在plugin中使用UIApplication相关的系统方法，可以调用
addApplicationDelegate方法
[registrar addApplicationDelegate:instance];
podspecs Plugin 常用说明
#
# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html
#
Pod::Spec.new do |s|
s.name = 'sharesdk_plugin'
s.version = '1.1.2'
s.summary = 'Flutter plugin for ShareSDK.'
s.description = <<-DESC
ShareSDK is the most comprehensive Social SDK in the world,which share easily with 40+ platforms.
DESC
s.homepage = 'http://www.mob.com/mobService/sharesdk'
s.license = { :file => '../LICENSE' }
s.author = { 'Mob' => '[email protected]' }
s.source = { :path => '.' }
s.source_files = 'Classes/**/*'
s.public_header_files = 'Classes/**/*.h'
s.dependency 'Flutter'
s.dependency 'mob_sharesdk', '4.3.8'
s.dependency 'mob_sharesdk/ShareSDKExtension'
s.dependency 'mob_sharesdk/ShareSDKUI'
s.dependency 'mob_sharesdk/ShareSDKPlatforms/WeChat_Lite'
s.dependency 'mob_sharesdk/ShareSDKPlatforms/Facebook_Lite'
s.dependency 'mob_sharesdk/ShareSDKPlatforms/WhatsApp'
#分享闭环
s.dependency 'mob_sharesdk/ShareSDKRestoreScene'
s.static_framework = true
s.ios.deployment_target = '8.0'
end
以上是项目创建后自动生成的podspec
podspec是对pod的配置，每个plugin在编写完后都是以第三方库pods的形式提供项目使用。
常用的配置：
s.platform: 指定平台，以及版本
s.dependency: 指定依赖库（API、SDK）使用，常见三种方式
- s.dependency 'Flutter'
- s.dependency 'Flutter', '~> 1.20.2'
- s.dependency ‘Flutter‘, :git => ‘https://github.com/flutter/flutter.git‘, :tag => ‘master‘
s.static_framework: 指定Pods为静态库模式
动态库相比静态库,减少了app可执行文件的大小.并且可以只在使用时,按需加载而不是在启动时加载.这个特性减低了启动时间,并且更优秀的利用了内存.
动态库不能依赖静态库
静态库更加稳定，但占用内存空间；动态库共享代码节约空间，不过很容易导致编译错误，较难定位与修复。
当podfile中使用了uses_framework! 时，可以使用s.static_framework = true支持静态框架。
s.resource_bundles: 指定资源路径
s.resource_bundles= {`
'TestBundle' => ['Classes/Resources/Assets/*']
}
'TestBundle' 为显示的资源的bundle名字，可自定，后面为指定文件目录。
设置成功即可在pods中通过Bundle调用Pods中的资源
NSString* key = [_registrar lookupKeyForAsset:@"icons/test.png"];
NSString* path = [[NSBundle mainBundle] pathForResource:key ofType:nil];
NSLog(@"%@", path);
或
NSString *imgName = [NSString stringWithFormat:@"%@/%@", @"TestBundle.bundle",@"test"];
imgView.image = [UIImage imageNamed:imgName];