Flutter 3.47 鸿蒙三方库适配实战:从 0 到 1 处理 all_sensors
all_sensors 一口气暴露加速度、线性加速度、陀螺仪、接近传感器四条事件流,适合做姿态检测、摇一摇、贴脸熄屏这类功能。
本文以 all_sensors 0.5.0 为例,记录我如何保留原有 Dart API、补齐 Flutter OH 插件入口、在鸿蒙端接入真实系统能力,并在 HarmonyOS API 26 真机上完成构建、安装、启动和按钮调用验证。
适配仓库: all_sensors
适配分支: feat/ohos_all_sensors_0.5.0
适配 TAG: 0.5.0-ohos.1
一、先看最终效果
图 1:HarmonyOS API 26 真机启动 Demo。页面显示 all_sensors 0.5.0。
图 2:点击“订阅加速度”后的真实返回:正在监听加速度。
图 3:点击“订阅陀螺仪”后的真实返回:正在监听陀螺仪。
图 4:点击“订阅接近传感器”后的真实返回:value=false。
| 验证点 | 实测结果 |
|---|---|
| Flutter OH 3.47 工程构建 | 通过,产出 entry-default-signed.hap |
| 安装、启动(真机) | 通过 |
| 订阅加速度 | 正在监听加速度 |
| 订阅陀螺仪 | 正在监听陀螺仪 |
| 订阅接近传感器 | value=false |
二、这个库原来是怎么工作的
四条独立 EventChannel:
cindyu.com/all_sensors/accelerometer
cindyu.com/all_sensors/user_accel
cindyu.com/all_sensors/gyroscope
cindyu.com/all_sensors/proximity
AccelerometerEvent / GyroscopeEvent 的 Dart 解析都是 event.cast<double>(),也就是事件必须是 double 列表。
三、实际环境
Flutter 鸿蒙环境搭建不在本文重复展开,直接参考 Flutter OH 环境搭建指南。
| 组件 | 版本 |
|---|---|
| Flutter OH | 3.47.4-ohos-1.0.4 |
| Dart | 3.13.3 |
| DevEco Studio | 26.0.0 Release |
| HarmonyOS SDK | API 26 |
| 测试设备 | 华为畅享 90 Pro Max,HarmonyOS 7.0.0.105(API 26) |
| 目标库 | all_sensors 0.5.0 |
flutter --version
hdc list targets
四、确认上游版本并同步到 AtomGit
上游包地址是 https://github.com/cindyu/all_sensors,版本 0.5.0 使用 MIT License。适配前我用 AtomGit API(GET /api/v5/repos/<org>/<lib>)在 oh-flutter、hxa-flutter、CPF-Flutter 三个组织做了排重,未发现同名 OHOS 实现。
仓库适配提交为 1f79cc7,分支与 TAG 0.5.0-ohos.1 均指向该提交。
git clone https://atomgit.com/oh-flutter/all_sensors.git
cd all_sensors
git switch feat/ohos_all_sensors_0.5.0
git log --oneline -5
五、创建适配分支并检查工程结构
git switch -c feat/ohos_all_sensors_0.5.0
关键目录如下:
all_sensors/
├── lib/ # 原有 Dart API 和通道
├── ohos/
│ ├── index.ets # OHOS 插件导出入口
│ └── src/main/ets/components/plugin/
│ └── AllSensorsPlugin.ets # 通道实现
├── example/lib/main.dart # 真机验证 Demo
├── example/ohos/ # Flutter OH 宿主工程
├── pubspec.yaml # 声明 ohos 平台
└── README.OpenHarmony_CN.md # 鸿蒙适配说明
flutter:
plugin:
platforms:
ohos:
pluginClass: AllSensorsPlugin
pluginClass 必须和 ohos/index.ets 导出的类名一致。这一步在所有库里都踩过:名字对不上时 Dart 能编译,运行时却抛 MissingPluginException,没有任何构建期提示。
六、适配过程:注册通道并对齐语义
通道名必须与上游 Dart 源码逐字一致。本库的映射如下:
| 方法 | OpenHarmony 实现 | 说明 |
|---|---|---|
accelerometerEvents | SensorId.ACCELEROMETER | 含重力的 x/y/z |
userAccelerometerEvents | SensorId.LINEAR_ACCELEROMETER | 已去重力 |
gyroscopeEvents | SensorId.GYROSCOPE | rad/s |
proximityEvents | SensorId.PROXIMITY | 距离 < 5cm 归零,对齐上游"贴近=true" |
核心代码:
private readonly onData = (data: sensor.AccelerometerResponse): void => {
// 必须用 Float64Array:普通数组里的整数值会被编码成 int32,
// Dart 侧 `event.cast<double>()` 直接失败
this.sink?.success(new Float64Array([data.x, data.y, data.z]));
};
七、构建配置与签名
示例工程的目标 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 和密码不提交到仓库。
八、通过 AtomGit 引入适配版
在业务工程中使用时锁定 TAG:
dependencies:
all_sensors:
git:
url: https://atomgit.com/oh-flutter/all_sensors.git
ref: 0.5.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,否则系统只是把旧任务拉到前台,看到的是上一次安装的界面。
十、适配结果和当前边界
sensor.on 的类型参数是按 SensorId 字面量重载的,ArkTS 不接受用变量透传类型(会报 Argument of type 'SensorId' is not assignable to parameter of type 'SensorType.SENSOR_TYPE_ID_WEAR_DETECTION'),所以四个传感器各写一个 handler 类。
十一、FAQ
Q1:为什么不能写成一个通用 handler?
- 原因:
sensor.on的重载签名按具体枚举成员区分回调类型,传入SensorId变量时无法匹配任何重载。 - 验证结果: 改成四个具名 handler 后构建通过,四个通道都能独立订阅。
Q2:接近传感器为什么返回 0/1?
- 原因: 鸿蒙返回距离(cm),上游约定
proximity == 0表示贴近。本实现把 <5cm 归零、其余为 1。 - 验证结果: 真机未遮挡时返回
value=false(即 1)。
十二、总结
all_sensors 0.5.0 在鸿蒙上已经接入真实系统能力,Dart 侧 API 与上游保持一致。本文的验证结果全部来自 HarmonyOS API 26 真机按钮点击,没有占位返回值;平台本身不具备的能力在正文和 README 中都已明确标注为边界。
十三、参考资料和仓库地址
- 适配仓库主页
- 适配分支
- 适配 TAG
- 最终提交 1f79cc7
- ArkTS 通道实现
- 鸿蒙适配说明
- pub.dev 包页面
- pub.dev 0.5.0 版本页
- 上游仓库
- Flutter 官方平台通道文档
- Flutter OH 鸿蒙 SDK 仓库
- HarmonyOS 开发者官方文档
欢迎加入CPF-Flutter 鸿蒙社区:https://atomgit.com/CPF-Flutter
更多推荐



所有评论(0)