Flutter _ 如何优雅的开发一个插件并发布到Dart仓库？，字节跳动今日学习内容

最新推荐文章于 2024-06-14 04:21:52 发布

2401_84149814

最新推荐文章于 2024-06-14 04:21:52 发布

阅读量775

点赞数 10

分类专栏：程序员文章标签： flutter 学习

本文链接：https://blog.csdn.net/2401_84149814/article/details/137483849

版权

程序员专栏收录该内容

265 篇文章 1 订阅

订阅专栏

以上就是创建 Flutter 插件项目的整个过程，向读者介绍了系统为我们自动生成的两个重要类。之后我们的开发重心围绕这两个类来开展。

编写调节音量代码并测试

Android 端代码

首先在 VolumeControlPlugin.kt 编写需要实现的方法。如下，我写了四个对应的方法名供 Flutter 端来调用。分别是设置音量最大范围、获取当前电量、改变媒体音量、改变系统音量。VolumeManager内部实现了这四个方法的具体逻辑，由于篇幅关系，且本文的目的是带读者熟悉整个 Flutter 插件开发流程，这里不贴出 VolumeManager 类的源代码，也不讲解其实现细节。代码放在 volume_flutter，感兴趣的读者可以去看看。

/** VolumeControlPlugin */
class VolumeControlPlugin: FlutterPlugin, MethodCallHandler {
private lateinit var channel : MethodChannel
private lateinit var volumeManager: VolumeManager

override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
channel = MethodChannel(flutterPluginBinding.binaryMessenger, “volume_control”)
channel.setMethodCallHandler(this)

volumeManager = VolumeManager(flutterPluginBinding.applicationContext)
}

override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) {
channel.setMethodCallHandler(null)
}

override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
when(call.method){
“setMaxVol” -> { // 设置最大音量范围
volumeManager.setMaxVol(call.arguments as Double);
}
“getCurrentVol” -> { // 获取当前音量
volumeManager.setAudioType(call.arguments as Int)
result.success(volumeManager.currentVolume);
}
“changeMediaVoice” -> { // 改变媒体音量
volumeManager.setAudioType(VolumeManager.TYPE_MUSIC)
val curVoice = volumeManager.setVoice(call.arguments as Double);
result.success(curVoice)
}
“changeSysVoice” -> { //改变系统音量
volumeManager.setAudioType(VolumeManager.TYPE_SYSTEM)
val curVoice = volumeManager.setVoice(call.arguments as Double);
result.success(curVoice)
}
else -> {
result.notImplemented()
}
}
}
}

Flutter 端代码

在 volume_control.dart 中编写 4 个异步方法，来调用上面 Android 端我们写好的处理方法，如下。

class VolumeControl {
static const MethodChannel _channel = const MethodChannel(‘volume_control’);

/// 设置音量最大范围
/// setMaxVol 方法考虑到了音量的最大值可以自由设置，如果不使用这个方法，默认音量最大值是 100
static Future setMaxVol(double num) async{
await _channel.invokeMethod(“setMaxVol”,num);
}

/// 获取当前音量
static Future getCurrentVol(AudioType audioType) async{
return await _channel.invokeMethod(“getCurrentVol”,_getStreamInt(audioType)) as double;
}

/// 改变媒体音量
static Future changeMediaVoice(double num) async{
return await _channel.invokeMethod(“changeMediaVoice”,num) as double;
}

/// 改变系统音量
static Future changeSysVoice(double num) async{
return await _channel.invokeMethod(“changeSysVoice”,num) as double;
}
}

enum AudioType {
/// Controls the Voice Call volume
STREAM_VOICE_CALL,
/// Controls the system volume
STREAM_SYSTEM,
/// Controls the ringer volume
STREAM_RING,
/// Controls the media volume
STREAM_MUSIC,
// Controls the alarm volume
STREAM_ALARM,
/// Controls the notification volume
STREAM_NOTIFICATION
}

int _getStreamInt(AudioType audioType) {
switch (audioType) {
case AudioType.STREAM_VOICE_CALL:
return 0;
case AudioType.STREAM_SYSTEM:
return 1;
case AudioType.STREAM_RING:
return 2;
case AudioType.STREAM_MUSIC:
return 3;
case AudioType.STREAM_ALARM:
return 4;
case AudioType.STREAM_NOTIFICATION:
return 5;
default:
return null;
}
}

在 Flutter 页面看看效果

Android 端和 Flutter 端的代码我们编写完毕，现在在项目生成的 example 目录下的 main.dart来编写页面示例代码，来展示插件的功能。注意 example 是开发者写给使用者看的，告诉他们这个插件如何使用的一个 Flutter 项目，相当于帮助文档，我觉得这点很好，极大了加快了我们的上手速度。

main.dart

在 main.dart 中用一个 Slider 滑块组件来展示下效果。按以下步骤编码。

进入页面的时候调用 getCurrentVol 方法来获取当前媒体音量，显示初始状态。
滑动滑块调用 changeMediaVoice 方法来改变媒体音量。

main.dart 页面代码如下，也很简单。

void main() {
runApp(MyApp());
}

class MyApp extends StatefulWidget {
@override
_MyAppState createState() => _MyAppState();
}

class _MyAppState extends State {
double _musicVoice;

@override
void initState() {
super.initState();
///1.获取当前媒体音量
initCurrentVol();
}

/// 获取当前媒体音量
Future initCurrentVol () async{
_musicVoice = await VolumeControl.getCurrentVol(AudioType.STREAM_MUSIC);
if(!mounted) return;
setState(() {});
}

/// 改变媒体音量
Future changeMediaVoice(double vol) async{
await VolumeControl.changeMediaVoice(vol);
_musicVoice = vol;
setState(() {});
}

@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text(‘Plugin example app’),
),
body: Center(
child: (_musicVoice != null) ? Slider(
value: _musicVoice,
min: 0,
max: 100,
inactiveColor: Colors.grey,
activeColor: Colors.blue,
onChanged: (vol){
/// 2. 滑动改变媒体音量
changeMediaVoice(vol);
},
): Container(),
),
),
);
}
}

实际效果如下，滑动滑块时，系统媒体音量也随之改变。我的测试机型是小米 MI 6X。其他机型可能会有差异，请读者注意。

音量调节.gif

将开发好的插件包上传到 Dart 仓库

我们的 Flutter 插件包整个开发流程就结束了。现在将它上传到 Dart 仓库，方便其他开发者可以使用这个插件包。在发布之前，检查 LICENSE、pubspec.yaml、README.md 以及 CHANGELOG.md 四个文件。

选择开源许可证（LICENSE）

软件开源许可证，大概有上百种。最流行的六种 — GPL、BSD、MIT、Mozilla、Apache 和 LGPL。读者可以从 Choose an open source license 选择适合自己的证书，我这里选择 MIT。

选择证书

MIT LICENSE

修改 pubspec.yaml

name: volume_control
description: A new Flutter plugin.
version: 0.0.1
author:
homepage:

这里按实际情况修改 description 插件的简要描述，version 插件的版本，homepage 项目主页，其中 author 已经不支持使用了，读者需要直接删除，不然后面检查会不通过，修改后如下。

name: volume_control
description: A Flutter plugin which can control android volume.
version: 0.0.1
homepage: https://github.com/liqvip/volume_control