Flutter 3.47 鸿蒙三方库适配实战:从 0 到 1 处理 sound_effect

预加载并低延迟播放短音效。

本文以 sound_effect 0.2.0 为例,记录我如何保留原有 Dart API、补齐 Flutter OH 插件入口、在鸿蒙端接入真实系统能力,并在 HarmonyOS API 26 真机上完成构建、安装、启动与调用验证。

适配仓库: sound_effect

适配分支: feat/ohos_sound_effect_0.2.0

适配 TAG: 0.2.0-ohos.1

一、先看最终效果

在这里插入图片描述

图 1:HarmonyOS API 26 真机启动示例页

验证点实测结果
Flutter OH 3.47 工程构建通过,产出 entry-default-signed.hap
安装、启动(真机)通过
插件注册通道 org.lichess/sound_effect 的 4 个方法就绪

二、这个库原来是怎么工作的

上游 sound_effect 通过平台通道与原生侧通信,通道定义在 Dart 源码里,原生侧只需要注册同名通道并实现方法分发,Dart 代码一行都不用改。

MethodChannel('org.lichess/sound_effect')
  -> init / load / play / release

三、实际环境

Flutter 鸿蒙环境搭建不在本文重复展开,直接参考 Flutter OH 环境搭建指南。

组件版本
Flutter OH3.47.4-ohos-1.0.4
Dart3.13.3
DevEco Studio26.0.0 Release
HarmonyOS SDKAPI 26
测试设备华为畅享 90 Pro Max(CHZ-AL00),HarmonyOS 7.0.0.109(API 26)
目标库sound_effect 0.2.0
flutter --version
hdc list targets

这里要特别注意 Flutter 版本:本机同时装了 3.41 和 3.47.4-ohos,3.41 会因为 SDK 约束解析失败,构建时必须显式把 3.47.4-ohos 放到 PATH 前面。

四、确认上游版本并同步到 AtomGit

上游包地址是 https://github.com/lichess-org/flutter-sound-effect,版本 0.2.0 使用 MIT License。适配前我用 AtomGit API(GET /api/v5/repos/<org>/<lib>)在 oh-flutter、hxa-flutter、CPF-Flutter 三个组织做了排重,未发现同名 OHOS 实现。

git clone https://atomgit.com/oh-flutter/sound_effect.git
cd sound_effect
git switch feat/ohos_sound_effect_0.2.0
git log --oneline -5

五、创建适配分支并检查工程结构

git switch -c feat/ohos_sound_effect_0.2.0

关键目录如下:

sound_effect/
├── lib/                                         # 原有 Dart API 和通道
├── ohos/
│   ├── index.ets                                # OHOS 插件导出入口
│   └── src/main/ets/components/plugin/
│       └── SoundEffectPlugin.ets
├── example/lib/main.dart                        # 真机验证 Demo
├── example/ohos/                                # Flutter OH 宿主工程
├── pubspec.yaml                                 # 声明 ohos 平台
└── README.OpenHarmony_CN.md                     # 鸿蒙适配说明
flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: SoundEffectPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致。这一步是本批次最容易踩的坑:pubspec.yaml 里漏掉 ohos 声明时,Flutter 生成的 GeneratedPluginRegistrant.ets 是个空 try 块,Dart 侧调用直接返回 null,构建期没有任何报错,运行时也不抛 MissingPluginException,只是所有返回值都是空的。我第一次跑 is_lock_screen2 就卡在这里,查了半天日志才发现注册表是空的。

六、适配过程:注册通道并对齐语义

通道名必须与上游 Dart 源码逐字一致。本库的映射如下:

方法OpenHarmony 实现说明
init记录 maxStreamsyes
loadmedia.createAVPlayer() + fdSrc + prepareyes
playsetVolume + play,播放中重复调用先 seek(0)yes
releaseAVPlayer.release()yes

核心代码:

    switch (call.method) {
      case 'init': {
        const n: number | undefined = call.argument('maxStreams') as number | undefined;
        if (typeof n === 'number' && n > 0) {
          this.maxStreams = n;
        }
        result.success('ok');
        break;
      }
      case 'load': {
        const id: string = call.argument('soundId') ?? '';
        const path: string = call.argument('path') ?? '';
        this.load(id, path, result);
        break;
      }
      case 'play': {
        const id: string = call.argument('soundId') ?? '';
        const vol: number = call.argument('volume') ?? 1.0;
        this.play(id, vol, result);
        break;
      }
      case 'release': {

七、构建配置与签名

示例工程的目标 SDK 对齐到 26,与 @ohos/flutter_ohos 的要求一致:

{
  "name": "default",
  "compatibleSdkVersion": "26.0.0",
  "targetSdkVersion": "26.0.0",
  "runtimeOS": "HarmonyOS"
}

Demo 的 AppScope/app.json5 统一成 com.example.flutter_oh_demo。签名 profile 里绑定的 bundleName 必须与它一致,否则 SignHap 直接报 00303074 Configuration Error。证书、p12、p7b 和密码不提交到仓库。

另外两个和签名、SDK 相关的坑:

  • build-profile.json5 里签名材料写 ${HOME} 不会展开,必须是绝对路径,否则报 00303107 Invalid storeFile value。
  • DEVECO_SDK_HOME 要指向 Contents/sdk(含版本目录的上一级)。指到 sdk/default 报 00303312 Cannot find the corresponding SDK version,完全不设则报 00303217。

八、通过 AtomGit 引入适配版

在业务工程中使用时锁定 TAG:

dependencies:
  sound_effect:
    git:
      url: https://atomgit.com/oh-flutter/sound_effect.git
      ref: 0.2.0-ohos.1
flutter pub get

然后在 pubspec.lock 里确认 source: git、AtomGit 地址和 resolved-ref,避免解析到 pub.dev 的同名版本。

九、构建、安装和真机验证

cd example
flutter pub get
flutter build hap --debug
hdc install -r build/ohos/hap/entry-default-signed.hap
hdc shell aa start -a EntryAbility -b com.example.flutter_oh_demo

构建输出为 ✓ Built build/ohos/hap/entry-default-signed.hap.,随后 hdc 报告安装成功。所有示例共用同一个 bundleName,重装后要先 aa force-stop 再 aa start,否则系统只是把旧任务拉到前台,看到的是上一次安装的界面——这个现象在批量验证时骗过我一次。

取实测值时用 uitest 定位控件并点击,而不是靠肉眼判断:

hdc shell "uitest dumpLayout -p /data/local/tmp/l.json"
hdc file recv /data/local/tmp/l.json /tmp/l.json
hdc shell "uitest uiInput click <x> <y>"
hdc shell "uitest screenCap -p /data/local/tmp/s.png"

十、适配结果和当前边界

  • 鸿蒙 AVPlayer 的启动延迟高于 Android 的 SoundPool,适用于音效但不保证硬实时;连续高频触发同一音效时可能出现轻微延迟。
  • 上游 SoundPool 支持同一音效多实例混播,本实现每个 soundId 只持有一个 AVPlayer,重复触发是重播而非叠加。

十一、FAQ

Q1:为什么 AVPlayer 比 SoundPool 慢?

  • 原因: 鸿蒙 AVPlayer 是通用媒体播放器,启动链路比 Android 的轻量 SoundPool 长。用于音效没问题,但不保证硬实时,连续高频触发可能有轻微延迟。

Q2:同一音效为什么不能叠加播放?

  • 原因: 实现里每个 soundId 只持有一个 AVPlayer,重复触发是 seek(0) 重播,不是叠加新实例。Android 的 SoundPool 支持多实例混播,这点在 README 的遗留问题里标注了。

Q3:load 为什么要用 fdSrc 而不是路径?

  • 原因: AVPlayer 的文件源用文件描述符,先 fileIo.openSync(path, READ_ONLY) 拿 fd,长度取 fileIo.statSync(fd).size。直接传路径字符串不行。

十二、总结

sound_effect 0.2.0 在鸿蒙上已经接入真实系统能力,Dart 侧 API 与上游保持一致。本文的验证结果全部来自 HarmonyOS API 26 真机,没有占位返回值;平台本身不具备的能力在正文和 README 中都标注为边界。

十三、参考资料和仓库地址

欢迎加入CPF-Flutter 鸿蒙社区:https://atomgit.com/CPF-Flutter

Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐