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

ujainu

59人浏览 · 2026-10-17 17:42:29

ujainu · 2026-10-17 17:42:29 发布

罗盘方位是地图、AR、户外类应用的基础输入。compassx 把 Android 的 SensorManager.getOrientation() 与 iOS 的 CLLocationManager.heading 收敛成一条事件流，事件里带方位角、精度和"是否需要校准"三个字段。

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

适配仓库： compassx

适配分支： feat/ohos_compassx_1.0.1

适配 TAG： 1.0.1-ohos.1

一、先看最终效果

请添加图片描述 {width=50%}

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

请添加图片描述 {width=50%}

图 2：点击“订阅方向事件”后的真实返回：heading=89.9° accuracy=15°。

请添加图片描述 {width=50%}

图 3：点击“取消订阅”后的真实返回：已取消订阅。

验证点	实测结果
Flutter OH 3.47 工程构建	通过，产出 `entry-default-signed.hap`
安装、启动（真机）	通过
订阅方向事件	`heading=89.9° accuracy=15°`
取消订阅	`已取消订阅`

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

只有一条 EventChannel：

Dart CompassX.events
  -> EventChannel('studio.midoridesign/compassx')
  -> Android 方位传感器 / iOS CLHeading

事件值是 {heading: double, accuracy: double, shouldCalibrate: bool}，CompassXEvent.fromMap 直接按 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）
目标库	`compassx 1.0.1`

flutter --version
hdc list targets

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

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

仓库适配提交为 4b23c85，分支与 TAG 1.0.1-ohos.1 均指向该提交。

git clone https://atomgit.com/oh-flutter/compassx.git
cd compassx
git switch feat/ohos_compassx_1.0.1
git log --oneline -5

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

git switch -c feat/ohos_compassx_1.0.1

关键目录如下：

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

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: CompassXPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致。这一步在所有库里都踩过：名字对不上时 Dart 能编译，运行时却抛 MissingPluginException，没有任何构建期提示。

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

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

方法	OpenHarmony 实现	说明
`CompassX.events`	`sensor.on(SensorId.ORIENTATION)` + EventChannel	`alpha` 即绕 Z 轴方位角（0~360°，0 为正北）
`accuracy`	按 `SensorAccuracy` 映射为 15/30/45°	不可靠时 -1
`shouldCalibrate`	`ACCURACY_UNRELIABLE` 时为 `true`	与上游 iOS 语义对齐

核心代码：

private readonly onOrientation = (data: sensor.OrientationResponse): void => {
  const heading = data.alpha >= 0 ? data.alpha : data.alpha + 360;
  this.sink.success({
    'heading': this.asDouble(heading),
    'accuracy': this.asDouble(this.mapAccuracy(data.accuracy)),
    'shouldCalibrate': data.accuracy === sensor.SensorAccuracy.ACCURACY_UNRELIABLE,
  });
};

/** 标准编解码器会把整数打成 int32，Dart 的 `as double` 会崩 */
private asDouble(value: number): number {
  return Number.isInteger(value) ? value + 1e-9 : value;
}

七、构建配置与签名

示例工程的目标 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:
  compassx:
    git:
      url: https://atomgit.com/oh-flutter/compassx.git
      ref: 1.0.1-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，否则系统只是把旧任务拉到前台，看到的是上一次安装的界面。

十、适配结果和当前边界

方位角来自系统融合的 ORIENTATION 传感器，精度受磁场环境影响；真机在室内靠近金属时 shouldCalibrate 会变为 true，这是真实传感器状态而不是实现缺陷。

十一、FAQ

Q1：为什么 heading 要补 1e-9？

原因： flutter_ohos 的 StandardMessageCodec 对整数值编码为 INT32，Dart 侧 map['heading'] as double 会抛 type 'int' is not a subtype of type 'double'。补一个极小尾差强制走 FLOAT64。
验证结果： 修复后真机返回 heading=89.9° accuracy=15°。