扫码几乎是所有 App 的标配。simple_barcode_scanner 的设计是呼出平台扫码界面、拿回码值,所以鸿蒙上最合适的实现是 HMS Scan Kit 的系统扫码页。

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

适配仓库: simple_barcode_scanner

适配分支: feat/ohos_simple_barcode_scanner_0.6.1

适配 TAG: 0.6.1-ohos.1

一、先看最终效果

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

图 2:点击“调用系统扫码”后的真实返回:``。

验证点实测结果
Flutter OH 3.47 工程构建通过,产出 entry-default-signed.hap
安装、启动(真机)通过
调用系统扫码``

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

一条 MethodChannel 加一条 EventChannel:

MethodChannel('flutter_barcode_scanner')
EventChannel('flutter_barcode_scanner_receiver')

三、实际环境

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

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

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

仓库适配提交为 b81e724,分支与 TAG 0.6.1-ohos.1 均指向该提交。

git clone https://atomgit.com/oh-flutter/simple_barcode_scanner.git
cd simple_barcode_scanner
git switch feat/ohos_simple_barcode_scanner_0.6.1
git log --oneline -5

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

git switch -c feat/ohos_simple_barcode_scanner_0.6.1

关键目录如下:

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

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

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

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

方法OpenHarmony 实现说明
scanBarcodescanBarcode.startScanForResult(context, options)拉起系统扫码页
结果事件EventChannel(flutter_barcode_scanner_receiver)同时推给 Dart 事件流

核心代码:

const options: scanBarcode.ScanOptions = {
  scanTypes: [scanCore.ScanType.ALL],
  enableMultiMode: false,
  enableAlbum: true,
};
const result = await scanBarcode.startScanForResult(
  this.ability.context, options);
this.sink?.success(result?.originalValue ?? '');

七、构建配置与签名

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

十、适配结果和当前边界

扫码是系统 UI,应用会短暂切到后台,页面上的适配状态不会刷新——这是预期行为,截图里看到的是系统扫码页本身。

十一、FAQ

Q1:为什么需要 AbilityAware?

  • 原因: startScanForResult 需要一个 common.Context,必须从当前 UIAbility 取。
  • 验证结果: 不实现 AbilityAware 时拿不到 context,调用会失败。

Q2:ScanType 在哪?

  • 原因: 定义在 @hms.core.scan.scanCore,不在 detectBarcode 或 scanBarcode 下。
  • 验证结果: 用全量 ScanType.ALL 最稳妥。

十二、总结

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

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

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

Logo

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

更多推荐