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

监听软键盘高度，向 Flutter 提供键盘遮挡区域的尺寸与可见状态。

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

适配仓库： smart_keyboard_insets

适配分支： feat/ohos_smart_keyboard_insets_0.3.1

适配 TAG： 0.3.1-ohos.1

一、先看最终效果

在这里插入图片描述

图 1：HarmonyOS API 26 真机启动示例页

验证点实测结果
Flutter OH 3.47 工程构建通过，产出 entry-default-signed.hap
安装、启动（真机）通过
键盘高度keyboardHeight: 0.0
可见状态visible: false
底部安全区safeAreaBottom: 28.0

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

上游 smart_keyboard_insets 通过平台通道与原生侧通信，通道定义在 Dart 源码里，原生侧只需要注册同名通道并实现方法分发，Dart 代码一行都不用改。

MethodChannel('smart_keyboard_insets/method')
EventChannel('smart_keyboard_insets/event')

本库是事件流型插件：方法通道只用于控制，实际数据从 EventChannel 推送。实现里 onListen 负责订阅窗口避让区。

三、实际环境

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（CHZ-AL00），HarmonyOS 7.0.0.109（API 26）
目标库smart_keyboard_insets 0.3.1
flutter --version
hdc list targets

这里要特别注意 Flutter 版本：本机同时装了 3.41 和 3.47.4-ohos，3.41 会因为 SDK 约束解析失败，构建时必须显式把 3.47.4-ohos 放到 PATH 前面。

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

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

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

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

git switch -c feat/ohos_smart_keyboard_insets_0.3.1

关键目录如下：

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

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: SmartKeyboardInsetsPlugin

pluginClass 必须和 ohos/index.ets 导出的类名一致。这一步是本批次最容易踩的坑：pubspec.yaml 里漏掉 ohos 声明时，Flutter 生成的 GeneratedPluginRegistrant.ets 是个空 try 块，Dart 侧调用直接返回 null，构建期没有任何报错，运行时也不抛 MissingPluginException，只是所有返回值都是空的。我第一次跑 is_lock_screen2 就卡在这里，查了半天日志才发现注册表是空的。

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

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

方法OpenHarmony 实现说明
keyboardMetricswindow.Window.on('avoidAreaChange') 中读取 `AvoidAreaType.TYPE_KEYBOARDpartially
AnimatedKeyboardPadding键盘高度变化时自动补足底部间距；纯 Dart 组件，读取上面的事件流yes
KeyboardPadding静态键盘间距组件yes

核心代码：

  onListen(args: Any, events: EventSink): void {
    this.sink = events;
    try {
      this.density = display.getDefaultDisplaySync().densityPixels;
      const c = this.ctx;
      if (c === null) {
        events.success({ 'height': 0, 'visible': false });
        return;
      }
      window.getLastWindow(c).then((w: window.Window): void => {
        this.win = w;
        w.on('avoidAreaChange', (data: window.AvoidAreaOptions): void => {
          if (data.type === window.AvoidAreaType.TYPE_KEYBOARD) {
            const rect: window.Rect = data.area.bottomRect;
            const h: number = Math.max(0, Math.round(rect.height / this.density));
            this.emit(h);
          }
        });
      }).catch((): void => {
        events.success({ 'height': 0, 'visible': false });
      });
    } catch (e) {
      events.success({ 'height': 0, 'visible': false });
    }
  }

这段是 StreamHandler.onListen，不是方法分发。TYPE_KEYBOARD 需要 API 15+，拿不到时按 height: 0 兜底，保证 Dart 侧流不会挂起。

七、构建配置与签名

示例工程的目标 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 和密码不提交到仓库。

另外两个和签名、SDK 相关的坑：

  • build-profile.json5 里签名材料写 ${HOME} 不会展开，必须是绝对路径，否则报 00303107 Invalid storeFile value。
  • DEVECO_SDK_HOME 要指向 Contents/sdk（含版本目录的上一级）。指到 sdk/default 报 00303312 Cannot find the corresponding SDK version，完全不设则报 00303217。

八、通过 AtomGit 引入适配版

在业务工程中使用时锁定 TAG：

dependencies:
  smart_keyboard_insets:
    git:
      url: https://atomgit.com/oh-flutter/smart_keyboard_insets.git
      ref: 0.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，否则系统只是把旧任务拉到前台，看到的是上一次安装的界面——这个现象在批量验证时骗过我一次。

取实测值时用 uitest 定位控件并点击，而不是靠肉眼判断：

hdc shell "uitest dumpLayout -p /data/local/tmp/l.json"
hdc file recv /data/local/tmp/l.json /tmp/l.json
hdc shell "uitest uiInput click <x> <y>"
hdc shell "uitest screenCap -p /data/local/tmp/s.png"

十、适配结果和当前边界

  • AvoidAreaType.TYPE_KEYBOARD 需要 API 15 及以上，且部分设备不回报键盘避让区，此时事件恒为 height: 0, visible: false，不会伪造高度。
  • 鸿蒙避让区给的是窗口坐标系下的矩形，本实现按屏幕 densityPixels 换算为逻辑像素，与 Flutter 的逻辑像素单位对齐；极端分屏比例下可能与实际键盘高度有 1-2px 偏差。

十一、FAQ

Q1：键盘没弹出来时为什么是 0？

  • 原因： 页面未弹出键盘时避让区高度就是 0，visible 为 false。safeAreaBottom: 28.0 来自底部手势条的避让区，说明避让区读取链路本身是通的。
  • 验证结果： 真机上 keyboardHeight: 0.0、safeAreaBottom: 28.0、visible: false。

Q2：为什么要把高度除以 densityPixels？

  • 原因： 鸿蒙避让区给的是物理像素，Flutter 用的是逻辑像素。不换算的话 Dart 侧会拿到三倍尺寸的间距（本机 devicePixelRatio = 3）。

Q3：哪些设备拿不到键盘高度？

  • 原因： AvoidAreaType.TYPE_KEYBOARD 需要 API 15 及以上，且部分设备不回报键盘避让区。这种情况下事件恒为 height: 0，实现不伪造高度。

十二、总结

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

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

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

# flutter # harmonyos # 华为 # 矩阵 # tensorflow # 线性代数 # pytorch
Logo
人工智能6S服务平台

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

更多推荐

cover

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

avatar 人工智能6S服务平台
cover

一个后端老兵看DeepInfer:开源了一半,但那一半里有真东西

avatar 人工智能6S服务平台
cover

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

avatar 人工智能6S服务平台