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

ujainu

75人浏览 · 2026-10-17 17:47:58

ujainu · 2026-10-17 17:47:58 发布

屏幕常亮是阅读、导航、投屏这类场景的基础诉求：用户长时间不操作时，屏幕不应该自己熄灭。keep_screen_on 在 Android 上给窗口加 FLAG_KEEP_SCREEN_ON，在 iOS 上设置 UIApplication.isIdleTimerDisabled。

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

适配仓库： keep_screen_on

适配分支： feat/ohos_keep_screen_on_7.0.0

适配 TAG： 7.0.0-ohos.1

一、先看最终效果

图 1：HarmonyOS API 26 真机启动 Demo。页面显示 keep_screen_on 7.0.0。

图 2：点击“查询是否常亮”后的真实返回：isOn → false。

图 3：点击“开启屏幕常亮”后的真实返回：turnOn → true。

图 4：点击“关闭屏幕常亮”后的真实返回：turnOff → false。

验证点	实测结果
Flutter OH 3.47 工程构建	通过，产出 `entry-default-signed.hap`
安装、启动（真机）	通过
查询是否常亮	`isOn → false`
开启屏幕常亮	`turnOn → true`
关闭屏幕常亮	`turnOff → false`

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

这个库的平台接口层只走一条 MethodChannel：

Dart KeepScreenOn
  -> MethodChannel('dev.craftsoft/keep_screen_on')
  -> Android WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON
  -> iOS UIApplication.shared.isIdleTimerDisabled

方法只有三个：isOn 查询、turnOn 开启、turnOff 关闭（内部就是 turnOn(on: false)）。

三、实际环境

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）
目标库	`keep_screen_on 7.0.0`

flutter --version
hdc list targets

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

上游包地址是 https://github.com/craftsoft-dev/flutter_keep_screen_on，版本 7.0.0 使用 MIT License。适配前我先查了 flutter-ohos-adaptation-checklist：本库被列在「适配中」清单（第 8 条，分类「设备信息与系统」），说明社区已有其他同学在做。本文这份是 oh-flutter 组织下的独立实现，如果与在研方案重复，可优先采用任意一方并把另一份归档。

仓库适配提交为 1ee21b3，分支与 TAG 7.0.0-ohos.1 均指向该提交。

git clone https://atomgit.com/oh-flutter/keep_screen_on.git
cd keep_screen_on
git switch feat/ohos_keep_screen_on_7.0.0
git log --oneline -5

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

git switch -c feat/ohos_keep_screen_on_7.0.0

关键目录如下：

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

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: KeepScreenOnPlugin

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

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

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

方法	OpenHarmony 实现	说明
`isOn`	`window.getWindowProperties().isKeepScreenOn`	读窗口真实状态，不是缓存值
`turnOn` / `turnOff`	`window.setWindowKeepScreenOn(bool)` + 立即回读	返回的是回读值，调用成功但未生效时会拿到 `false`

核心代码：

@override
public void onMethodCall(MethodCall call, MethodResult result) {
  switch (call.method) {
    case 'isOn':
      this.isOn().then((value) => result.success(value));
      return;
    case 'turnOn':
      this.turnOn(call.argument('on')).then((value) => result.success(value));
      return;
    default:
      result.notImplemented();
  }
}

private async turnOn(on: boolean): Promise<boolean> {
  const win = await this.getWindow();
  await win.setWindowKeepScreenOn(on);
  // 回读：以窗口属性为准，而不是假定写入成功
  return win.getWindowProperties().isKeepScreenOn;
}

七、构建配置与签名

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

十、适配结果和当前边界

isAllowLockWhileScreenOn 系列是 Android 窗口 Flag 的专有语义（允许锁屏但保持亮屏），鸿蒙窗口没有对应属性，因此这部分保持未实现，调用会走 notImplemented。

十一、FAQ

Q1：为什么要回读窗口属性？

原因： setWindowKeepScreenOn 是异步写入，某些窗口状态下调用会返回成功但属性没变。回读能把"假成功"暴露出来，Dart 侧拿到的布尔值就是真实状态。
验证结果： 真机上 turnOn 返回 true，turnOff 返回 false，与窗口属性一致。