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

依据陀螺仪或指针位置为子组件施加视差倾斜效果。

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

适配仓库: motion

适配分支: feat/ohos_motion_2.0.2

适配 TAG: 2.0.2-ohos.1

一、先看最终效果

在这里插入图片描述

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

在这里插入图片描述
图 2:点击 with Motion 后的倾斜效果

验证点实测结果
Flutter OH 3.47 工程构建通过,产出 entry-default-signed.hap
安装、启动(真机)通过
陀螺仪可用isGyroscopeAvailable = true
点击 with Motion卡片产生透视倾斜,陀螺仪数据驱动渲染

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

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

MethodChannel('me.cendre.motion')
EventChannel('me.cendre.motion/gyroscope')

上游是 federated 插件:motion 主包负责组件层,原生实现包提供下面两条通道。鸿蒙侧在 motion 主包的 pubspec.yaml 里声明 ohos 后,这两条通道由我们的实现接管。

三、实际环境

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)
目标库motion 2.0.2
flutter --version
hdc list targets

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

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

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

git clone https://atomgit.com/oh-flutter/motion.git
cd motion
git switch feat/ohos_motion_2.0.2
git log --oneline -5

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

git switch -c feat/ohos_motion_2.0.2

关键目录如下:

motion/
├── motion/                                      # 实际的 Flutter 包
│   ├── lib/                                     # 组件层与通道调用
│   ├── ohos/                                    # 本适配新增
│   │   ├── index.ets
│   │   └── src/main/ets/components/plugin/
│   │       └── MotionPlugin.ets
│   └── example/                                 # 真机验证 Demo
├── motion_platform_interface/                   # 上游接口包
├── motion_web/                                  # 上游 web 实现
flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: MotionPlugin

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

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

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

方法OpenHarmony 实现说明
isGyroscopeAvailablesensor.getSensorListSync() 中查找 SensorId.GYROSCOPEyes
setUpdateIntervalsensor.on 的 Options.interval(纳秒)yes
gyroscopeEventssensor.on(SensorId.GYROSCOPE),负载 {x,y,z,timestamp}yes

核心代码:

    switch (call.method) {
      case 'isGyroscopeAvailable':
        try {
          result.success(sensor.getSensorListSync()
            .some((s: sensor.Sensor): boolean => s.sensorId === sensor.SensorId.GYROSCOPE));
        } catch (e) {
          result.success(false);
        }
        break;
      case 'setUpdateInterval': {
        const micros: number = call.argument('interval') ?? 20000;
        this.handler?.setInterval(micros * 1000);
        result.success(null);
        break;
      }
      default:
        result.notImplemented();
    }

七、构建配置与签名

示例工程的目标 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:
  motion:
    git:
      url: https://atomgit.com/oh-flutter/motion.git
      ref: 2.0.2-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"

十、适配结果和当前边界

  • 鸿蒙没有「指针悬停」输入源,Motion.hover 在桌面平台依赖的鼠标位置在手机/平板上不可用,实际只会使用陀螺仪数据源。

十一、FAQ

Q1:陀螺仪数据是怎么驱动卡片倾斜的?

  • 原因: sensor.on(SensorId.GYROSCOPE) 回调给出 x/y/z 角速度,经 EventChannel 推给 Dart 侧,motion 包把它换算成透视变换。
  • 验证结果: 点击「with Motion」后卡片产生可见的透视倾斜,对照组「without Motion」保持平面,说明数据确实送达并参与了渲染。

Q2:为什么采样间隔要乘 1000?

  • 原因: Dart 侧 setUpdateInterval 传的是微秒,sensor.on 的 Options.interval 单位是纳秒,所以要 × 1000。

Q3:没有陀螺仪的设备会怎样?

  • 原因: isGyroscopeAvailable 返回 false,事件流调用 endOfStream() 立即结束,不推送伪造的零值。

十二、总结

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

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

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

Logo

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

更多推荐