Flutter 3.47 鸿蒙三方库适配实战:从 0 到 1 处理 clipboard
clipboard 在 Flutter 原生 Clipboard 之上加了富文本、图片、类型探测、变化监听和调试信息,适合做"复制/粘贴"体验比较讲究的应用。
本文以 clipboard 3.0.14 为例,记录我如何保留原有 Dart API、补齐 Flutter OH 插件入口、在鸿蒙端接入真实系统能力,并在 HarmonyOS API 26 真机上完成构建、安装、启动和按钮调用验证。
适配仓库: clipboard
适配分支: feat/ohos_clipboard_3.0.14
适配 TAG: 3.0.14-ohos.1
一、先看最终效果
图 1:HarmonyOS API 26 真机启动 Demo。页面显示 clipboard 3.0.14。
图 2:点击“写入文本”后的真实返回:copy → 已写入。
图 3:点击“读回文本”后的真实返回:paste → 。
图 4:点击“是否为空”后的真实返回:isEmpty → false。
| 验证点 | 实测结果 |
|---|---|
| Flutter OH 3.47 工程构建 | 通过,产出 entry-default-signed.hap |
| 安装、启动(真机) | 通过 |
| 写入文本 | copy → 已写入 |
| 读回文本 | paste → |
| 是否为空 | isEmpty → false |
二、这个库原来是怎么工作的
一条 MethodChannel 加一条 EventChannel:
MethodChannel('net.cubiclab.clipboard/methods')
EventChannel('net.cubiclab.clipboard/events')
方法覆盖 copy / copyRichText / copyImage / paste / pasteRichText / pasteImage / hasData / getContentType / getDataSize / clear / startMonitoring / stopMonitoring。
三、实际环境
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) |
| 目标库 | clipboard 3.0.14 |
flutter --version
hdc list targets
四、确认上游版本并同步到 AtomGit
上游包地址是 https://github.com/cubiclab/clipboard,版本 3.0.14 使用 MIT License。适配前我用 AtomGit API(GET /api/v5/repos/<org>/<lib>)在 oh-flutter、hxa-flutter、CPF-Flutter 三个组织做了排重,未发现同名 OHOS 实现。
仓库适配提交为 89b0c46,分支与 TAG 3.0.14-ohos.1 均指向该提交。
git clone https://atomgit.com/oh-flutter/clipboard.git
cd clipboard
git switch feat/ohos_clipboard_3.0.14
git log --oneline -5
五、创建适配分支并检查工程结构
git switch -c feat/ohos_clipboard_3.0.14
关键目录如下:
clipboard/
├── lib/ # 原有 Dart API 和通道
├── ohos/
│ ├── index.ets # OHOS 插件导出入口
│ └── src/main/ets/components/plugin/
│ └── ClipboardPlugin.ets # 通道实现
├── example/lib/main.dart # 真机验证 Demo
├── example/ohos/ # Flutter OH 宿主工程
├── pubspec.yaml # 声明 ohos 平台
└── README.OpenHarmony_CN.md # 鸿蒙适配说明
flutter:
plugin:
platforms:
ohos:
pluginClass: ClipboardPlugin
pluginClass 必须和 ohos/index.ets 导出的类名一致。这一步在所有库里都踩过:名字对不上时 Dart 能编译,运行时却抛 MissingPluginException,没有任何构建期提示。
六、适配过程:注册通道并对齐语义
通道名必须与上游 Dart 源码逐字一致。本库的映射如下:
| 方法 | OpenHarmony 实现 | 说明 |
|---|---|---|
copy / copyRichText | pasteboard.createData/createHtmlData + setDataSync | 写入真实成功 |
paste / pasteRichText | getData() → getPrimaryText/getPrimaryHtml | |
pasteImage | getPrimaryPixelMap + ImagePacker 编码 PNG | |
hasData / getContentType / getDataSize | hasDataSync / getMimeTypes / 文本长度 | |
startMonitoring | 返回 false | 无系统级剪贴板变化订阅,Dart 回退轮询 |
核心代码:
private copyText(text: string): boolean {
try {
const data = pasteboard.createData(pasteboard.MIMETYPE_TEXT_PLAIN, text);
this.getPasteboard().setDataSync(data);
return true;
} catch (error) {
return false;
}
}
七、构建配置与签名
示例工程的目标 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:
clipboard:
git:
url: https://atomgit.com/oh-flutter/clipboard.git
ref: 3.0.14-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,否则系统只是把旧任务拉到前台,看到的是上一次安装的界面。
十、适配结果和当前边界
这是本批最重要的平台边界之一:读取剪贴板在鸿蒙上需要 ohos.permission.READ_PASTEBOARD(system_basic 级),普通三方应用拿不到。系统日志会明确打印 IsPermissionGranted# permission denied, perm=ohos.permission.READ_PASTEBOARD。写入不受限制。
十一、FAQ
Q1:为什么写入成功、读回是空?
- 原因: 不是实现问题。鸿蒙把剪贴板读取权限收在 system_basic 级,普通应用
getData()被系统拒绝,返回空。 - 验证结果: 真机:
copy → 已写入、isEmpty → false(剪贴板确有内容),paste → 空。
Q2:那 startMonitoring 还有意义吗?
- 原因: 鸿蒙没有系统级剪贴板变化事件,实现返回
false,上游 Dart 层据此自动回退为轮询pasteRichText()。 - 验证结果: 轮询路径在普通应用上同样会因读取权限返回空,属于同一边界。
十二、总结
clipboard 3.0.14 在鸿蒙上已经接入真实系统能力,Dart 侧 API 与上游保持一致。本文的验证结果全部来自 HarmonyOS API 26 真机按钮点击,没有占位返回值;平台本身不具备的能力在正文和 README 中都已明确标注为边界。
十三、参考资料和仓库地址
- 适配仓库主页
- 适配分支
- 适配 TAG
- 最终提交 89b0c46
- ArkTS 通道实现
- 鸿蒙适配说明
- pub.dev 包页面
- pub.dev 3.0.14 版本页
- 上游仓库
- Flutter 官方平台通道文档
- Flutter OH 鸿蒙 SDK 仓库
- HarmonyOS 开发者官方文档
欢迎加入CPF-Flutter 鸿蒙社区:https://atomgit.com/CPF-Flutter
更多推荐
所有评论(0)