在上一篇文章里具体介绍了flutter插件的具体开发流程,从创建项目到发布。接下来将会为项目开发一个基于高德定位sdk的flutter定位插件。
完整代码在git仓库里
申请key
首先先进入到内下载定位sdk,并按要求申请app key,这里不多做介绍,文档已经很详细了
配置环境
sdk文档里同样有关于配置工程的demo,但是因为flutter 插件项目不是一个android工程,所以会有所区别。大致分以下几步:
1.集成远程依赖
compile 'com.amap.api:location:latest.integration'复制代码
2.配置app key
在AndroidManifest.xml的application标签中配置Key:
复制代码
3.声明service
在application标签中声明service组件:
复制代码
4.声明权限
flutter插件的目的就是隔离对sdk native code的实现,让使用者直接使用dart代码就可以获得到sdk提供的定位信息,插件和使用者交互的代码是在libs下的dart文件中提供的接口。 插件的android文件夹下面是一个完整的android工程结构,我们在这个工程下完成上述的四步。唯一一点不同的是,配置app key利用gradle里的manifestPlaceholders属性为用户预留,让用户自己来填写。
于是配置app key改写成:
复制代码
这个LOCATION_APP_KEY,使用者使用插件的时候在自己flutter项目的android工程下的app/build.gradle文件里填写自己申请的高德key即可。
android { compileSdkVersion 27 lintOptions { ... } defaultConfig { ... manifestPlaceholders = [ LOCATION_APP_KEY : "b947abf0a6820efedc65d06428f14281", /// 高德地图key ] }}复制代码
到目前为止,一个基于高德sdk的定位插件工程就算配置好了,下面就是实现部分。
实现
flutter 插件最终暴露给插件使用者的是dart代码的接口,使用者不再需要关心Android和Ios平台上的代码,在定位插件项目中,唯一需要配置的就是上文所说的高德开放平台的app key.
因为现在是将特定平台的sdk开发成插件供flutter app使用,其实就可以理解在Android或者ios平台正常开发项目,将flutter app需要的数据传递过去,flutter插件只是在特定平台的实现上做了一次封装与隔离,封装了dart接口,隔离了两个不同平台实现的差异。
理解这个概念,写出一个flutter插件就变得很容易了,dart和java之间的相互通信在前面写的一篇文章中Flutter和原生互相通信一节讲述过,这里就直接上手展示源码。
Java部分
java部分的代码写在了AmapLocationPlugin.java类下面,它分别实现了MethodChannel.MethodCallHandler, EventChannel.StreamHandler。并且在registerWith方法调用的实例化MethodChannel和EventChannel。
final MethodChannel methodChannel = new MethodChannel(registrar.messenger(), "plugin.kinsomy.com/methodchannel");final EventChannel eventChannel = new EventChannel(registrar.messenger(), "plugin.kinsomy.com/eventchannel");复制代码
- 重写MethodChannel.MethodCallHandler的onMethodCall方法接受dart代码的方法调用
@Override public void onMethodCall(MethodCall call, Result result) { if (call.method.equals("startLocation")) { //启动定位 mLocationClient.startLocation(); } else if (call.method.equals("stopLocation")) { //停止定位 mLocationClient.stopLocation(); } else if (call.method.equals("getLocation")) { result.success(mLocation); } else { result.notImplemented(); } }复制代码
- 重写EventChannel.StreamHandler的onListen,该方法携带了一个EventChannel.EventSink实例,通过该实例对象可以调用mEventSink.success()向dart传递数据流,也就是插件里的定位信息
@Override public void onListen(Object o, EventChannel.EventSink eventSink) { this.mEventSink = eventSink; }复制代码
- 通过高德sdk的AMapLocationClient获取到定位信息,并将其封装成json字符串供dart调用。
dart部分
dart部分的代码在项目根目录lib文件夹下的amap_location_plugin.dart文件。
- 在构造函数里实例化和java代码中同样channel name的MethodChannel与EventChannel
factory AmapLocation() { if (_instance == null) { final MethodChannel methodChannel = const MethodChannel('plugin.kinsomy.com/methodchannel'); final EventChannel eventChannel = const EventChannel('plugin.kinsomy.com/eventchannel'); _instance = AmapLocation.private(methodChannel, eventChannel); } return _instance; }复制代码
- 提供接口方法开始定位startLocation和对应的停止定位
Futureget startLocation => _methodChannel.invokeMethod("startLocation");复制代码
- 实例化Stream接受event返回的定位数据
Stream_onLocationFetched;_onLocationFetched = _eventChannel.receiveBroadcastStream().map((dynamic event) => event);复制代码
这样一个基于高德定位sdk的flutter定位插件就算完成了,在example里写一个demo实际测试一下。
目前这个插件还是个简易版本,未来希望能加上地图,导航,线路规划等一系列的功能
,欢迎贡献代码和issue,喜欢可以给个star