开发工具: 华为云码道

本文配套仓库(预定地址): oh-flutter/device_accessibility_info

device_accessibility_info 将屏幕朗读状态查询与变化通知封装为 Flutter 插件,应用可以读取当前状态,并监听读屏功能的开启和关闭。本文以 device_accessibility_info 1.0.0 为例,介绍源码准备、OHOS 工程配置、ArkTS 实现和 example 真机运行。

插件声明 androidiosohos 平台支持。配套仓库地址统一规划为 oh-flutter/device_accessibility_info;尚未创建或同步时,先使用本地源码。本文代码参考本地提交 086bfc383fed4d842bc2be294d5aac8ede495cda;该提交需同步到配套仓库后才能通过远端获取。


device_accessibility_info 鸿蒙真机:未开启 device_accessibility_info 鸿蒙真机:已开启 device_accessibility_info 鸿蒙真机:关闭后刷新

真机运行图(从左到右):未开启/已开启/关闭后刷新。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。

截图标注:操作步骤与截图命令

执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。

mkdir -p blog-assets/device_accessibility_info

未开启: 关闭系统屏幕朗读,返回 Demo 点击“刷新状态”。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-disabled.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-disabled.jpeg ./blog-assets/device_accessibility_info/disabled.jpeg

已开启: 在“设置 → 关怀和无障碍 → 屏幕朗读”开启功能后回到 Demo,等待状态更新。绿色焦点框和底部提示是系统读屏界面。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-enabled.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-enabled.jpeg ./blog-assets/device_accessibility_info/enabled.jpeg

关闭后刷新: 关闭屏幕朗读后回到 Demo,点击“刷新状态”,保留平台版本与最新状态。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-disabled-refreshed.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-disabled-refreshed.jpeg ./blog-assets/device_accessibility_info/disabled-refreshed.jpeg

一、插件简介与适配目标

屏幕朗读是无障碍能力的一部分。OHOS 端通过 Accessibility Kit 查询系统读屏、触摸浏览及已启用的语音无障碍扩展,综合判断是否开启屏幕朗读。业务层不需要自己识别读屏服务进程。

例如,阅读器可以在读屏开启时简化重复提示,表单可以调整焦点顺序,交互页面可以根据无障碍使用场景提供更清楚的操作反馈。

当前状态通过异步查询获取,变化通过事件流推送。首次监听会发送一次当前状态,此后系统相关事件触发重新查询。


二、环境准备

环境搭建参考社区文档:Flutter OH 开发环境搭建,完成 Flutter OH SDK 安装、环境变量和 DevEco Studio 配置。

完成后,在宿主机终端执行以下命令,确认当前选中的是支持 OHOS 的 Flutter 工具链,并能发现目标设备:

flutter --version
flutter doctor -v
hdc list targets

工程使用的工具链和 SDK 配置如下:

项目版本或配置用途
Flutter OHOS SDK3.44.9+ohos-0.0.1-canary1Flutter 编译与 OHOS 平台工具链
Flutter 分支oh-3.44.9-devCPF-Flutter 对应开发分支
Dart SDK3.12.2Dart 语言与包管理环境
HarmonyOS 开发套件7.0.0(API 26)开发套件版本及对应的 API 级别
compileSdkVersion26.0.0编译时使用的 SDK API
targetSdkVersion26.0.0应用面向的行为版本
compatibleSdkVersion5.1.0(18)当前工程声明的最低兼容版本
插件版本1.0.0pubspec.yaml 中的包版本
原生语言ArkTSHarmonyOS 插件实现
插件产物HAR被应用 entry 模块依赖

2.1 开发套件版本与工程中的 SDK 版本配置

7.0.0(API 26)26.0.0 涉及 HarmonyOS 开发套件版本(API 版本)及其底座 OpenHarmony 的版本号体系。在本文工程中,相关版本的含义与配置方式如下:

  • 7.0.0(API 26) 表示 HarmonyOS 开发套件版本为 7.0.0,对应 API 26。
  • 26.0.0 是本文 HarmonyOS 应用工程中 compileSdkVersiontargetSdkVersion 的属性值。
  • 5.1.0(18) 是本文工程中 compatibleSdkVersion 的属性值,声明最低兼容 API 18。

对应的 product 配置为:

{
  "name": "default",
  "compatibleSdkVersion": "5.1.0(18)",
  "compileSdkVersion": "26.0.0",
  "targetSdkVersion": "26.0.0",
  "runtimeOS": "HarmonyOS"
}

这组配置使用 API 26 SDK 编译,并以 API 26 为目标版本,最低兼容 API 18。是否收到状态变化取决于系统和无障碍扩展的事件支持。OHOS 使用三个条件的逻辑或判断,不等同于只检查某一个读屏开关。


三、从源码仓库开始准备适配工程

3.1 将上游源码同步到 AtomGit

适配已有第三方插件时,先从 Pub 包信息或项目 README 确认上游地址、包名、版本和许可证。同步仓库时保留源码、许可证和提交历史,方便后续跟踪上游更新。

在 AtomGit 网页的新建仓库流程中,找到从已有仓库导入的入口,填写上游 Git 地址,选择自己有写权限的组织或个人空间,设置目标仓库名称后执行导入。完成后检查目标分支、pubspec.yamlLICENSE 和提交历史是否完整,并记录适配起点的提交号。如果上游本身托管在 AtomGit,也可以通过 Fork 获得自己的工作仓库。

上游源码为 https://github.com/yasinarik/device_accessibility_info,本文基于 1.0.0。配套仓库预定为 device_accessibility_info。仓库创建并同步适配代码后,再执行下面的拉取命令;尚未同步时使用本地副本。需要提交修改时,使用自己有写权限的仓库或 Fork。

3.2 将代码拉取到宿主机

在安装了 Flutter OH 和 DevEco Studio 的开发电脑上打开终端,进入准备存放项目的目录,执行:

git clone https://atomgit.com/oh-flutter/device_accessibility_info.git
cd device_accessibility_info
pwd
ls
git remote -v
git status --short --branch
git rev-parse HEAD

git clone 会创建 device_accessibility_info/ 目录;cd 后的位置就是下文所说的插件仓库根目录,这里应能看到 pubspec.yamllib/example/。Git 仓库名和 Dart 包名均为 device_accessibility_info

需要使用与本文相同的代码版本时,先确认配套仓库已经包含下列本地参考提交,再在没有未提交修改的仓库中执行:

git switch --detach 086bfc383fed4d842bc2be294d5aac8ede495cda

适配其他插件时,使用该插件对应版本的 tag 或 commit 作为分支起点。

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

图 1:在宿主机终端输入 AtomGit 仓库拉取命令。

3.3 在仓库根目录创建适配分支

接着在 device_accessibility_info/ 根目录创建分支。分支名统一使用 feat/ohos_库名称_版本号,库名称取 pubspec.yamlname,版本号取此次适配的基线版本。本例为:

git switch -c feat/ohos_device_accessibility_info_1.0.0
git branch --show-current

如果该分支已存在,使用 git switch feat/ohos_device_accessibility_info_1.0.0 切换即可。

在这里插入图片描述

图 2:在 device_accessibility_info 仓库根目录输入适配分支创建命令。

3.4 自动补全 OHOS 适配结构

分支创建后,仍在同一个插件根目录执行结构补全。以下命令适用于尚无 ohos/ 目录的既有 Flutter 平台插件

flutter create --template=plugin --platforms=ohos --project-name device_accessibility_info .
git status --short
git diff -- pubspec.yaml lib example
  • --template=plugin 指定插件模板。
  • --platforms=ohos 指定需要补全的平台。
  • --project-name device_accessibility_info 使用 Dart 包名,避免当前目录重命名后生成错误的包名。
  • 最后的 . 表示在当前插件目录补全工程,不是另建一层 device_accessibility_info/

该命令生成 OHOS 平台脚手架,业务逻辑需要在 ArkTS 中实现。生成后通过 diff 检查 pubspec.yamllib/example/ 的变化,保留已有 API、其他平台注册项及依赖配置。不同 Flutter OH 版本生成的模板可能略有差异。

如果生成后 example/ohos/ 仍不存在,进入已有示例应用补全平台:

cd example
flutter create --platforms=ohos .
cd ..

本地适配工作区已经包含 ohos/example/ohos/,直接运行示例时可以跳过结构补全。新建插件则使用 flutter create --org com.nutpi --template=plugin --platforms=ohos device_accessibility_info;已有插件使用上面的 . 在当前目录补全。

在这里插入图片描述

图 3:在插件根目录输入 OHOS 结构补全命令。

3.5 适配后的项目目录

适配后的关键目录如下:

device_accessibility_info/
├── lib/
│   ├── device_accessibility_info.dart
│   ├── device_accessibility_info_platform_interface.dart
│   └── device_accessibility_info_method_channel.dart
├── ohos/
│   ├── src/
│   │   └── main/
│   │       ├── ets/
│   │       │   └── components/
│   │       │       └── plugin/
│   │       │           └── DeviceAccessibilityInfoPlugin.ets
│   │       └── module.json5
│   ├── index.ets
│   └── oh-package.json5
├── example/
│   ├── lib/
│   │   └── main.dart
│   └── ohos/
│       ├── entry/
│       │   └── src/
│       │       └── main/
│       │           └── module.json5
│       └── build-profile.json5
├── pubspec.yaml
├── README.OpenHarmony_CN.md
├── README.OpenHarmony.md
├── CHANGELOG.OpenHarmony.md
└── test/

项目根目录如下,其中包含 ohos/example/ 及实际保留的说明文件;交付文档清单见第六节:
在这里插入图片描述

图 4:适配后的 device_accessibility_info 项目根目录。

文件主要职责
lib/device_accessibility_info.dart提供业务公开 API
lib/device_accessibility_info_platform_interface.dart实现平台协议或数据模型
lib/device_accessibility_info_method_channel.dart实现平台协议或数据模型
ohos/src/main/ets/components/plugin/DeviceAccessibilityInfoPlugin.ets注册通道并实现 OHOS 原生能力
ohos/src/main/module.json5声明 HAR 模块和权限
example/lib/main.dart演示接口调用与结果显示

四、Dart 接口与通道分析

OHOS 实现需要遵循 Dart 层已有的方法、参数和回调约定。先阅读 lib/device_accessibility_info.dartlib/device_accessibility_info_platform_interface.dartlib/device_accessibility_info_method_channel.dart,再在 ohos/src/main/ets/components/plugin/DeviceAccessibilityInfoPlugin.ets 中实现对应的原生调用。适配其他已有平台的插件时,也应保留其公开接口和其他平台实现。

本例的对应关系如下:

Dart 入口或模型通道协议OHOS 实现应保持的行为
isScreenReaderEnabled()isScreenReaderEnabled三个无障碍状态的逻辑或Future<bool>
screenReaderStatusChangeddevice_accessibility_info/events监听三类无障碍事件首次当前值与后续 bool
getPlatformVersion()getPlatformVersiondeviceInfo.osFullNameFuture<String?>

原生端需要保持方法名、参数键和返回类型一致,不能只保留方法名称而改变业务语义。

4.1 跨端架构与调用时序

Flutter 侧通过 MethodChannel('device_accessibility_info/methods') 调用 OHOS 实现。持续变化通过 EventChannel('device_accessibility_info/events') 推送;一次查询结果与后续事件分别处理。

Flutter 页面

Dart 对外 API

MethodChannel device_accessibility_info/methods

ArkTS DeviceAccessibilityInfoPlugin

AccessibilityKit accessibility

EventChannel 与方法结果

4.1.1 一次完整查询屏幕朗读状态的时序
Accessibility Kit OHOS 插件 DeviceAccessibilityInfo Flutter 页面 Accessibility Kit OHOS 插件 DeviceAccessibilityInfo Flutter 页面 isScreenReaderEnabled() 方法查询 读取三种状态 bool 查询结果 screenReaderStatusChanged.listen EventChannel onListen 注册三种状态事件 发送当前 bool 状态发生变化 重新读取综合状态 bool 事件 页面回调 subscription.cancel() 底层监听取消时 onCancel 解除三种事件

4.2 状态模型:bool 屏幕朗读状态

业务含义边界
true读屏、触摸浏览或语音扩展至少一项开启综合判断
false当前查询未检测到上述开启状态查询失败另走异常路径

Dart 查询收到 null 时按 false 处理,事件则使用 event as bool,不会自动将任意类型转换为布尔值。

4.3 公开 API 与平台接口

DeviceAccessibilityInfoPlatform 定义平台接口,业务通过 DeviceAccessibilityInfo 转发调用,测试可以替换平台实例。公开方法保持原接口:

import 'device_accessibility_info_platform_interface.dart';

class DeviceAccessibilityInfo {
  Future<String?> getPlatformVersion() {
    return DeviceAccessibilityInfoPlatform.instance.getPlatformVersion();
  }

  /// Returns whether the screen reader is currently enabled.
  ///
  /// On iOS, this checks if VoiceOver is running.
  /// On Android, this checks if TalkBack is enabled.
  ///
  /// Returns `true` if screen reader is enabled, `false` otherwise.
  Future<bool> isScreenReaderEnabled() {
    return DeviceAccessibilityInfoPlatform.instance.isScreenReaderEnabled();
  }

  /// Returns a stream that emits screen reader status changes.
  ///
  /// The stream emits `true` when screen reader is enabled and `false` when disabled.
  /// On iOS, this listens for VoiceOver status changes.
  /// On Android, this listens for TalkBack status changes.
  ///
  /// Example usage:
  /// ```dart
  /// DeviceAccessibilityInfo().screenReaderStatusChanged.listen((isEnabled) {
  ///   print('Screen reader is ${isEnabled ? 'enabled' : 'disabled'}');
  /// });
  /// ```
  Stream<bool> get screenReaderStatusChanged {
    return DeviceAccessibilityInfoPlatform.instance.screenReaderStatusChanged;
  }
}

4.4 Dart 通道协议分析

4.4.1 通道名称必须两端完全一致
const methodChannel = MethodChannel('device_accessibility_info/methods');
const eventChannel = EventChannel('device_accessibility_info/events');

通道名称属于跨语言协议。Dart 和 ArkTS 任何一端拼写不一致,都会出现“方法未实现”或“调用找不到插件”等问题。

4.4.2 查询与监听状态

MethodChannel 负责查询,EventChannel 使用缓存的广播流:

Future<bool> isScreenReaderEnabled() async {
  final isEnabled =
      await methodChannel.invokeMethod<bool>('isScreenReaderEnabled');
  return isEnabled ?? false;
}

Stream<bool> get screenReaderStatusChanged {
  _screenReaderStatusStream ??= eventChannel
      .receiveBroadcastStream()
      .map<bool>((dynamic event) => event as bool);
  return _screenReaderStatusStream!;
}
4.4.3 取消页面监听

应用保存 StreamSubscription<bool> 并在不再需要时取消:

StreamSubscription<bool>? subscription;

Future<void> stopListening() async {
  await subscription?.cancel();
  subscription = null;
}

这段是业务侧生命周期示例,需要导入 dart:async。插件没有独立的 unsubscribe 方法;底层事件流取消后进入原生 onCancel。


五、补全 OHOS 原生实现与工程配置

5.1 在 DeviceAccessibilityInfoPlugin.ets 中实现原生能力

业务层沿用已有 API,原生侧在 DeviceAccessibilityInfoPlugin 中接入 AccessibilityKit accessibility,通过 Flutter 通道回传结果。

下面列出类中的主要成员和方法,完整文件还包含 getUniqueClassName() 等插件接口;各段均为核心摘录,需要结合完整类使用。

原生插件位于:

ohos/src/main/ets/components/plugin/DeviceAccessibilityInfoPlugin.ets
5.1.1 引入 Flutter 和 HarmonyOS 能力
import {
  EventChannel,
  EventSink,
  FlutterPlugin,
  FlutterPluginBinding,
  MethodCall,
  MethodCallHandler,
  MethodChannel,
  MethodResult,
} from '@ohos/flutter_ohos';
import { accessibility } from '@kit.AccessibilityKit';
import { BusinessError, deviceInfo } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

FlutterPlugin 负责接入 Flutter Engine 生命周期,MethodChannel 接收 Dart 命令;系统能力由 AccessibilityKit accessibility 提供。错误和事件处理以对应方法实现为准。

5.1.2 连接 Flutter Engine
private channel: MethodChannel | null = null;
private eventChannel: EventChannel | null = null;
private eventSink: EventSink | null = null;
private isListening: boolean = false;
private readonly accessibilityStateCallback = (_isEnabled: boolean): void => {
  try {
    this.eventSink?.success(this.readScreenReaderStatus());
  } catch (error) {
    const businessError = error as BusinessError;
    hilog.error(0, TAG, `Failed to refresh screen reader status: ${businessError.code} ${businessError.message}`);
  }
};


onAttachedToEngine(binding: FlutterPluginBinding): void {
  const messenger = binding.getBinaryMessenger();
  this.channel = new MethodChannel(messenger, METHOD_CHANNEL_NAME);
  this.channel.setMethodCallHandler(this);

  this.eventChannel = new EventChannel(messenger, EVENT_CHANNEL_NAME);
  this.eventChannel.setStreamHandler({
    onListen: (_arguments: Object, events: EventSink): void => {
      this.eventSink = events;
      this.startListening(events);
    },
    onCancel: (_arguments: Object): void => {
      this.stopListening();
      this.eventSink = null;
    },
  });
}

onListen 保存 EventSink 并注册三个系统事件,随后立即发送当前状态;onCancel 停止监听并清空 EventSink。

5.1.3 查询与订阅无障碍状态
private readScreenReaderStatus(): boolean {
  const screenReaderOpen = accessibility.isScreenReaderOpenSync();
  const touchGuideOpen = accessibility.isOpenTouchGuideSync();
  const spokenServices = accessibility.getAccessibilityExtensionListSync('spoken', 'enable');
  const isEnabled = screenReaderOpen || touchGuideOpen || spokenServices.length > 0;
  hilog.info(
    0,
    TAG,
    `Screen reader status: reader=${screenReaderOpen}, touchGuide=${touchGuideOpen}, spokenServices=${spokenServices.length}`,
  );
  return isEnabled;
}

private startListening(events: EventSink): void {
  try {
    if (!this.isListening) {
      accessibility.on('screenReaderStateChange', this.accessibilityStateCallback);
      accessibility.on('touchGuideStateChange', this.accessibilityStateCallback);
      accessibility.on('accessibilityStateChange', this.accessibilityStateCallback);
      this.isListening = true;
    }
    events.success(this.readScreenReaderStatus());
  } catch (error) {
    const businessError = error as BusinessError;
    hilog.error(0, TAG, `Failed to listen for screen reader changes: ${businessError.code} ${businessError.message}`);
    events.error(
      String(businessError.code ?? 'ACCESSIBILITY_ERROR'),
      businessError.message ?? 'Failed to listen for screen reader changes.',
      null,
    );
  }
}

三个系统事件共用回调,每次回调重新读取综合状态。实现未使用 distinct 去重,因此多个系统事件可能产生相同布尔值。

5.1.4 取消系统监听
private stopListening(): void {
  if (!this.isListening) {
    return;
  }
  try {
    accessibility.off('screenReaderStateChange', this.accessibilityStateCallback);
    accessibility.off('touchGuideStateChange', this.accessibilityStateCallback);
    accessibility.off('accessibilityStateChange', this.accessibilityStateCallback);
  } catch (error) {
    const businessError = error as BusinessError;
    hilog.warn(0, TAG, `Failed to stop screen reader listener: ${businessError.code} ${businessError.message}`);
  } finally {
    this.isListening = false;
  }
}

取消时使用原回调解除三种事件,并清空监听标记。注册过程有多步调用,异常路径仍需在目标系统验证,不能由 isListening 标记推断注册一定是原子的。

5.1.5 处理 MethodChannel 命令
onMethodCall(call: MethodCall, result: MethodResult): void {
  switch (call.method) {
    case 'getPlatformVersion':
      result.success(deviceInfo.osFullName);
      break;
    case 'isScreenReaderEnabled':
      this.queryScreenReaderStatus(result);
      break;
    default:
      result.notImplemented();
      break;
  }
}

查询异常通过 queryScreenReaderStatus 返回原生错误码或 ACCESSIBILITY_ERROR;首次监听失败走事件流错误。变化回调中的重新查询失败只写日志,不会伪造一个 false 事件。

5.1.6 Engine 解绑时释放资源
onDetachedFromEngine(_binding: FlutterPluginBinding): void {
  this.stopListening();
  this.eventSink = null;
  this.channel?.setMethodCallHandler(null);
  this.channel = null;
  this.eventChannel?.setStreamHandler(null);
  this.eventChannel = null;
}

Engine 解绑也调用 stopListening,清理方法通道、事件通道和 EventSink。

5.2 声明插件和宿主权限

查询和监听无障碍状态不需要新增权限,也不需要把本应用注册为无障碍扩展。

5.2.1 插件 HAR 的权限

插件 ohos/src/main/module.json5 的模块配置如下:

{
  "module": {
    "name": "device_accessibility_info",
    "type": "har",
    "deviceTypes": [
      "default",
      "tablet"
    ]
  }
}
5.2.2 应用 entry 的权限

最终安装的是宿主应用。以下片段来自 example/ohos/entry/src/main/module.json5,合并时保留原有 Ability 等配置:

{
  "module": {
    "requestPermissions": []
  }
}

权限声明与运行时授权需要分别处理;没有权限需求的功能不要套用其他插件的授权流程。

5.3 注册并导出插件

pubspec.yaml 通过以下配置声明 OHOS 插件类:

flutter:
  plugin:
    platforms:
      ohos:
        pluginClass: DeviceAccessibilityInfoPlugin

插件的 ohos/index.ets 需要导出实现:

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

执行 flutter pub get 和构建后,Flutter 工具会为应用生成插件注册代码。通常不应手工编辑 GeneratedPluginRegistrant.ets,因为下次构建可能覆盖它。

注册异常的排查步骤见第九节 MissingPluginException

5.4 检查 example 的 OHOS 应用结构

本例的 example/ohos/build-profile.json5 应在 products 中设置版本。下面是需核对的配置片段,请合并到现有工程;其中 signingConfig: "default" 需要与本机配置的签名名称一致,签名材料保留在本地。

{
  "app": {
    "products": [
      {
        "name": "default",
        "signingConfig": "default",
        "compatibleSdkVersion": "5.1.0(18)",
        "runtimeOS": "HarmonyOS",
        "compileSdkVersion": "26.0.0",
        "targetSdkVersion": "26.0.0"
      }
    ]
  },
  "modules": [
    {
      "name": "entry",
      "srcPath": "./entry",
      "targets": [
        {
          "name": "default",
          "applyToProducts": [
            "default"
          ]
        }
      ]
    }
  ]
}

配置后,在 DevEco Studio 中执行一次 Sync Project。如果 entry 模块正常识别,Project 视图中会出现 entry,并能打开 entry 模块的签名配置。


六、补全交付文件并提交适配分支

6.1 除代码外还要补全哪些文件

代码适配完成后,还需要整理安装说明、接口文档、版本记录和开源信息。接收仓库有专用模板时,按其格式填写:

文件应写清楚的内容
README.OpenSource上游名称、源码地址、适配版本或提交、版权及许可证信息;按仓库模板列出第三方依赖
README.md原项目说明、OHOS 支持入口、配套 Demo 和文档链接;保留上游信息
README.OpenHarmony_CN.md简介、AtomGit 安装方式、版本对应关系、环境约束、权限、接口表、示例、已验证范围和遗留问题
README.OpenHarmony.md与中文说明对应的英文文档
CHANGELOG.OpenHarmony.mdOHOS 新增能力、适配版本、兼容限制与测试范围
LICENSE / NOTICE保留上游许可证;NOTICE 按许可证和原项目要求保留或补充
example/README.md依赖方式、运行目录、签名、操作步骤与效果图;覆盖状态查询、首次事件、开启与关闭、取消监听
pubspec.yamlohos/oh-package.json5核对包名、版本、插件注册、仓库地址、许可证和依赖
.gitignore忽略构建缓存及本机签名材料,不漏提交必要源码和配置

README.OpenSource 记录库本身的来源与版本。本例的包名为 device_accessibility_info,版本为 1.0.0,采用 MIT 许可证;Flutter 和 HarmonyOS SDK 版本写入环境说明。

现有说明文件以目录树为准。README.OpenSource 等缺失交付文件按接收仓库要求补全;安装与反馈链接统一替换为本文预定的 AtomGit 地址,并在仓库创建、适配代码同步后核对。

6.2 提交前检查

提交前先完成第八节的插件、example 和真机测试,再从根目录检查改动:

git branch --show-current
git diff --check
git status --short
git diff --stat
git diff

检查 diff 中的接口、平台注册和依赖变化,移除本机路径及签名信息,并使文档中的版本和分支与提交内容一致。

6.3 提交并推送到 AtomGit

文档和代码整理完成后,在 Git 仓库根目录暂存并提交。以下命令以第 6.1 节文档已经补全为前提,文件名按项目实际情况调整:

git add lib ohos pubspec.yaml example test
git add README.md README.OpenSource README.OpenHarmony_CN.md
git add README.OpenHarmony.md CHANGELOG.OpenHarmony.md
git diff --cached --check
git diff --cached --stat
git diff --cached
git commit -m "feat: add OHOS support for device_accessibility_info 1.0.0"
git remote -v
git branch --show-current
git push -u origin feat/ohos_device_accessibility_info_1.0.0

DevEco 可能向 example/ohos/build-profile.json5 写入本机签名配置,需要在提交前从暂存内容中移除。推送时,origin 应指向自己的 AtomGit 仓库,当前分支为 feat/ohos_device_accessibility_info_1.0.0

推送后在 AtomGit 发起合并请求,说明上游来源和版本、OHOS 实现范围、依赖及权限、测试环境、操作结果、已知限制,并附 Demo 运行图。目标分支和评审流程以接收仓库要求为准。


七、使用根目录 example 演示接入

插件包自带 example/,可以直接用来调试插件和体验屏幕朗读状态查询与监听。

7.1 本地适配时使用路径依赖

当前 example/pubspec.yaml 的依赖是:

dependencies:
  flutter:
    sdk: flutter
  device_accessibility_info:
    path: ../

../ 相对于 example/pubspec.yaml 指向插件根目录,修改根目录插件后可直接联调。

7.2 通过 AtomGit 引入插件

业务应用通过 AtomGit 引入时,将 device_accessibility_infopath 配置替换为下面的 Git 依赖。仓库同步后,可固定到本文的本地参考提交:

dependencies:
  flutter:
    sdk: flutter
  device_accessibility_info:
    git:
      url: https://atomgit.com/oh-flutter/device_accessibility_info.git
      ref: 086bfc383fed4d842bc2be294d5aac8ede495cda

使用自己的适配版本时,先推送分支,再将 url 改为对应仓库,ref 改为 feat/ohos_device_accessibility_info_1.0.0。正式发布后可固定到 tag 或 commit。

从插件根目录执行:

cd example
flutter pub get
flutter pub deps

检查 example/pubspec.lockdevice_accessibility_info 的来源为 git,并核对 urlrefresolved-ref。同时检查没有 dependency_overridespubspec_overrides.yaml 将其覆盖回本地依赖,确认应用使用的是 Git 依赖。

7.3 调用接口实现屏幕朗读状态查询与监听

下面的页面可用于插件包内的 example/lib/main.dart,是便于讲解的最小页面;仓库完整 Demo 的入口和布局可能不同,第八节截图与验收步骤以仓库完整 Demo 为准。

import 'dart:async';
import 'package:flutter/material.dart';
import 'package:device_accessibility_info/device_accessibility_info.dart';


void main() {
  runApp(const MaterialApp(home: DemoPage()));
}

class DemoPage extends StatefulWidget {
  const DemoPage({super.key});
  
  State<DemoPage> createState() => _DemoPageState();
}

class _DemoPageState extends State<DemoPage> {
  String _status = '尚未操作';
  bool _busy = false;
  final _plugin = DeviceAccessibilityInfo();
  StreamSubscription<bool>? _subscription;

  
  void initState() {
    super.initState();
    _subscription = _plugin.screenReaderStatusChanged.listen(
      (value) => _show(value ? '已开启' : '未开启'),
      onError: (Object error) => _show('监听失败:$error'),
    );
  }

  void _show(String value) {
    if (mounted) setState(() => _status = value);
  }

  Future<void> _run(Future<String> Function() action) async {
    if (_busy) return;
    setState(() => _busy = true);
    try {
      _show(await action());
    } catch (error) {
      _show('调用失败:$error');
    } finally {
      if (mounted) setState(() => _busy = false);
    }
  }

  
  void dispose() {
    unawaited(_subscription?.cancel());
    super.dispose();
  }

  
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('无障碍读屏状态')),
      body: ListView(
        padding: const EdgeInsets.all(16),
        children: [
          Text(_status),
          const SizedBox(height: 16),
            FilledButton(onPressed: _busy ? null : () => _run(() async {
              final enabled = await _plugin.isScreenReaderEnabled();
              return enabled ? '已开启' : '未开启';
            }), child: const Text('刷新状态')),

        ],
      ),
    );
  }
}

7.4 页面退出时取消状态监听

异步回调先检查 mounted,避免页面销毁后继续调用 setStatedispose 中取消 StreamSubscription,再调用 super.dispose()。多个页面可共享广播流,但各页面应管理自己的订阅;重复布尔值不一定代表重复注册。


八、验证、构建与鸿蒙设备运行效果

8.1 分别验证插件与 example

从插件仓库根目录执行:

flutter pub get
flutter analyze
flutter test
cd example
flutter pub get
flutter analyze
flutter test

现有测试覆盖默认平台实例、平台版本、状态查询和事件流;example 包含中文页面 Widget 测试及集成测试入口。测试 mock 的布尔事件不能替代系统开关切换。Widget 测试应匹配实际保留的 Demo 页面;如果替换成第七节最小页面,也要相应调整原来的 UI 断言。

Dart 测试覆盖接口和页面逻辑,状态查询、首次事件、开启与关闭、取消监听还需要在鸿蒙设备上验证。以上为 Dart 测试复现命令,本次未重新执行这些测试;本次已重新构建、安装并运行签名 Release HAP,具体真机采集范围见 8.5。

8.2 确认设备连接

hdc list targets
flutter devices

设备首次连接电脑时,需要在手机端确认调试授权。列表为空时,检查 USB 连接、调试模式和电脑授权。

8.3 配置签名

真机安装的 HAP 通常需要有效签名。推荐使用 DevEco Studio 为 entry 模块配置自动签名:

  1. 用 DevEco Studio 打开 example/ohos,不是仓库根目录;
  2. 等待工程 Sync 成功,确认 Project 视图中存在 entry 模块;
  3. 打开 File > Project Structure > Signing Configs
  4. default product 选择或生成签名;
  5. 确认设备、应用包名、证书和 Profile 匹配;
  6. 再回到终端执行 Flutter 构建或运行。

签名材料保存在本机,公开仓库中只保留构建所需的通用配置。

8.4 运行示例

以下命令在 example/ 目录执行,将 <device-id> 替换为设备列表中的实际 ID:

flutter run -d <device-id>

也可以先构建 HAP:

flutter build hap --debug

典型产物位于:

example/ohos/entry/build/default/outputs/default/

目录中通常包含已签名和未签名 HAP。真机安装应选择与当前设备匹配的已签名产物。

本次真机截图使用签名 Release HAP。在插件包的 example/ 目录完成签名配置后执行:

flutter build hap --release
hdc -t <device-id> install -r build/ohos/hap/entry-default-signed.hap
hdc -t <device-id> shell aa start -a EntryAbility -b com.example.deviceaccessibilityinfo

8.5 在设备上测试屏幕朗读状态查询与监听

  1. 运行完整 Demo,确认标题为“无障碍读屏状态”,等待当前平台和屏幕朗读状态读取完成。
  2. 在系统设置关闭读屏,回到应用点击“刷新状态”,记录结果。
  3. 在系统设置开启读屏,返回应用,观察是否更新为“已开启”。
  4. 再次关闭读屏,检查自动事件更新与手动刷新是否一致。
  5. 取消页面订阅或销毁页面,重新进入后检查没有重复创建的页面监听。
  6. 分别测试首次查询失败、事件错误及连续切换;对照原生日志判断综合状态。

页面初始提示来自 Demo 默认值,调用结果或事件到达后才反映系统状态。上述列表为完整验收步骤,本次实际采集范围如下。

8.6 鸿蒙设备运行效果

OHOS 实现提供屏幕朗读状态查询与监听。以下为仓库完整 Demo 的三张真机运行截图,按实际状态记录。

device_accessibility_info 鸿蒙真机:未开启 device_accessibility_info 鸿蒙真机:已开启 device_accessibility_info 鸿蒙真机:关闭后刷新

真机运行图(从左到右):未开启/已开启/关闭后刷新。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。

截图标注:操作步骤与截图命令

执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。

mkdir -p blog-assets/device_accessibility_info

未开启: 关闭系统屏幕朗读,返回 Demo 点击“刷新状态”。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-disabled.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-disabled.jpeg ./blog-assets/device_accessibility_info/disabled.jpeg

已开启: 在“设置 → 关怀和无障碍 → 屏幕朗读”开启功能后回到 Demo,等待状态更新。绿色焦点框和底部提示是系统读屏界面。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-enabled.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-enabled.jpeg ./blog-assets/device_accessibility_info/enabled.jpeg

关闭后刷新: 关闭屏幕朗读后回到 Demo,点击“刷新状态”,保留平台版本与最新状态。

hdc -t <device-id> shell snapshot_display -f /data/local/tmp/device_accessibility_info-disabled-refreshed.jpeg
hdc -t <device-id> file recv /data/local/tmp/device_accessibility_info-disabled-refreshed.jpeg ./blog-assets/device_accessibility_info/disabled-refreshed.jpeg
未开启已开启关闭后刷新
屏幕朗读:未开启屏幕朗读:已开启关闭后的实际结果

是否收到状态变化取决于系统和无障碍扩展的事件支持。OHOS 使用三个条件的逻辑或判断,不等同于只检查某一个读屏开关。


九、FAQ:适配过程与使用问题

9.1 Missing SDK components

典型错误如下:

Missing SDK components. SDK path: ...,
missing components: toolchains,ets,js,native,previewer.

这个错误发生在 Hvigor 同步阶段。通常需要检查构建工具使用的 SDK 路径、组件是否完整,以及 Hvigor 与 SDK 的版本是否匹配。

处理顺序:

  1. 在 DevEco Studio SDK Manager 中确认 API 26 组件已经下载完整;
  2. 检查 Flutter 和 DevEco Studio 使用的 SDK 路径是否一致;
  3. 避免误用 /Applications/DevEco-Studio.app/Contents/sdk 之类的不完整目录;
  4. 确认 SDK 根目录下存在 toolchainsetsjsnativepreviewer
  5. 执行 flutter config --ohos-sdk <正确路径>
  6. 重新执行 flutter doctor -v 和 DevEco Studio Sync。
为什么连接 API 24 手机仍然会报这个错误?

因为 Sync 和 Compile 首先读取 Mac 本地 SDK。手机 API 版本只在部署、安装和运行时参与兼容判断。即使完全不连接手机,本地 SDK 不完整时也会得到相同错误。

当前工程的 compatibleSdkVersion 是 API 18,因此 API 24 在安装版本门槛上是满足的;但功能是否可用还取决于目标系统能力、权限和运行环境,不能仅凭最低版本判断。

9.2 DevEco Studio 中看不到 entry 模块

插件的 ohos/ 目录是 HAR 模块,可安装应用的 entry 模块位于 example/ohos/entry

请直接使用 DevEco Studio 打开:

device_accessibility_info/example/ohos

如果仍看不到 entry,先解决 SDK Sync 错误,再检查 example/ohos/build-profile.json5modules 是否包含 ./entry。同步失败时,Project Structure 无法正确解析模块,签名界面也可能不显示 entry。

9.3 无法手动签名

签名配置依附于可构建的应用模块和 product。只有 HAR 插件模块、工程 Sync 失败,或者打开了错误目录时,DevEco Studio 都可能无法提供 entry 签名入口。

建议先确认:

  • 打开的是 example/ohos
  • SDK 组件完整并且 Sync 成功;
  • entry 的模块类型为 entry
  • default product 和 target 已正确关联;
  • 当前账号、证书和调试设备状态有效。

9.4 开关变化后页面没有更新

先看手动查询是否成功,再检查事件订阅和 hilog。实现同时读取读屏、触摸浏览、已启用语音扩展;一个开关关闭时,其他条件仍可能使结果为 true。系统扩展不触发事件时可以手动刷新。

9.5 MissingPluginException

这通常表示 Dart 通道找不到已注册的原生插件。新增原生插件后需要重新构建应用。从仓库根目录执行:

cd example
flutter clean
flutter pub get
flutter run -d <device-id>

如果仍然出现,检查自动生成的插件注册文件中是否包含 DeviceAccessibilityInfoPlugin,同时核对 pubspec.yamlohos/index.etsoh-package.json5

9.6 为什么重复收到相同的 bool

三种系统事件都会重新查询综合结果,当前事件流没有 distinct。相同值可以来自不同系统事件。先检查页面订阅数量,再决定业务层是否需要 distinct,不要把重复值直接当成重复注册。

9.7 编译成功但安装失败

常见原因包括:

  • HAP 未签名或使用了错误的 Profile;
  • 设备未加入调试设备列表;
  • 包名与签名 Profile 不匹配;
  • 安装包的 compatibleSdkVersion 高于设备 API;
  • 手机上已经安装了使用不同证书签名的同包名应用。

根据安装错误码区分签名、版本和包名冲突,再处理对应配置。

9.8 flutter create 不认识 ohos,或包名不合法

先执行 flutter --version,确认使用的是 OHOS 版工具链,环境配置回到第二节的社区链接核对。包名报错时,确认当前目录包含目标插件的 pubspec.yaml,并显式传入 --project-name device_accessibility_info;本例仓库名和 Dart 包名均为 device_accessibility_info。生成后检查 diff,再补充 ArkTS 业务实现。

9.9 AtomGit 依赖提示找不到分支或无权限

先检查 URL 是否指向已同步的目标仓库,再确认 feat/ohos_device_accessibility_info_1.0.0 已推送。仓库未创建、适配分支未推送或提交未同步时,应先完成同步;不能直接使用仅存在本地的提交号。私有仓库还需在本机配置 Git 认证。

9.10 改了本地 ArkTS,Demo 为什么没变化

先检查 example/pubspec.yaml:Git 依赖读取远程提交,不会自动读取本地插件改动。本地联调切回 path: ../;测试远程版本则先提交推送,再更新依赖并核对 pubspec.lockresolved-ref。原生代码变动后停止应用并重新构建运行,不能只做 Dart 热重载。

9.11 读屏开关关闭了,结果为什么仍然为 true

isScreenReaderOpenSync()isOpenTouchGuideSync() 和启用的 spoken 扩展只要任一成立,就返回 true。该行为用于兼容不同无障碍服务,应结合系统设置和日志中的三个原始值判断。


相关链接

Logo

开源鸿蒙跨平台开发社区汇聚开发者与厂商,共建“一次开发,多端部署”的开源生态,致力于降低跨端开发门槛,推动万物智联创新。

更多推荐