第一个flutter插件的发布(leleping)
前言
用flutter开发时间也不短了,在开发过程当中不可避免的会用到插件包package,之前也进行过把第三方的插件下载下来然后修改发布到自己仓库上的操作,但由于这一次没有找到相应的插件,于是自己根据需求在https://pub.dartlang.org/上发布了自己的第一款插件,仅做记录,供大家参考。
过程
先说需求,需求很简单。我们想通过ping和traceroute的原理,对指定域名进行网络诊断,并收集诊断日志。
关于这块已经有很成熟的框架供我们使用,在这里感谢网易电商团队的开源框架https://github.com/Lede-Inc/LDNetDiagnoService_IOS,分别有iOS和安卓的实现。
所以我们要做的就是开发一个能够实现flutter与原生端交互的插件,原生端的代码实现就是借助LDNetDiagnoService框架来实现
1.创建 package
自己创建一个文件夹,在终端cd到指定文件夹。
执行命令
flutter create --org com.example --template=plugin hello
- --org 您组织的标识,用反向域名表示法。该值用于生成的Android和iOS代码中的各种包和包标识符。
- plugin xxxx 是您插件的名字 我这里用了leleping
- 默认情况下,插件项目针对iOS代码使用Objective-C,Android代码使用Java。如果您更喜欢Swift或Kotlin,则可以使用-i 或 -a 为iOS或Android指定语言。例如:
flutter create --template=plugin -i swift -a kotlin hello
命令执行完后会在hello/文件夹下创建一个具有以下专用内容的插件工程(区别于新建的flutter工程):
- lib/hello.dart:
插件包的Dart API. - android/src/main/java/com/yourcompany/hello/HelloPlugin.java:
插件包API的Android实现. - ios/Classes/HelloPlugin.m:
插件包API的ios实现. - example/:
一个依赖于该插件的Flutter应用程序,来说明如何使用它(写代码调试是在这个文件夹下操作的)
2.0实现包 package
由于插件包中包含用多种编程语言编写的多个平台的代码,因此需要一些特定的步骤来确保顺畅的体验。
- 定义包API(.dart)
插件包的API在Dart代码中定义。打开主文件夹hello/ 。找到lib/hello.dart。在里面定义我们想要暴露出来的api。 - 添加Android平台代码(.java / .kt)
在Android Studio中编辑Android平台代码之前,首先确保代码至少已经构建过一次(用AS在安卓模拟器或者真机上run一次)然后:
1.启动Android Studio
2.在’Welcome to Android Studio’对话框选择 ‘Import project’, 或者在菜单栏 ‘File > New > Import Project…‘,然后选择hello/example/android/build.gradle文件.
3.在’Gradle Sync’ 对话框, 选择 ‘OK’.
4.在’Android Gradle Plugin Update’ 对话框, 选择 ‘Don’t remind me again for this project’.
您插件的Android平台代码位于 hello/java/com.yourcompany.hello/HelloPlugin.
您可以通过按下 ▶ 按钮从Android Studio运行示例应用程序.
- 添加iOS平台代码 (.h+.m/.swift)
在编辑Xcode中的iOS平台代码之前,首先确保代码至少已经构建过一次(例如,从Xcode中运行示例应用程序或终端执行cd hello/example; flutter build ios --no-codesign)。然后:
1.启动 Xcode
2.选择 ‘File > Open’, 然后选择 hello/example/ios/Runner.xcworkspace 文件.
您插件的iOS平台代码位于Pods/DevelopmentPods/hello/Classes/中。
调试可以执行运行xcode来打断点调试。
tip:一般的插件只需要在.m文件中添加原生代码即刻。这次我因为需要集成网易的ping框架,用法和正常iOS项目一样,直接用pod集成即可。 - 连接API和平台代码
最后,您需要将用Dart代码编写的API与平台特定的实现连接起来。这是通过platform channels完成的。这篇文章主要讲插件,platform相关内容还请自行查阅。
3.0发布 packages
到了这里我们我们基本上就可以发布我们自己写的插件到官方平台Pub了。里面的一些文档设置我会在文章底部贴出来链接,这里讲主要流程。
在发布之前,检查pubspec.yaml
、README.md
以及CHANGELOG.md
文件,以确保其内容的完整性和正确性。
首先运行 dry-run 命令以查看是否都准备OK了:
flutter packages pub publish --dry-run
如果遇见什么问题,照着错误提示去修改即可
当提示都ok的时候,我们就可以完成最后一步的发布了。执行
flutter packages pub publish
他会检查你的文件结构,终端会提示:
Looks great! Are you ready to upload your package (y/n)?
当你输入y的时候会让你进行google账号的授权认证
Pub needs your authorization to upload packages on your behalf.
In a web browser, go to https://accounts.google.com/o/oauth2/auth?access_type=offline&approval_prompt=force&response_type=code&client_id=818368855108-8grd2eg9tj9f38os6f1urbcvsq399u8n.apps.googleusercontent.com&redirect_uri=http%3A%2F%2Flocalhost%3A55274&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email
Then click "Allow access".
带上梯子,按照提示完成认证后既可以等着终端上传即可。
Waiting for your authorization...
Authorization received, processing...
Successfully authorized.
Uploading...
Successfully uploaded package.
到此全部过程已经完成,就阔以去官网去搜索你刚刚的插件啦。Pub
最后的最后提示leleping插件的地址,需要的小伙伴自行引用。