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

NFC 门禁、标签读取是物联网与出行类应用的常见需求。nfc_manager 的 Pigeon 接口面在本批里最宽——宿主 API 有 40 多个方法,覆盖 ISO-DEP、MIFARE Classic/Ultralight、NFC-A/B/F/V 等协议族。把它带到鸿蒙时,第一层要处理的是库自身的平台判断。

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

适配仓库: oh-flutter/nfc_manager

适配分支: feat/ohos_nfc_manager_4.2.1

适配 TAG: 4.2.1-ohos.2

一、先看最终效果

图 1:HarmonyOS API 26 真机启动 Demo。页面显示 nfc_manager 4.2.1。

图 2:点击“查询 NFC 适配器”后返回 isAvailable = true——NFC 开关状态来自 @ohos.nfc.controller。

验证点实测结果证据
Flutter OH 3.47 工程构建通过entry-default-signed.hap
安装、启动(真机)通过图 1
isAvailable返回 true图 2
startSession读卡会话注册成功图 3
标签事件经 FlutterApiPigeon 回传 Dart日志

图 3:点击“启动 NFC 会话”后会话注册成功,标签事件经 nfcTag.on(readerMode) 回传 Dart。

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

nfc_manager 4.2.x 的接口同样走 Pigeon:

Dart NfcManager
  -> BasicMessageChannel('dev.flutter.pigeon.nfc_manager.HostApiPigeon.<方法名>')
  -> Android NFC / iOS CoreNFC

方法按协议族分组:nfcAdapterIsEnabled、nfcAdapterEnableReaderMode 等是入口,其余是各协议族的收发细节。回复协议是 Pigeon 列表格式。

三、实际环境

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,HarmonyOS 7.0.0.105(API 26)
目标库nfc_manager 4.2.1
flutter --version
hdc list targets

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

上游包地址是 https://github.com/okadan/flutter-nfc-manager,版本 4.2.1 使用 MIT(Copyright © 2019 okadan) License。适配前我在 AtomGit 目标组织中搜索了同名库,没有找到可以直接使用的 OHOS 实现。

仓库适配提交为 042e4c4,分支与 TAG 4.2.1-ohos.2 均指向该提交。

git clone https://atomgit.com/oh-flutter/nfc_manager.git
cd nfc_manager
git switch feat/ohos_nfc_manager_4.2.1
git log --oneline -5

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

git switch -c feat/ohos_nfc_manager_4.2.1

关键目录如下:

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

pubspec.yaml 中的关键声明是:

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: NfcManagerPlugin

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

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

// 读卡会话:nfcTag.on('readerMode', elementName, discTech, callback)
const elementName: bundleManager.ElementName = {
  bundleName: this.ability.context.applicationInfo.name,
  abilityName: 'EntryAbility',
};
nfcTag.on('readerMode', elementName,
  [nfcTag.NFC_A, nfcTag.NFC_B, nfcTag.NFC_F, nfcTag.NFC_V, nfcTag.NDEF],
  this.onTagDiscovered);
方法OpenHarmony 实现
isAvailableisNfcAvailable() + getNfcState() === STATE_ON
startSession / stopSessionnfcTag.on/off('readerMode', ...)
标签发现经 FlutterApiPigeon.onTagDiscovered 回传 uid 与技术列表
适配器状态nfcController.on('nfcStateChange') → onAdapterStateChanged

七、构建配置与签名

示例工程的目标 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:
  nfc_manager:
    git:
      url: https://atomgit.com/oh-flutter/nfc_manager.git
      ref: 4.2.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。真机上按本文的截图顺序逐一点击按钮完成验证。

十、适配结果和当前边界

NFC 读卡已接入,能力边界是 NDEF 读写:完整 tag dispatch 在鸿蒙公开 SDK 里没有对普通应用开放,因此 ndefGetNdefMessage 等方法返回明确错误而不是伪造数据。读卡会话本身(发现标签、拿到 uid 和技术列表)是真实可用的,已在真机上确认。

十一、FAQ

Q1:Dart 侧需要改什么?

  • 现象: nfc_manager 的 Dart 层用 defaultTargetPlatform 分平台,缺少 TargetPlatform.ohos 分支时不会走到原生实现。
  • 解决方法: 在 Dart 侧补上 ohos 分支,复用 Android 的 Pigeon 封装。
  • 验证结果: isAvailable 返回 true。

Q2:Pigeon 通道注册有意义吗?

  • 现象: 有。鸿蒙的 Pigeon 通道名与 Android 完全一致,复用同一套通道封装即可。
  • 解决方法: 无需改 Dart 逻辑,只补平台判断。
  • 验证结果: 调用正常。

Q3:鸿蒙有自己的 NFC 能力吗?

  • 现象: 有:@ohos.nfc.controller(开关/状态)与 @ohos.nfc.tag(读卡)。
  • 解决方法: 按上面代码接入,需声明 ohos.permission.NFC_TAG(normal 级)。
  • 验证结果: 真机读卡会话注册成功。

十二、总结

nfc_manager 4.2.1 已接入鸿蒙的 NFC:用 nfc.controller 读适配器状态、用 nfcTag.on(readerMode) 注册读卡,标签事件经 FlutterApiPigeon 回传 Dart。NDEF 读写因平台限制保留明确错误语义。

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

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

Logo

作为“人工智能6S店”的官方数字引擎,为AI开发者与企业提供一个覆盖软硬件全栈、一站式门户。

更多推荐