Flutter Plugin开发流程
这篇文章主要介绍了flutter plugin开发流程,包括如何利用android studio开发以及发布等。
本文主要给大家介绍如何开发flutter plugin中android的部分。有关flutter以及flutter plugin的概念,感兴趣的可以从官网查看相关资料。
1. 简介
笔者的环境是mac下android studio进行的开发,as也是谷歌官推的,安装flutter插件后,开发起来相对于其他ide来说,方便很多,自带了三种模板:
- flutter application: flutter应用
- flutter plugin:flutter插件
- flutter package:纯dart组件
plugin其实就是一个特殊的package
。flutter plugin提供android或者ios的底层封装,在flutter层提供组件功能,使flutter可以较方便的调取native的模块。很多平台相关性或者对于flutter实现起来比较复杂的部分,都可以封装成plugin。其原理如下
消息在client和host之间通过平台通道(platform channels)来进行的,之间的通讯都是异步
的。
2. 创建组件
直接在android studio中新建一个flutter plugin的工程,当然也可以使用命令行来进行,例如创建一个flutter_text_plugin。
flutter create --org com.example --plugin flutter_text_plugin
如果想支持swift或者kotlin,可以用如下命令进行创建:
flutter create --org com.example --plugin -i swift -a kotlin flutter_text_plugin
更多的参数选项,大家可以 查看帮助文档,当然还是比较推荐直接用as进行创建,简单直观。用as打开项目,可以看到项目的组织结构
root android example ios lib ...
android以及ios文件夹是我们将要编写插件的native层的地方,lib文件夹是编写与native层映射的地方,native与flutter之间不能直接通信,必须通过methodchannel来间接调用。example文件夹则是例子工程,编写的插件可以直接在这个项目中进行验证。在本文中,我们主要在android目录下进行,也就是android部分。
3. 编写android部分
用as打开flutter_text_plugin/android项目,这样子开发起来比较方便。但是打开过后,会发现出现了很多错误,提示找不到flutter相关的东西,我们仔细看这个项目,会发现跟我们平时用as建的android项目有所不同,少了很多部分,目录也有所不同。这是因为这个android项目不需要能够直接去运行,因此减少了很多东西。但是对于初次接触的人来说,可能是一头懵逼,例如该如何添加第三方库,如何添加proguard rule等等。
3.1 引入flutter库
android插件工程是没有引入flutter库的,所以才会出现错误提示,我们在项目根目录建立一个libs文件夹,用来存放flutter库。
flutter库就在我们的flutter sdk中,路径如下
engine下面包含了各种平台的flutter库,我们随便拷贝一个android平台的库到libs文件夹下,右键flutter.jar,弹出菜单选择add as library...
。
经过这一步,项目中不会再报错了,但是,由于整个flutter plugin包含了flutter库,因此不能只是简单的添加就了事了,点击菜单project structure...
,找到flutter_text_plugin的dependencies中,将flutter库的scope从implementation改成compile only
。至此,引入flutter库的工作完成了,可以进行插件的编写操作了。
3.2 添加第三方库
添加第三方库有两种,一种是jar包引入,另一种通过gradle的方式进行。由于进行了第一步flutter库的引入,这一步就简单多了。查看build.gradle文件,可以看到最下面出现了如下的信息。
dependencies { compileonly files('libs/flutter.jar') }
看到这个,是不是就明朗多了,添加静态库以及添加在线库都可以在这个地方进行。例如我添加一个bugly静态库以及okhttp3库:
dependencies { compileonly files('libs/flutter.jar') implementation 'com.squareup.okhttp3:okhttp:3.10.0' implementation files('libs/bugly_crash_release.jar') }
3.3 添加proguard rule
由于了bugly以及okhttp3库,因此需要添加progurad rule。我们发现项目中没有proguard-rules.pro文件,因此这一步也需要我们自己去创建,在根目录下,建立proguard-rules.pro文件,将混淆规则添加进去,然后修改build.gradle文件,添加如下信息,跟普通android项目差不多:
buildtypes { release { minifyenabled true proguardfiles getdefaultproguardfile('proguard-android.txt'), 'proguard-rules.pro' } debug { minifyenabled false proguardfiles getdefaultproguardfile('proguard-android.txt'), 'proguard-rules.pro' } }
3.4 android权限
添加了bugly以及okhttp3库,需要对应的权限申明,才能正常运行。直接在manifest文件下,添加对应的权限
<uses-permission android:name="android.permission.read_phone_state" /> <uses-permission android:name="android.permission.internet" /> <uses-permission android:name="android.permission.access_network_state" /> <uses-permission android:name="android.permission.access_wifi_state" /> <uses-permission android:name="android.permission.read_logs"/>
3.5 插件开发
至此,准备工作都已就绪,你可以把这个项目当做一个独立的android项目,在上面进行各种封装操作,然后在fluttertestplugin文件下,将接口暴露出来。通过platform channels与flutter层关联起来。
4. 发布
当插件开发完毕,可以将插件发布让其他人使用,在发布之前,确保pubspec.yaml,、readme.md以及changelog.md文件的内容都正确填写完毕。可以通过dry-run命令来看准备是否就绪。
flutter packages pub publish --dry-run
检查无误后,可以执行下面的命令,发布到pub上。
flutter packages pub publish
5. 如何引用
对插件的引用有两种,已经发布的和未发布的。
5.1 引用发布的库
flutter项目的很多资源管理都在根目录的pubspec.yaml下面,类似于js中的一些包管理一样,在dependencies
加上我们需要引入的库,例如引入url_launcher库:
dependencies: url_launcher: ^0.4.2
如果这个库包含了一些平台相关的东西,例如需要在native层进行使用的话,则需要在对应的native项目单独做引用。
5.1.1 android
修改android/build.gradle的dependencies处做引用:
dependencies { provided rootproject.findproject(":url_launcher") }
5.1.2 ios
修改ios/hello.podspec文件
pod::spec.new do |s| # lines skipped s.dependency 'url_launcher'
5.1.3 引用冲突
引用不同的库可能会导致一些冲突,例如a和b两个插件,都包含了c插件,但是所需的版本不同。因此我们可以采取以下措施避免这种问题:
- 尽量使用范围版本而不是指定一个特定的版本。
- 强制统一冲突的插件版本
- 对于native层,android可以通过force命令强制指定版本,而ios这边,cocoapods则不支持引用的override功能。
5.2 引用未发布的库
引用未发布的库有两种方式,通过本地路径和git地址的方式:
5.2.1 基于path的引用方式:
这种方式主要针对本地的未发布的库,引用的路径可以是相对或者绝对路径。
dependencies: plugin1: path: ../plugin1/
5.2.2 基于git的引用方式:
这种方式针对存放在git上的库,其中path是可选的,可以定位到某个子目录
dependencies: package1: git: url: git://github.com/flutter/packages.git path: packages/package1
6. 后话
笔者建了一个flutter学习相关的项目,github地址,里面包含了笔者写的关于flutter学习相关的一些文章,会定期更新,也会上传一些学习demo,欢迎大家关注。