HarmonyOS开发： ArkTS工具库-@arkts.utils

本模块提供了各种ArkTS实用工具函数。

本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { ArkTSUtils } from '@kit.ArkTS'

ArkTSUtils.locks

为了解决多并发实例间的数据竞争问题，ArkTS语言基础库引入了异步锁能力。为了开发者的开发效率，AsyncLock对象支持跨并发实例引用传递。

由于ArkTS语言支持异步操作，阻塞锁容易产生死锁问题，因此我们在ArkTS中仅支持异步锁（非阻塞式锁）。

使用异步锁的方法需要标记为async，调用方需要await修饰调用，才能保证时序正确。因此会导致外层调用函数全部标记成async。

AsyncLockCallback

type AsyncLockCallback<T> = () => T | Promise<T>

这是一个补充类型别名，表示lockAsync函数所有重载中的回调。

元服务API：从API version 12 开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Utils.Lang

AsyncLock

实现异步锁功能的类，允许在锁下执行异步操作。

属性

元服务API：从API version 12 开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Utils.Lang

名称	类型	可读	可写	说明
name	string	是	否	锁的名称。

示例：

// 示例一：
@Sendable
class A {
  count_: number = 0;
  async getCount(): Promise<number> {
    let lock: ArkTSUtils.locks.AsyncLock = ArkTSUtils.locks.AsyncLock.request("lock_1");
    return lock.lockAsync(() => {
      return this.count_;
    })
  }
  async setCount(count: number) {
    let lock: ArkTSUtils.locks.AsyncLock = ArkTSUtils.locks.AsyncLock.request("lock_1");
    await lock.lockAsync(() => {
      this.count_ = count;
    })
  }
}

// 示例二：
@Sendable
class A {
  count_: number = 0;
  lock_: ArkTSUtils.locks.AsyncLock = new ArkTSUtils.locks.AsyncLock();
  async getCount(): Promise<number> {
    return this.lock_.lockAsync(() => {
      return this.count_;
    })
  }
  async setCount(count: number) {
    await this.lock_.lockAsync(() => {
      this.count_ = count;
    })
  }
}

@Concurrent
async function foo(a: A) {
  await a.setCount(10)
}

constructor

constructor()

默认构造函数。创建一个异步锁。

元服务API：从API version 12 开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Utils.Lang

返回值：

类型	说明
AsyncLock	创建的异步锁实例。

示例：

let lock = new ArkTSUtils.locks.AsyncLock();

request

static request(name: string): AsyncLock

使用指定的名称查找或创建（如果未找到）异步锁实例。

元服务API：从API version 12 开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

名称	类型	必填	说明
name	string	是	按指定名称查找或创建异步锁实例。

返回值：

类型	说明
AsyncLock	返回查找到或创建后的异步锁实例。

示例：

let lockName = 'isAvailableLock';
let lock = ArkTSUtils.locks.AsyncLock.request(lockName);

query

static query(name: string): AsyncLockState

查询指定异步锁的信息。

元服务API：从API version 12 开始，该接口支持在元服务中使用。

系统能力： SystemCapability.Utils.Lang

参数：

名称	类型	必填	说明
name	string	是	锁的名称。

返回值：

类型	说明
AsyncLockState	一个包含状态描述的异步锁状态实例。