鸿蒙Accessibility Kit无障碍服务开发指南（一）

鸿蒙Accessibility Kit无障碍服务开发指南（一）

---

---

前言

无障碍模式是指任何人在任何情况下都能平等、方便地获取信息并利用信息。其目的是缩小全社会不同阶层、不同地区、不同年龄、不同健康状况的人群在信息理解、信息交互、信息利用方面的数字鸿沟，使其更加方便地参与社会生活，享受数字发展带来的便利。（无障碍开发服务）提供扩展服务的开放能力，三方可基于此开放能力开发出类似读屏软件的扩展服务，同时也为三方应用提供开放能力，使三方应用可以更好的适配扩展服务，以更好的服务于障碍人群和障碍场景。

一、无障碍框架原理

---

无障碍扩展服务框架提供在三方应用和和扩展服务之间交换信息的标准机制。扩展服务通过AAkit向AAMS发出查询或操作请求，AAMS通过ASACkit向三方应用执行查询或操作请求，并将执行结果返回给扩展服务。
官方示意图

1、Accessibility App：基于无障碍扩展服务框架开发的扩展服务，如视障用户使用的读屏App。
2、Target App：被Accessibility App辅助的三方应用。
3、AccessibilityAbilityManagerService（AAMS）：无障碍扩展服务框架主服务，用于对Accessibility App生命周期进行管理，同时为Accessibility App和Target App提供信息交互的桥梁。
4、AccessibilityAbility（AAkit）：Accessibility App利用AAkit构建扩展服务Ability运行环境，并为Accessibility App提供可查询和操作Target App的接口，如查询节点信息、对节点执行点击/长按操作等。
5、AccessibilitySystemAbilityClient（ASACkit）：Target App通过ASACkit向AAMS发送无障碍事件，如内容变化事件等，同时响应Accessibility App通过AAMS请求的指令，如查询节点信息、对节点执行点击/长按操作等。

原理大致了解一下就好了，内部源码也没必要深究，我们只需要知道，即使无障碍服务是在我们Hap应用里面配置的，但实际上运行程序后，无障碍服务和我们的应用也属于两个进程，所以在涉及到通信方面还需要了解跨进程通信的知识

二、使用步骤

1.继承AccessibilityExtensionAbility

---

代码如下（示例）：

class AccessibilityExtAbility extends AccessibilityExtensionAbility {
  onConnect() {
    console.info(`AccessibilityExtAbility onConnect`);
    // 执行初始化业务逻辑的操作
    console.error("accessibility start");
  }

  onDisconnect() {
    console.info(`AccessibilityExtAbility onDisconnect`);
    // 执行资源回收退出业务逻辑的操作
  }

  onAccessibilityEvent(accessibilityEvent: AccessibilityEvent) {
    console.info(`AccessibilityExtAbility onAccessibilityEvent: ${accessibilityEvent.eventType}`);
    // 根据事件信息进行业务逻辑处理
  }
}
export default AccessibilityExtAbility;

AccessibilityExtensionAbility是官方提供的类库，我们只需要自己实现一个类继承一下就行，同时重写它的三个方法。
onConnect：无障碍服务连接时回调 。
onDisconnect：无障碍服务断开时回调。
onAccessibilityEvent：无障碍事件发生时回调，我们可以使用方法里的accessibilityEvent参数获取发生无障碍事件的类型、手势事件和发生事件的组件。

2.配置无障碍服务

---

在完成自定义无障碍扩展服务的逻辑开发后，还需要在工程中Module对应的module.json5文件中加入新增扩展服务的配置信息。

srcEntry标签为extensionAbility对应的路径。

label标签为extensionAbility在已安装扩展服务列表中显示的名称。

description标签为extensionAbility在已安装扩展服务详情页的帮助信息。

type标签要按照与无障碍子系统的约定进行配置，需要注意的是该值固定为accessibility，否则将无法正常连接。

代码如下（示例）：

 "extensionAbilities": [
      {
        "name": "AccessibilityExtAbility",
        "srcEntry": "./ets/AccessibilityExtAbility/AccessibilityExtAbility.ets",
        "label": "$string:MainAbility_label",
        "description": "$string:MainAbility_desc",
        "type": "accessibility",
        "metadata": [
          {
            "name": "ohos.accessibleability",
            "resource": "$profile:accessibility_config"
          }
        ]
      }
    ]

另外，配置信息中的accessibility_config为无障碍扩展服务的具体配置，需要在resources/base/profile/下新建accessibility_config.json文件，在该文件中声明此无障碍扩展服务具备的能力类型，根据业务功能合理声明能力类型

代码如下（示例）：

{
  "accessibilityCapabilities": [
    "retrieve",
    "gesture",
    "keyEventObserver"
  ]
}

3.开启无障碍服务

---

在应用启动后，可以在当前提供设备-设置中的扩展服务管理页的开关按钮来开启/关闭选择的无障碍扩展服务：

1、打开设备设置页面，进入“辅助功能”，“扩展服务”小标题下的“已安装的服务”显示当前安装的扩展服务个数，点击进入，展示安装的扩展服务列表；未安装扩展服务时，“已安装的扩展服务”不可点击，并显示“无服务”。

2、选择需要开启/关闭的扩展服务，通过开关按钮进行扩展服务的开启/关闭。

3、开启时，弹出安全提醒，在倒计时结束后，勾选“我已知晓如上风险，并自愿承担可能导致的后果。”后，可选择“开启”/“不开启”按钮； 关闭时，将开启的开关关闭，即可关闭已开启的扩展服务。

或者在运行时，需要用到无障碍服务可以使用代码判断无障碍服务是否开启并跳转到引导界面。

判断无障碍服务是否开启，思路，判断当前应用进程数是否大于1
代码如下：

 try {
      const data = await appManager.getRunningProcessInformation();
      return data.length > 1
    } catch (err) {
      console.error(`error: ${JSON.stringify(err)}`);
      return false;
    }

跳转到设置无障碍服务界面
代码如下（示例）：

 Button('打开无障碍服务', { type: ButtonType.Normal, stateEffect: true })
        .borderRadius(8)
        .width(150)
        .height(50)
        .margin({ top: 20 })
        .linearGradient({
          direction: GradientDirection.Bottom,
          angle: 90,
          colors: [[0x8a00f6, 0.0], [0x5200e9, 0.5]]
        })
        .onClick(() => {
          let want: Want = {
            bundleName: `com.huawei.hmos.settings`,
            abilityName: `com.huawei.hmos.settings.MainAbility`,
            uri: 'accessibility_feature',
          };
          Global.uiAbilityContext.startAbility(want)
        })

4.管理无障碍服务上下文

官方建议我们创建一个AccessibilityManager.ets文件，单独用来管理无障碍服务的上下文
代码如下（示例）：

import {
  AccessibilityElement,
  AccessibilityEvent,
  AccessibilityExtensionContext,
  ElementAttributeKeys
} from '@kit.AccessibilityKit';

interface Rect {
  left: number,
  top: number,
  width: number,
  height: number,
}

// 想要查询的属性信息
let wantedAttribute: ElementAttributeKeys[] = ['bundleName', 'text', 'description', 'windowId'];
type attributeValues = string | number | boolean | AccessibilityElement | AccessibilityElement[] | string[] | Rect;

export default class AccessibilityManager {
  private static instance: AccessibilityManager;
  accessibleContext?: AccessibilityExtensionContext;
  currentPageElementArray: Array<AccessibilityElement> | null = null;

  static getInstance(): AccessibilityManager {
    if (!AccessibilityManager.instance) {
      AccessibilityManager.instance = new AccessibilityManager();
    }
    return AccessibilityManager.instance;
  }

  onStart(context: AccessibilityExtensionContext) {
    console.info(`AccessibilityManager onStart`);
    this.accessibleContext = context;
  }

  onStop() {
    console.info(`AccessibilityManager onStop`);
    this.accessibleContext = undefined;
  }

  onEvent(accessibilityEvent: AccessibilityEvent): void {
    console.info(`AccessibilityManager onEvent`);
    switch (accessibilityEvent.eventType) {
      case 'rightThenDown':
      // 获取当前页面的所有节点
        this.getCurrentPageAllElement();
        break;
      case 'leftThenDown':
      // 打印所有节点
        this.printAllElementInfo();
        break;
      default:
        break;
    }
  }
 }

我们可以在无障碍服务的Ability里面的onConnect方法回调时调用该管理类的start方法绑定上下文，同理在断开连接时释放，当拿到该上下文后我们就可以使用该上下文获取窗口根节点等信息。