共享容器

ArkTS容器集

ArkTS共享容器(@arkts.collections (ArkTS容器集))是一种在并发实例间共享传输的容器类,可以用于并发场景下的高性能数据传递。功能与Ecmascript262规范定义的容器类似,但仍然有部分差异,具体可见共享容器与原生API方法的行为差异对比

ArkTS共享容器在多个并发实例间传递时,默认采用引用传递,允许多个并发实例操作同一个容器实例。此外,还支持拷贝传递,即每个并发实例拥有一个独立的ArkTS容器实例。

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

ArkTS共享容器包含如下几种:ArrayMapSetTypedArray(Int8Array、Uint8Array、Int16Array、Uint16Array、Int32Array、Uint32Array、Uint8ClampedArray、Float32Array)、ArrayBuffer等,具体可见@arkts.collections (ArkTS容器集)

容器集使用示例如下:

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;
          let num = count;
          while (num--) {
            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。

ArkTS共享容器跨线程传递采用引用传递方式,与原生容器相比效率更高,如果开发者需要跨线程传输的数据量很大,建议使用ArkTS共享容器。

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 <T>(arrayLength: number): T[] constructor() /
new <T>(...items: T[]): T[] constructor(first: T, ...left: T[]) 为了防止undefined扩散,构造函数中必须提供一个初始值,继承场景下,无法调用该函数进行对象构造。
from<T>(arrayLike: ArrayLike<T>): T[] static from<T>(arrayLike: ArrayLike<T>): Array<T> /
from<T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[] static from<U, T>(arrayLike: ArrayLike<U> | Iterable<U>, mapFn: ArrayFromMapFn<U, T>): Array<T> /
pop(): T | undefined pop(): T | undefined 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
push(...items: T[]): number push(...items: T[]): number 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
concat(...items: ConcatArray<T>[]): T[] concat(...items: ConcatArray<T>[]): Array<T> 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
concat(...items: (T | ConcatArray<T>)[]): T[] concat(...items: ConcatArray<T>[]): Array<T> 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
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<T> /
sort(compareFn?: (a: T, b: T) => number): this sort(compareFn?: (a: T, b: T) => number): Array<T> 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<T>) => void): void ArkTS不支持this,因此不支持thisArg参数。
map<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any): U[] map<U>(callbackFn: (value: T, index: number, array: Array<T>) => U): Array<U> ArkTS不支持this,因此不支持thisArg参数。
filter(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): T[] filter(predicate: (value: T, index: number, array: Array<T>) => boolean): Array<T> 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): T /
reduce<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U reduce<U>(callbackFn: (previousValue: U, currentValue: T, currentIndex: number, array: Array<T>) => 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<T>) => boolean): number ArkTS不支持this,因此不支持thisArg参数。
fill(value: T, start?: number, end?: number): this fill(value: T, start?: number, end?: number): Array<T> 1. 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
2. 继承场景下,无法获得实际类型的返回值。
entries(): IterableIterator<[number, T]> entries(): IterableIterator<[number, T]> /
keys(): IterableIterator<number> keys(): IterableIterator<number> /
values(): IterableIterator<T> values(): IterableIterator<T> /
includes(searchElement: T, fromIndex?: number): boolean includes(searchElement: T, fromIndex?: number): boolean /
at(index: number): T | undefined at(index: number): T | undefined /
isArray(arg: any): arg is any[] static isArray(value: Object | undefined | null): boolean 仅判断是否为ArkTS的Array实例,对原生容器Array返回false。
of<T>(...items: T[]): T[] static of<T>(...items: T[]): Array<T> /
copyWithin(target: number, start: number, end?: number): this copyWithin(target: number, start: number, end?: number): Array<T> 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
lastIndexOf(searchElement: T, fromIndex?: number): number lastIndexOf(searchElement: T, fromIndex?: number): number 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
some(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean some(predicate: ArrayPredicateFn<T, Array<T>>): boolean 1. 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
2.ArkTS不支持this,因此不支持thisArg参数。
reduceRight(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T): T reduceRight(callbackFn: ArrayReduceCallback<T, T, Array<T>>): T 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
reduceRight<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U): U reduceRight<U = T>(callbackFn: ArrayReduceCallback<U, T, Array<T>>, initialValue: U): U 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
reverse(): T[] reverse(): Array<T> 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
toString(): string toString(): string 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
find(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T | undefined find(predicate: (value: T, index: number, obj: Array<T>) => boolean): T | undefined 1. 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
2. ArkTS不支持this,因此不支持thisArg参数。
splice(start: number, deleteCount: number, ...items: T[]): T[] splice(start: number, deleteCount: number, ...items: T[]): Array<T> 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。
every(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any): boolean every(predicate: ArrayPredicateFn<T, Array<T>>): boolean ArkTS不支持this,因此不支持thisArg参数。
toLocaleString(): string toLocaleString(): string 不允许在遍历、访问过程中进行元素的增、删、改操作,否则会抛出异常。

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 1. 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
2. ArkTS不支持this,因此不支持thisArg参数。
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<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Int8Array) => U, initialValue: U): U reduce<U>(callbackFn: TypedArrayReduceCallback<U, number, Int8Array>, initialValue: U): U /
reverse(): Int8Array reverse(): Int8Array /
set(array: ArrayLike<number>, offset?: number): void set(array: ArrayLike<number>, 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<number>): 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<number> keys(): IterableIterator<number> /
values(): IterableIterator<number> values(): IterableIterator<number> /
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<number> | ArrayBufferLike): Int8Array constructor(array: ArrayLike<number> | ArrayBuffer) /
new(buffer: ArrayBufferLike, byteOffset?: number, length?: number): Int8Array constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number) /
from(arrayLike: ArrayLike<number>): Int8Array static from(arrayLike: ArrayLike<number>): Int8Array /
from<T>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => number, thisArg?: any): Int8Array static from<T>(arrayLike: ArrayLike<T>, mapFn: TypedArrayFromMapFn<T, number>): Int8Array ArkTS不支持this,因此不支持thisArg参数。
from(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Int8Array static from(arrayLike: Iterable<number>, mapFn?: TypedArrayFromMapFn<number, number>): Int8Array ArkTS不支持this,因此不支持thisArg参数。
of(...items: number[]): Int8Array static of(...items: number[]): Int8Array /
toString(): string toString(): string 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
toLocaleString(): string toLocaleString(): string 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
lastIndexOf(searchElement: number, fromIndex?: number): number lastIndexOf(searchElement: number, fromIndex?: number): number 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Int8Array) => number): number reduceRight(callbackFn: TypedArrayReduceCallback<number, number, Int8Array>): number 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Int8Array) => U, initialValue: U): U reduceRight<U = number>(callbackFn: TypedArrayReduceCallback<U, number, Int8Array>, initialValue: U): U 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。

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<K> keys(): IterableIterator<K> /
values(): IterableIterator<V> values(): IterableIterator<V> /
new <K, V>(entries?: readonly (readonly [K, V])[] | null): Map<K, V> constructor(entries?: readonly (readonly [K, V])[] | null) 构造时传入的k,v键值不能是非Sendable数据,否则编译会报错。

Set

原生API方法 ArkTS容器集方法 是否有行为差异 在ArkTS容器中的差异表现
readonly size: number readonly size: number Sendable类和接口中不允许使用计算属性名称(arkts-sendable-compated-prop-name)。
add(value: T): this add(value: T): Set<T> 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
clear(): void clear(): void 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
delete(value: T): boolean delete(value: T): boolean 不允许在遍历、访问过程中进行元素的增、删、改操作否则会抛出异常。
forEach(callbackfn: (value: T, value2: T, set: Set<T>) => void, thisArg?: any): void forEach(callbackFn: (value: T, value2: T, set: Set<T>) => 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<T> keys(): IterableIterator<T> /
values(): IterableIterator<T> values(): IterableIterator<T> Sendable类和接口中不允许使用计算属性名称(arkts-sendable-compated-prop-name)。
new <T = any>(values?: readonly T[] | null): Set<T> constructor(values?: readonly T[] | null) 构造时传入的数据必须是Sendable类型,否则编译会报错。