ArkTS容器集

ArkTS共享容器([@arkts.collections (ArkTS容器集)])是一种在并发任务间共享传输的容器类,可以用于并发场景下的高性能数据传递。功能与Ecmascript262规范定义的容器类似,但仍然有部分差异。

ArkTS共享容器在多个并发任务间传递时,其默认行为是引用传递,支持多个并发任务可以操作同一个容器实例。另外,也支持拷贝传递,即每个并发任务持有一个ArkTS容器实例。

ArkTS共享容器并不是线程安全的,内部使用了fail-fast(快速失败)机制,即当检测多个并发实例同时对容器进行结构性改变时,会触发异常。因此,在容器内修改属性的场景下,开发者需要使用ArkTS提供的[异步锁]机制保证ArkTS容器的安全访问。

ArkTS共享容器包含如下几种:[Array]、[Map]、[Set]、[TypedArray](Int8Array、Uint8Array、Int16Array、Uint16Array、Int32Array、Uint32Array、Uint8ClampedArray、Float32Array)、[ArrayBuffer]等。

容器集使用示例如下:

import { ArkTSUtils, collections, taskpool } from '@kit.ArkTS';

@Concurrent
async function add(arr: collections.Array<number>, lock: ArkTSUtils.locks.AsyncLock) {
 await lock.lockAsync(() => {  // 如果不添加异步锁,任务会因为数据竞争冲突,导致抛异常失败
   arr[0]++;
 })
}

@Entry
@Component
struct Index {
  @State message: string = 'Hello World';

  build() {
    RelativeContainer() {
      Text(this.message)
        .id('HelloWorld')
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .alignRules({
          center: { anchor: '__container__', align: VerticalAlign.Center },
          middle: { anchor: '__container__', align: HorizontalAlign.Center }
        })
        .onClick(() => {
          let taskGroup = new taskpool.TaskGroup();
          let lock = new ArkTSUtils.locks.AsyncLock();
          let arr = collections.Array.create<number>(1, 0);
          let count = 1000;
          while (count--) {
            taskGroup.addTask(add, arr, lock);
          }
          taskpool.execute(taskGroup).then(() => {
            console.info(`Return success: ${arr[0]} === ${count}`);
          }).catch((e: Error) => {
            console.error("Return error.");
          })
        })
    }
    .height('100%')
    .width('100%')
  }
}

共享容器与原生API方法的行为差异对比

ArkTS提供了Sendable数据相关的共享容器集,接口行为与原生API存在部分差异,具体可见下文对比。

说明:

ArkTS共享容器的类型与Ecmascript262规范定义的原生容器的类型不一致,因此采用原生容器Array的isArray()方法判断collections.Array实例对象会返回false。

Array

支持原生容器Array通过[collections.Array.from]方法转换为ArkTS Array容器;支持通过原生容器Array的from方法将ArkTS Array容器转换为原生容器Array。

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
length: number readonly length: number 为了防止undefined扩散,不允许设置length。
new(arrayLength ?: number): any[] static create(arrayLength: number, initialValue: T): Array 为了防止undefined扩散,构造函数中必须提供一个初始值的构造函数。
new (arrayLength: number): T[] constructor() /
new (…items: T[]): T[] constructor(first: T, …left: T[]) 为了防止undefined扩散,构造函数中必须提供一个初始值的构造函数,继承场景下,无法调用该函数进行对象构造。
from(arrayLike: ArrayLike): T[] static from(arrayLike: ArrayLike): Array /
pop(): T undefined pop(): T undefined
push(…items: T[]): number push(…items: T[]): number 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
concat(…items: ConcatArray[]): T[] concat(…items: ConcatArray[]): Array 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
concat(…items: (T ConcatArray)[]): T[] concat(…items: ConcatArray[]): Array
join(separator?: string): string join(separator?: string): string /
shift(): T undefined shift(): T undefined
slice(start?: number, end?: number): T[] slice(start?: number, end?: number): Array /
sort(compareFn?: (a: T, b: T) => number): this sort(compareFn?: (a: T, b: T) => number): Array 1. 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。 2. 继承场景下,无法获得实际类型的返回值。
unshift(…items: T[]): number unshift(…items: T[]): number 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
indexOf(searchElement: T, fromIndex?: number): number indexOf(searchElement: T, fromIndex?: number): number /
forEach(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any): void forEach(callbackFn: (value: T, index: number, array: Array) => void): void ArkTS不支持this,因此不支持thisArg参数。
map(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[] map(callbackFn: (value: T, index: number, array: Array) => U): Array ArkTS不支持this,因此不支持thisArg参数。
filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[] filter(predicate: (value: T, index: number, array: Array) => boolean): Array ArkTS不支持this,因此不支持thisArg参数。
reduce(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T reduce(callbackFn: (previousValue: T, currentValue: T, currentIndex: number, array: Array) => T): T /
reduce(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U reduce(callbackFn: (previousValue: U, currentValue: T, currentIndex: number, array: Array) => U, initialValue: U): U /
[n: number]: T [index: number]: T 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
findIndex(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): number findIndex(predicate: (value: T, index: number, obj: Array) => boolean): number ArkTS不支持this,因此不支持thisArg参数。
fill(value: T, start?: number, end?: number): this fill(value: T, start?: number, end?: number): Array 1. 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。 2. 继承场景下,无法获得实际类型的返回值。
entries(): IterableIterator<[number, T]> entries(): IterableIterator<[number, T]> /
keys(): IterableIterator keys(): IterableIterator /
values(): IterableIterator values(): IterableIterator /
includes(searchElement: T, fromIndex?: number): boolean includes(searchElement: T, fromIndex?: number): boolean /
at(index: number): T undefined at(index: number): T undefined

ArrayBuffer

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
readonly byteLength: number readonly byteLength: number /
slice(begin: number, end?: number): ArrayBuffer slice(begin: number, end?: number): ArrayBuffer /
new(byteLength: number): ArrayBuffer constructor(byteLength: number) /

TypedArray(以Int8Array为例)

支持原生容器TypedArray通过[collections.TypedArray.from]方法转换为ArkTS TypedArray容器;支持通过原生容器TypedArray的from方法将ArkTS TypedArray容器转换为原生容器TypedArray。

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
readonly buffer: ArrayBufferLike readonly buffer: ArrayBuffer /
readonly byteLength: number readonly byteLength: number /
readonly byteOffset: number readonly byteOffset: number /
readonly length: number readonly length: number /
readonly BYTES_PER_ELEMENT: number static readonly BYTES_PER_ELEMENT: number /
copyWithin(target: number, start: number, end?: number): this copyWithin(target: number, start: number, end?: number): Int8Array 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
every(predicate: (value: number, index: number, array: Int8Array) => unknown, thisArg?: any): boolean every(predicate: TypedArrayPredicateFn<number, Int8Array>): boolean 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
fill(value: number, start?: number, end?: number): this fill(value: number, start?: number, end?: number): Int8Array 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
filter(predicate: (value: number, index: number, array: Int8Array) => any, thisArg?: any): Int8Array filter(predicate: TypedArrayPredicateFn<number, Int8Array>): Int8Array 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
find(predicate: (value: number, index: number, obj: Int8Array) => boolean, thisArg?: any): number undefined find(predicate: TypedArrayPredicateFn<number, Int8Array>): number undefined
findIndex(predicate: (value: number, index: number, obj: Int8Array) => boolean, thisArg?: any): number findIndex(predicate: TypedArrayPredicateFn<number, Int8Array>): number ArkTS不支持this,因此不支持thisArg参数。
forEach(callbackfn: (value: number, index: number, array: Int8Array) => void, thisArg?: any): void forEach(callbackFn: (value: number, index: number, array: Int8Array) => void): void 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
indexOf(searchElement: number, fromIndex?: number): number indexOf(searchElement: number, fromIndex?: number): number /
join(separator?: string): string join(separator?: string): string /
map(callbackfn: (value: number, index: number, array: Int8Array) => number, thisArg?: any): Int8Array map(callbackFn: TypedArrayForEachCallback<number, Int8Array>): Int8Array 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Int8Array) => number): number reduce(callbackFn: TypedArrayReduceCallback<number, number, Int8Array>): number /
reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Int8Array) => number, initialValue: number): number reduce(callbackFn: TypedArrayReduceCallback<number, number, Int8Array>, initialValue: number): number /
reduce(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Int8Array) => U, initialValue: U): U reduce(callbackFn: TypedArrayReduceCallback<U, number, Int8Array>, initialValue: U): U /
reverse(): Int8Array reverse(): Int8Array /
set(array: ArrayLike, offset?: number): void set(array: ArrayLike, offset?: number): void 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
slice(start?: number, end?: number): Int8Array slice(start?: number, end?: number): Int8Array /
some(predicate: (value: number, index: number, array: Int8Array) => unknown, thisArg?: any): boolean some(predicate: TypedArrayPredicateFn<number, Int8Array>): boolean ArkTS不支持this,因此不支持thisArg参数。
sort(compareFn?: (a: number, b: number) => number): this sort(compareFn?: TypedArrayCompareFn): Int8Array 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. 继承场景下,无法获得实际类型的返回值。
subarray(begin?: number, end?: number): Int8Array subarray(begin?: number, end?: number): Int8Array 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
[index: number]: number [index: number]: number 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
entries(): IterableIterator<[number, number]> entries(): IterableIterator<[number, number]> /
keys(): IterableIterator keys(): IterableIterator /
values(): IterableIterator values(): IterableIterator /
includes(searchElement: number, fromIndex?: number): boolean includes(searchElement: number, fromIndex?: number): boolean /
at(index: number): number undefined at(index: number): number undefined
new(length: number): Int8Array constructor(length: number) /
new(array: ArrayLike ArrayBufferLike): Int8Array constructor(array: ArrayLike ArrayBuffer)
new(buffer: ArrayBufferLike, byteOffset?: number, length?: number): Int8Array constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number) /
from(arrayLike: ArrayLike): Int8Array static from(arrayLike: ArrayLike): Int8Array /
from(arrayLike: ArrayLike, mapfn: (v: T, k: number) => number, thisArg?: any): Int8Array static from(arrayLike: ArrayLike, mapFn: TypedArrayFromMapFn<T, number>): Int8Array ArkTS不支持this,因此不支持thisArg参数。
from(arrayLike: Iterable, mapfn?: (v: number, k: number) => number, thisArg?: any): Int8Array static from(arrayLike: Iterable, mapFn?: TypedArrayFromMapFn<number, number>): Int8Array ArkTS不支持this,因此不支持thisArg参数。

Map

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
readonly size: number readonly size: number 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
clear(): void clear(): void 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
delete(key: K): boolean delete(key: K): boolean 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void forEach(callbackFn: (value: V, key: K, map: Map<K, V>) => void): void 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
get(key: K): V undefined get(key: K): V undefined
has(key: K): boolean has(key: K): boolean 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
set(key: K, value: V): this set(key: K, value: V): Map<K, V> 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
entries(): IterableIterator<[K, V]> entries(): IterableIterator<[K, V]> /
keys(): IterableIterator keys(): IterableIterator /
values(): IterableIterator values(): IterableIterator /
new <K, V>(entries?: readonly (readonly [K, V])[] null): Map<K, V> constructor(entries?: readonly (readonly [K, V])[] null)

Set

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
readonly size: number readonly size: number Sendable类和接口中不允许使用计算属性名称(arkts-sendable-compated-prop-name)。
add(value: T): this add(value: T): Set 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
clear(): void clear(): void 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
delete(value: T): boolean delete(value: T): boolean 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
forEach(callbackfn: (value: T, value2: T, set: Set) => void, thisArg?: any): void forEach(callbackFn: (value: T, value2: T, set: Set) => void): void 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。 2. ArkTS不支持this,因此不支持thisArg参数。
has(value: T): boolean has(value: T): boolean 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
entries(): IterableIterator<[T, T]> entries(): IterableIterator<[T, T]> /
keys(): IterableIterator keys(): IterableIterator /
values(): IterableIterator values(): IterableIterator Sendable类和接口中不允许使用计算属性名称(arkts-sendable-compated-prop-name)。
new <T = any>(values?: readonly T[] null): Set constructor(values?: readonly T[] null)
Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐