Flutter Wakelock 鸿蒙使用指南

最新推荐文章于 2025-12-23 22:07:27 发布

原创最新推荐文章于 2025-12-23 22:07:27 发布 · 678 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#flutter #harmonyos #华为

1. 插件介绍

Flutter Wakelock 是一个用于控制设备屏幕唤醒状态的 Flutter 插件，它允许开发者在应用程序运行期间保持屏幕常亮或允许屏幕休眠。该插件基于原生平台的 API 实现，提供了简单易用的跨平台接口。

核心功能

屏幕常亮控制：通过 API 调用轻松控制设备屏幕的唤醒状态
跨平台支持：支持 Android、iOS、Web、macOS、Windows 和 HarmonyOS
轻量级设计：插件体积小，不影响应用性能
简单 API：仅需几行代码即可实现屏幕唤醒控制功能

鸿蒙平台适配

本版本的 Flutter Wakelock 是专门为 HarmonyOS 平台定制修改的版本，提供了完整的屏幕唤醒控制功能。所有核心 API 在 HarmonyOS 平台上都能正常工作，确保开发者能够获得一致的开发体验。

2. 包的引入

由于本版本的 Flutter Wakelock 是自定义修改版本，需要通过 Git 形式引入。以下是在 Flutter 项目中引入该插件的步骤：

修改 pubspec.yaml

在项目的 pubspec.yaml 文件中的 dependencies 部分添加以下配置：

dependencies:
  flutter:
    sdk: flutter

  # 添加 Wakelock 插件依赖
  wakelock:
    git:
      url: "https://gitcode.com/openharmony-sig/flutter_wakelock.git"
      path: "wakelock"

执行依赖获取

在项目根目录下执行以下命令，获取插件依赖：

flutter pub get

3. API 调用示例

Flutter Wakelock 提供了简洁易用的 API，以下是常用功能的使用示例：

导入包

首先，在需要使用 Wakelock 的 Dart 文件中导入包：

import 'package:wakelock/wakelock.dart';

启用屏幕常亮

使用 enable() 方法可以保持设备屏幕常亮：

// 启用屏幕常亮
Wakelock.enable();

禁用屏幕常亮

使用 disable() 方法可以允许设备屏幕休眠：

// 禁用屏幕常亮，允许屏幕休眠
Wakelock.disable();

切换屏幕常亮状态

使用 toggle() 方法可以根据参数切换屏幕常亮状态：

// 根据参数切换屏幕常亮状态
bool enableWakelock = true; // true: 启用, false: 禁用
Wakelock.toggle(enable: enableWakelock);

检查当前屏幕常亮状态

使用 enabled getter 可以获取当前屏幕常亮状态：

// 获取当前屏幕常亮状态
bool isWakelockEnabled = await Wakelock.enabled;
print('当前屏幕常亮状态: $isWakelockEnabled');

完整示例

以下是一个完整的 Flutter Widget 示例，展示了如何使用 Wakelock 插件：

import 'package:flutter/material.dart';
import 'package:wakelock/wakelock.dart';

void main() {
  runApp(const WakelockExampleApp());
}

class WakelockExampleApp extends StatefulWidget {
  const WakelockExampleApp({Key? key}) : super(key: key);

  @override
  _WakelockExampleAppState createState() => _WakelockExampleAppState();
}

class _WakelockExampleAppState extends State<WakelockExampleApp> {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Wakelock 示例应用'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.spaceEvenly,
            children: <Widget>[
              const Spacer(flex: 3),

              // 启用屏幕常亮按钮
              OutlinedButton(
                onPressed: () {
                  setState(() {
                    Wakelock.enable();
                  });
                },
                child: const Text('启用屏幕常亮'),
              ),

              const Spacer(),

              // 禁用屏幕常亮按钮
              OutlinedButton(
                onPressed: () {
                  setState(() {
                    Wakelock.disable();
                  });
                },
                child: const Text('禁用屏幕常亮'),
              ),

              const Spacer(flex: 2),

              // 显示当前屏幕常亮状态
              FutureBuilder(
                future: Wakelock.enabled,
                builder: (context, AsyncSnapshot<bool> snapshot) {
                  final data = snapshot.data;
                  if (data == null) {
                    return Container();
                  }

                  return Text('当前屏幕常亮状态: ${data ? '已启用' : '已禁用'}');
                },
              ),

              const Spacer(flex: 3),
            ],
          ),
        ),
      ),
    );
  }
}

4. 约束与限制

兼容性

本版本的 Flutter Wakelock 在以下环境中已测试通过：

Flutter: 3.7.12-ohos-1.0.6; SDK: 5.0.0(12); IDE: DevEco Studio: 5.0.13.200; ROM: 5.1.0.120 SP3;
Flutter: 3.22.1-ohos-1.0.1; SDK: 5.0.0(12); IDE: DevEco Studio: 5.0.13.200; ROM: 5.1.0.120 SP3;

API 支持情况

所有核心 API 在 HarmonyOS 平台上都能正常工作：

API 方法	描述	HarmonyOS 支持情况
`enable()`	启用设备唤醒锁（保持屏幕常亮）	✅
`disable()`	禁用设备唤醒锁（允许屏幕休眠）	✅
`toggle({required bool enable})`	切换设备唤醒锁的状态	✅
`enabled`	获取当前设备唤醒锁的启用状态	✅