和呼出扫码界面不同,flutter_barcode_sdk 走的是识别已有图片,适合从相册取图或截图中识码。

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

适配仓库: flutter_barcode_sdk

适配分支: feat/ohos_flutter_barcode_sdk_5.3.1

适配 TAG: 5.3.1-ohos.1

一、先看最终效果

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

图 2:点击“初始化 SDK”后的真实返回:init → 0。

图 3:点击“设置识别格式”后的真实返回:setBarcodeFormats → 0。

验证点实测结果
Flutter OH 3.47 工程构建通过,产出 entry-default-signed.hap
安装、启动(真机)通过
初始化 SDKinit → 0
设置识别格式setBarcodeFormats → 0

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

一条 MethodChannel(来自 platform_interface):

MethodChannel('flutter_barcode_sdk')
  -> setLicense / init / decodeFile / decodeImageBuffer
  -> setBarcodeFormats / getParameters / setParameters

三、实际环境

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

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

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

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

git clone https://atomgit.com/oh-flutter/flutter_barcode_sdk.git
cd flutter_barcode_sdk
git switch feat/ohos_flutter_barcode_sdk_5.3.1
git log --oneline -5

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

git switch -c feat/ohos_flutter_barcode_sdk_5.3.1

关键目录如下:

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

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

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

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

方法OpenHarmony 实现说明
init初始化(Scan Kit 无需 license)返回 0
decodeFiledetectBarcode.decode({uri})沙箱路径转 file URI
decodeImageBuffer先写缓存文件再解码

核心代码:

private toFileUri(path: string): string {
  if (path.startsWith('file://')) {
    return path;
  }
  const ctx = getContext(this) as common.UIAbilityContext;
  const marker = '/cache/';
  const relative = path.startsWith('/data/storage')
    ? path
    : `/data/storage/el2/base/haps/entry${path.substring(path.lastIndexOf(marker))}`;
  return `file://${ctx.applicationInfo.name}${relative}`;
}

七、构建配置与签名

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

十、适配结果和当前边界

Scan Kit 的图片识别以 URI 为输入,所以必须把沙箱绝对路径转成 file:///<sandbox 相对路径> 形式,直接传绝对路径会失败。

十一、FAQ

Q1:为什么不能直接传文件路径?

  • 原因: detectBarcode.decode 只接受 URI。
  • 验证结果: 转成 file:///… 后解码正常。

Q2:ScanType 为什么编译不过?

  • 原因: 枚举名是 EAN13_CODE/QR_CODE,不是 EAN_13。
  • 验证结果: 用 ScanType.ALL 最省事。

十二、总结

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

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

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

Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐