Flutter之初识iOS插件开发

Flutter插件

简介

Flutter 的库是以 package 的方式来管理。Package 分为两种,Dart package(也叫 library package) 和 plugin package。日常使用的 import 'package:flutter/material.dart'; 就是 Dart 包,它只能使用 Dart 和 Flutter 提供的 API, 决定了它只能用在 Flutter 上;今天文章内容主要讲解 Flutter 插件开发指的是后者,即 plugin package。Flutter 插件既包含了dart代码编写的api,又包含了平台( Android/iOS )特定实现的package,可以被 Android 和 iOS 调用。

使用

可以在 pub.dev 网站查找你所需要的包。

我们以 shared_preferences 这个库为例,在项目中的 pubspec.yaml 声明一个依赖:

dependencies:
  shared_preferences: ^0.5.2

^0.5.2 与 0.5.2 兼容的版本版本号,同时你也可以使用如下格式:

  • any:任意版本
  • 1.2.3:特定的版本
  • <1.2.3:小于 1.2.3 的版本,此外还有 <=、>、>= 可以使用
  • =1.2.3 <2.0.0’:指定一个范围

更加详细的配置可以参考 versioning

保存后 Android Studio 会自动去下载此包,或者通过命令,在项目的根目录执行 flutter packages get
使用就相对简单了,如下:
import 'package:shared_preferences/shared_preferences.dart';

开发

插件通信机制

15584954324475.png

如上图所示,Flutter 跟平台相关代码可以通过 MethodChannel 进行通信。客户端通过 MethodChannel 将方法调用和参数发生给 FlutterFlutter也通过 MethodChannel 接收相关的数据。

消息和响应是异步传递的,以确保用户界面保持响应(不会挂起)

创建插件项目

接下来利用 Android Studio 来进行插件开发, 创建成功后,目录结构如下:

dir_struct.png

  • android:插件本地代码的 Android 端实现
  • ios:iOS 端的实现
  • lib:Dart 代码。插件的客户将会使用这里实现的接口
  • example:插件的使用示例
  • test: 测试

其中,一个最package最少包含了两部分: * 一个pubspec.yaml文件:元数据文件,声明了package的名称、版本、作者等信息。

一个lib文件夹:包含里package的公开代码,文件夹至少需要存在<pakcage-name>.dart这个文件。

也可以利用 Flutter 命令来生成

flutter create --org com.kinsomy --template=plugin -i swift -a kotlin hello 

默认情况下,创建的plugin项目是使用 objective-c(iOS)和 java(Android)编写,如果需要增加对swift和kotlin的支持,可以在命令中添加 -i 和 -a。

注意点:插件命名符合 lowercase_with_underscores

编写 iOS 插件

FlutterPluginTestPlugin_m.png

Flutter 与 iOS 通信

iOS-Flutter插件_pdf.png

!

Dart 代码
import 'dart:async';
import 'package:flutter/services.dart';

class FlutterPluginTest {
  static const MethodChannel _channel =
  const MethodChannel('flutter_plugin_test');

  static Future<String> get platformVersion async {
    final String version = await _channel.invokeMethod('getPlatformVersion');
    return version;
  }
}
iOS 代码
@implementation FlutterPluginTestPlugin
+ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
  FlutterMethodChannel* channel = [FlutterMethodChannel
      methodChannelWithName:@"flutter_plugin_test"
            binaryMessenger:[registrar messenger]];
 //两种回调方式:
    //1.代理本质:内部调用channel 的Block执行代理函数
  FlutterPluginTestPlugin* instance = [[FlutterPluginTestPlugin alloc] init];
  [registrar addMethodCallDelegate:instance channel:channel];
//    //2.
//    channel setMethodCallHandler:^(FlutterMethodCall * _Nonnull call, FlutterResult  _Nonnull result) {
//
//    }
}

- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([@"getPlatformVersion" isEqualToString:call.method]) {
    result([@"iOS " stringByAppendingString:[[UIDevice currentDevice] systemVersion]]);
  } else {
    result(FlutterMethodNotImplemented);
  }
}
@end

其中,在 dart 端传入参数被解析为Map ,到了 oc 中会变成 NSDictionary,然后通过 key 获取到对应的值
如下为:类型对应表

15585074766210.jpg

iOS 与 Flutter 通信

Dart端

Channel.setMethodCallHandler((MethodCall call) async {
      assert(call.method == 'launch');
      handler(call.arguments);
    });

iOS端

 [self.channel invokeMethod:@"FunctionName" arguments:参数];

补充

在 通信机制中,还有两类 FlutterEventChannel,FlutterBasicMessageChannel,同时在Dart端使用同类型的Channel

参考文章

  1. packages 官方文档
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容