鸿蒙版 Flutter 库 torch

本项目作者：王阳科/坚果

适配仓库地址[1]

作者仓库：

在数字化浪潮的推动下，跨平台开发框架如 Flutter 凭借其高效、便捷的特性，成为了开发者们的宠儿。而鸿蒙系统的崛起，更是为跨平台开发注入了新的活力。为了助力开发者在鸿蒙生态中快速实现 torch_light 来处理设备手电筒的插件功能，本文将深入浅出地为大家解析如何适配 torch_light 三方库至鸿蒙平台。

一、适配鸿蒙版 torch_light 三方库

（一）版本选择与仓库简介

我们先去 pub 上查看最新版本，我们选择以 0.0.10 版本为基础进行适配。torch_light 是一个简单的 Flutter 插件来处理设备手电筒的插件，其 GitHub 仓库为，我们的目标是将这个插件适配到鸿蒙平台。

（二）引入背景与使用场景

在 OpenHarmony 北向生态的发展过程中，许多已经适配了 Flutter 的厂商在接入 OpenHarmony 时，都希望能够继续使用 torch_light 来实现手电筒功能。因此，我们提供了这个适配方案，采用插件化的适配器模式，帮助生态伙伴快速实现产品化。

本方案适用于已经支持 Flutter 框架的设备在移植到 OpenHarmony 系统过程中，作为一个备选方案。

（三）使用文档与插件库使用

适配 OpenHarmony 平台的详细使用指导可以参考：Flutter 使用指导文档[2]

在项目中使用该插件库时，只需在 pubspec.yaml 文件的 dependencies 中新增如下配置：

dependencies:
  torch_light:
    git:
      url: "git@gitcode:nutpi/flutter_torch_light.git"
      path: ""

然后在项目根目录运行 flutter pub get，即可完成依赖添加

接下来是具体的适配过程。

二、适配过程详解

（一）准备工作

确保已经配置好了 Flutter 开发环境，具体可参考 Flutter 配置指南[3]。同时，从 官方插件库[4] 下载待适配的三方插件。本指导书， 以适配 torch_light[5] 为例

image-20250417200546042

（二）插件目录结构

下载并解压插件后，我们会看到以下目录结构：

• lib ：对接 Dart 端代码的入口，由此文件接收到参数后，通过 channel 将数据发送到原生端。
• android ：安卓端代码实现目录。
• ios ：iOS 原生端实现目录。
• example ：一个依赖于该插件的 Flutter 应用程序，用于说明如何使用它。
• README.md ：介绍包的文件。
• CHANGELOG.md ：记录每个版本中的更改。
• LICENSE ：包含软件包许可条款的文件。

（三）创建插件的鸿蒙模块

在插件目录下，打开 Terminal，执行以下命令来创建一个鸿蒙平台的 Flutter 模块：

flutter create . --org com.svprdga.torchlight --template=plugin --platforms=ohos

步骤：

1. 用 vscode/trae 打开刚刚下载好的插件。
2. 打开 Terminal，cd 到插件目录下。
3. 执行命令flutter create . --template=plugin --platforms=ohos 创建一个 ohos 平台的 flutter 模块。

第一个问题，修改 sdk 的版本，适配旧版本。

我们做好修改就好。

（四）在根目录下添加鸿蒙平台配置

在项目根目录的 pubspec.yaml 文件中，添加鸿蒙平台的相关配置：

name: torch_light
description:AFlutterplugintocheckifthedevicehasatorch/flashlight,andtoturnitonandoff.
version:1.1.0
homepage:/
repository:

environment:
sdk:">=2.17.5 <4.0.0"
flutter:">=2.3.0"

dependencies:
flutter:
    sdk:flutter

dev_dependencies:
flutter_test:
    sdk:flutter
lint:2.3.0

flutter:
plugin:
    platforms:
      android:
        package:com.svprdga.torchlight
        pluginClass:TorchLightPlugin
      ios:
        pluginClass:TorchLightPlugin
      ohos:
        package:com.svprdga.torchlight
        pluginClass:TorchLightPlugin

（五）编写鸿蒙插件的原生 ArkTS 模块

1. 创建鸿蒙插件模块

使用 DevEco Studio 打开鸿蒙项目。

2. 修改相关配置文件

在 ohos 目录内的 oh-package.json5 文件中添加 libs/flutter.har 依赖，并创建 .gitignore 文件，添加以下内容以忽略 libs 目录：

/node_modules
/oh_modules
/local.properties
/.preview
/.idea
/build
/libs
*.har
/.cxx
/.test
/BuildProfile.ets
/oh-package-lock.json5

oh-package.json5 文件内容如下：

{
  "name": "torch_light",
"version": "1.0.0",
"description": "Please describe the basic information.",
"main": "index.ets",
"author": "",
"license": "Apache-2.0",
"dependencies": {
    "@ohos/flutter_ohos": "file:./har/flutter.har"
  }
}

在 ohos 目录下创建 index.ets 文件，导出配置：

import TorchLightPlugin from './src/main/ets/components/plugin/TorchLightPlugin';
export default TorchLightPlugin;

3. 编写 ETS 代码

文件结构和代码逻辑可以参考安卓或 iOS 的实现，鸿蒙的 API 文档可以参考 ：

ohos 的 api 可以参考：

以下是 TorchLightPlugin.ets 文件的代码示例：

  private channel: MethodChannel | null = null;
  private nativeEventIsTorchAvailable: string = "torch_available";
  private errorIsTorchAvailable: string = "torch_available_error";

  private nativeEventEnableTorch: string = "enable_torch";
  private errorEnableTorchExistentUser: string = "enable_torch_error_existent_user";
  private errorEnableTorch: string = "enable_torch_error";
  private errorEnableTorchNotAvailable: string = "enable_torch_not_available";

  private nativeEventDisableTorch: string = "disable_torch";
  private errorDisableTorchExistentUser: string = "disable_torch_error_existent_user";
  private errorDisableTorch: string = "disable_torch_error";
  private errorDisableTorchNotAvailable: string = "disable_torch_not_available";

这里我主要参考的是

三、手电筒使用

手电筒模式的使用是通过操作手机启用手电筒功能，使设备的手电筒功能持续保持常亮状态。

在使用相机应用并操作手电筒功能时，存在以下几种情况说明：

• 当使用后置摄像头并设置闪光灯模式FlashMode[6]关闭时，手电筒功能无法启用。
• 当使用前置摄像头时，手电筒可以正常启用并保持常亮状态。
• 从前置摄像头切换至后置摄像头时，如果手电筒原本处于开启状态，它将会被自动关闭。

详情请参考Camera API 参考[7]。

开发步骤

导入 camera 接口，接口中提供了相机相关的属性和方法，导入方法如下。

import { camera } from '@kit.CameraKit';
import { BusinessError } from '@kit.BasicServicesKit';

通过CameraManager[8]类中的isTorchSupported[9]方法，检测当前设备是否支持手电筒功能。

function isTorchSupported(cameraManager: camera.CameraManager) : boolean {
    let torchSupport: boolean = false;
    try {
        torchSupport = cameraManager.isTorchSupported();
    } catch (error) {
        let err = error as BusinessError;
        console.error('Failed to torch. errorCode = ' + err.code);
    }
    console.info('Returned with the torch support status:' + torchSupport);
    return torchSupport;
}

通过CameraManager[10]类中的isTorchModeSupported[11]方法，检测是否支持指定的手电筒模式TorchMode[12]。

function isTorchModeSupported(cameraManager: camera.CameraManager, torchMode: camera.TorchMode) : boolean {
    let isTorchModeSupport: boolean = false;
    try {
        isTorchModeSupport = cameraManager.isTorchModeSupported(torchMode);
    } catch (error) {
        let err = error as BusinessError;
        console.error('Failed to set the torch mode. errorCode = ' + err.code);
    }
    return isTorchModeSupport;
}

通过CameraManager[13]类中的setTorchMode[14]方法，设置当前设备的手电筒模式。以及通过CameraManager[15]类中的getTorchMode[16]方法，获取当前设备的手电筒模式。

在使用getTorchMode[17]方法前，需要先注册监听手电筒的状态变化，请参考状态监听[18]。

function setTorchModeSupported(cameraManager: camera.CameraManager, torchMode: camera.TorchMode) : void {
    cameraManager.setTorchMode(torchMode);
    let isTorchMode = cameraManager.getTorchMode();
    console.info(`Returned with the torch mode supportd mode: ${isTorchMode}`);
}

状态监听

在相机应用开发过程中，可以随时监听手电筒状态，包括手电筒打开、手电筒关闭、手电筒不可用、手电筒恢复可用。手电筒状态发生变化，可通过回调函数获取手电筒模式的变化。

通过注册 torchStatusChange 事件，通过回调返回监听结果，callback 返回 TorchStatusInfo 参数，参数的具体内容可参考相机管理器回调接口实例TorchStatusInfo[19]。

function onTorchStatusChange(cameraManager: camera.CameraManager): void {
    cameraManager.on('torchStatusChange', (err: BusinessError, torchStatusInfo: camera.TorchStatusInfo) => {
        if (err !== undefined && err.code !== 0) {
            console.error(`Callback Error, errorCode: ${err.code}`);
            return;
        }
        console.info(`onTorchStatusChange, isTorchAvailable: ${torchStatusInfo.isTorchAvailable}, isTorchActive: ${torchStatusInfo.
            isTorchActive}, level: ${torchStatusInfo.torchLevel}`);
    });
}

完整的代码

微信：17752170152获取/

四、编写 Example

1. 创建 Example 应用

在插件根目录下创建一个名为 example 的文件夹，用于存放示例应用。在 example 文件夹中，创建一个鸿蒙平台的 Flutter 应用，用于验证插件功能。

2. 签名与运行

使用 Deveco Studio 打开 example > ohos 目录，单击 File > Project Structure > Project > Signing Configs，勾选 Automatically generate signature，等待自动签名完成。然后运行以下命令：

flutter pub get

 flutter build hap --debug

如果应用正常启动，说明插件适配成功。如果没有，欢迎大家联系坚果派一起支持。

五、总结

通过以上步骤，我们成功地将 torch_light 三方库适配到了鸿蒙平台。这个过程涉及到了解插件的基本信息、配置开发环境、创建鸿蒙模块、编写原生代码以及测试验证等多个环节。希望这篇博客能够帮助到需要进行 torch_light 鸿蒙适配的开发者们，让大家在鸿蒙生态的开发中更加得心应手。

六、参考

• [如何使用 Flutter 与 OpenHarmony 通信 FlutterChannel]( FlutterChannel.md "如何使用 Flutter 与 OpenHarmony 通信 FlutterChannel")
• [开发 module]( module.md "开发 module")
• 开发 package[20]
• 开发 plugin[21]
• [开发 FFI plugin]( plugin.md "开发 FFI plugin")
• developing-packages[22]
• 适配仓库地址[23]
• 手电筒[24]

七、坚果派

坚果派由坚果等人创建，团队拥有若干华为 HDE，以及若干其他领域的三十余位万粉博主运营。专注于分享的技术包括 HarmonyOS/OpenHarmony，ArkUI-X，元服务，服务卡片，华为自研语言，BlueOS 操作系统、团队成员聚集在北京、上海、广州、深圳、南京、杭州、苏州、宁夏等地。 聚焦“鸿蒙原生应用”、“智能物联”和“AI 赋能”、“人工智能”四大业务领域，依托华为开发者专家等强大的技术团队，以及涵盖需求、开发、测试、运维于一体的综合服务体系，赋能文旅、媒体、社交、家居、消费电子等行业客户，满足社区客户数字化升级转型的需求，帮助客户实现价值提升。 目前上架鸿蒙原生应用 18 款，三方库 72 个。

地址：

八、FAQ

参考资料

[1]

适配仓库地址:

[2]

Flutter使用指导文档: .md

[3]

Flutter 配置指南: .md

[4]

官方插件库: /

[5]

torch_light: .1.0

[6]

FlashMode:

[7]

Camera API参考:

[8]

CameraManager:

[9]

isTorchSupported:

[10]

CameraManager:

[11]

isTorchModeSupported:

[12]

TorchMode:

[13]

CameraManager:

[14]

setTorchMode:

[15]

CameraManager:

[16]

getTorchMode:

[17]

getTorchMode:

[18]

状态监听:

[19]

TorchStatusInfo:

[20]

开发package: .md

[21]

开发plugin: .md

[22]

developing-packages:

[23]

适配仓库地址:

[24]

手电筒: