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

晚霞的不甘

46人浏览 · 2026-10-17 19:53:11

晚霞的不甘 · 2026-10-17 19:53:11 发布

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

罗盘方向是导航、地图、AR 类应用的基础能力。flutter_compass 的实现非常轻：它在原生端注册一个事件流通道，把设备的磁力计朝向持续推给 Dart。把它带到鸿蒙时，关键问题是鸿蒙的传感器数据如何接到这条事件流上。

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

适配仓库： oh-flutter/flutter_compass

适配分支： feat/ohos_flutter_compass_0.8.1

适配 TAG： 0.8.1-ohos.2

一、先看最终效果

图 1：HarmonyOS API 26 真机启动 Demo。页面显示 flutter_compass 0.8.1。

图 2：点击“读取罗盘朝向”后显示真实方位角 91.29°，数据来自 @ohos.sensor 的 ORIENTATION 事件流。

验证点	实测结果	证据
Flutter OH 3.47 工程构建	通过	`entry-default-signed.hap`
安装、启动（真机）	通过	图 1
`FlutterCompass.events`	EventChannel 收到真实朝向	图 2
heading 值	真实方位角（如 91.29 度）	图 2
传感器	已接入 `@ohos.sensor` ORIENTATION	图 2

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

flutter_compass 的 Dart 层结构简洁：

Dart FlutterCompass
  -> EventChannel('hemanthraj/flutter_compass')
  -> 原生传感器事件流
  -> heading（0-360 度）

事件流模式下，插件的“能力”取决于原生端能否持续产生事件。鸿蒙端用 @ohos.sensor 的 ORIENTATION 类型实现了 EventChannel，事件流已真实推送方位角。这里还有个容易忽略的细节：如果采集方直接 await 一个永远不会产出的流，界面会停在加载态——所以验证 Demo 里加了 5 秒超时，让“没有事件”这个事实可见。

三、实际环境

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）
目标库	`flutter_compass 0.8.1`

flutter --version
hdc list targets

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

仓库适配提交为 e3324ba，分支与 TAG 0.8.1-ohos.2 均指向该提交。

git clone https://atomgit.com/oh-flutter/flutter_compass.git
cd flutter_compass
git switch feat/ohos_flutter_compass_0.8.1
git log --oneline -5

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

git switch -c feat/ohos_flutter_compass_0.8.1

关键目录如下：

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

pubspec.yaml 中的关键声明是：

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: FlutterCompassPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致，否则 Dart 端能编译，运行时却不会注册插件。

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

private readonly onOrientation = (data: sensor.OrientationResponse): void => {
  if (this.sink == null) return;
  const heading = data.alpha >= 0 ? data.alpha : data.alpha + 360;
  // 必须用 Float64Array：普通数组会被编成 INT32，Dart 侧 cast<double> 会崩
  this.sink.success(new Float64Array([heading, 0, this.mapAccuracy(data.accuracy)]));
};

private startListening(): void {
  sensor.on(sensor.SensorId.ORIENTATION, this.onOrientation, { interval: 200000000 });
}

事件载荷	映射
`[0] heading`	传感器 `alpha`（绕 Z 轴方位角，0~360，负数补 360）
`[1] headingForCameraMode`	上游 Android 端未填充，保持 0
`[2] accuracy`	鸿蒙 `SensorAccuracy` → 上游约定 15/30/45，不可靠时 -1（Dart 转 null）

七、构建配置与签名

示例工程的目标 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，与 DevEco 调试签名对应。证书、p12、p7b 和密码没有提交到仓库，读者应在自己的 DevEco Studio 中生成调试签名。

八、通过 AtomGit 引入适配版

在另一个 Flutter OH 应用中使用时，建议锁定 TAG：

dependencies:
  flutter_compass:
    git:
      url: https://atomgit.com/oh-flutter/flutter_compass.git
      ref: 0.8.1-ohos.2

flutter pub get

然后在 pubspec.lock 检查 source: git、AtomGit 地址和 resolved-ref，确认没有解析到 pub.dev 的同名版本。

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

cd example
flutter pub get
flutter analyze
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 报告安装成功并启动 Ability。真机上按本文的截图顺序逐一点击按钮完成验证。

十、适配结果和当前边界

方向传感器已完整接入。唯一需要注意的是编码类型：数字数组必须用 Float64Array——

flutter_ohos 的 StandardMessageCodec 会把普通数组里的整数值打成 INT32，而 Dart 侧 CompassEvent.fromList 要求 List<double>，cast<double>() 会抛 “type ‘int’ is not a subtype of type ‘double’”。用 Float64Array 编码为 FLOAT64_ARRAY，解码后正好是 Float64List，类型匹配。

十一、FAQ

Q1：为什么读数会超时？

现象： 如果只注册了 MethodChannel 而没有 EventChannel 的 onListen 回调，events.first 永远收不到数据。
解决方法： 实现 StreamHandler，在 onListen 里调用 sensor.on() 并先推送一次当前值。
验证结果： 真机读取到 91.29 度。

Q2：报 type int is not a subtype of double？

现象： 事件数组用普通 number[] 编码成了 INT32 数组。
解决方法： 改用 new Float64Array([...])。
验证结果： 修正后 Dart 侧正常收到 List<double>。

Q3：精度值怎么来的？

现象： 鸿蒙 SensorAccuracy 有 4 档（UNRELIABLE/LOW/MEDIUM/HIGH），上游用 15/30/45/-1 表示。
解决方法： 按档位映射。
验证结果： 与 Android 端数值约定一致。

十二、总结

flutter_compass 0.8.1 已接入鸿蒙的方向传感器：用 @ohos.sensor 的 ORIENTATION 类型经 EventChannel 推送方位角，真机读到真实读数。实现过程中最关键的坑是数字数组的编码类型，Float64Array 是唯一能通过 Dart 类型检查的写法。