鸿蒙OpenHarmony【Sendable对象简介】 ArkTS并发线程间通信

Sendable对象简介

在传统JS引擎上，对象的并发通信开销的优化方式只有一种，就是把实现下沉到Native侧，通过[Transferable对象]的转移或共享方式降低并发通信开销。而开发者仍然还有大量对象并发通信的诉求，这个问题在业界的JS引擎实现上并没有得到解决。

ArkTS提供了Sendable对象类型，在并发通信时支持通过引用传递来解决上述问题。

Sendable对象为可共享的，其跨线程前后指向同一个JS对象，如果其包含了JS或者Native内容，均可以直接共享，如果底层是Native实现的，则需要考虑线程安全性。通信过程如下图所示：

与其它ArkTS对象不一样的是，符合Sendable协议的数据对象在运行时必须是类型固定的对象。

当多个并发实例尝试同时更新Sendable数据时，会发生数据竞争，例如[ArkTS共享容器]的多线程操作。因此，ArkTS提供了[异步锁]的机制来避免不同并发实例间的数据竞争。同时，还可以通过[对象冻结接口]冻结对象，将其变为只读对象，就可以不用考虑数据的竞争问题。

Sendable对象提供了并发实例间高效的通信效率，即引用传递的能力，一般适用于开发者自定义大对象需要线程间通信的场景，例如子线程读取数据库的数据返回宿主线程。

基础概念

Sendable协议

Sendable协议定义了ArkTS的可共享对象体系及其规格约束。符合Sendable协议的数据（以下简称Sendable对象）可以在ArkTS并发实例间传递。

默认情况下，Sendable数据在ArkTS并发实例间（包括UI主线程、TaskPool线程、Worker线程）传递的行为是引用传递。同时，ArkTS也支持Sendable数据在ArkTS并发实例间拷贝传递。

ISendable

在ArkTS语言基础库[@arkts.lang]中引入了interface ISendable，没有任何必须的方法或属性。ISendable是所有Sendable类型（除了null和undefined）的父类型。ISendable主要用在开发者自定义Sendable数据结构的场景中。类装饰器[@Sendable装饰器]是implement ISendable的语法糖。

Sendable class

说明：

从API version 11开始，支持使用@Sendable装饰器校验Sendable class。

Sendable class需同时满足以下两个规则：

1. 当且仅当被标注了[@Sendable装饰器]。
2. 需满足Sendable约束。

Sendable function

说明：

• 从API version 12开始，支持使用@Sendable装饰器校验Sendable function。
• 开发者如需在API12上使用Sendable function，需在工程中配置"compatibleSdkVersionStage": “beta3”，否则其Sendable特性将不生效。

Sendable function需同时满足以下两个规则：

1. 当且仅当被标注了[@Sendable装饰器]。
2. 需满足Sendable约束

Sendable interface

Sendable interface需同时满足以下两个规则：

1. 当且仅当是[ISendable]或者继承了ISendable。
2. 需满足Sendable约束

Sendable支持的数据类型

• 所有的ArkTS基本数据类型：boolean, number, string, bigint, null, undefined。

• ArkTS语言标准库中定义的[容器类型数据]（须显式引入[@arkts.collections]）。

• ArkTS语言标准库中定义的[异步锁对象]（须显式引入[@arkts.utils]）。

• 继承了[ISendable]的interface。

• 标注了[@Sendable装饰器]的class。

• 标注了[@Sendable装饰器]的function。

• 接入Sendable的系统对象。

  • [共享用户首选项]
  • [可共享的色彩管理]
  • [基于Sendable对象的图片处理]
  • [资源管理]
  • [SendableContext对象管理]

• 元素均为Sendable类型的union type数据。

说明：

• JS内置对象在并发实例间的传递遵循结构化克隆算法，跨线程行为是拷贝传递。因此JS内置对象的实例不是Sendable类型。
• 对象字面量、数组字面量在并发实例间的传递遵循结构化克隆算法，跨线程行为是拷贝传递。因此，对象字面量和数组字面量不是Sendable类型。

Sendable的实现原理

为了实现[Sendable数据]在不同并发实例间的引用传递，Sendable共享对象会分配在共享堆中，以实现跨并发实例的内存共享。

共享堆（SharedHeap）是进程级别的堆空间，与虚拟机本地堆（LocalHeap）不同的是，LocalHeap只能被单个并发实例访问，而SharedHeap可以被所有线程访问。一个Sendable共享对象的跨线程行为是引用传递。因此，Sendable可能被多个并发实例引用，判断Sendable共享对象是否存活，取决于所有并发实例的对象是否存在对此Sendable共享对象的引用。

SharedHeap与LocalHeap关系图

各个并发实例间的LocalHeap是隔离的，SharedHeap是进程级别的堆，可以被所有的并发实例引用。但是SharedHeap不能引用LocalHeap中的对象。

@Sendable装饰器

声明并校验Sendable class以及Sendable function。

装饰器修饰Class使用示例：

@Sendable
class SendableTestClass {
  desc: string = "sendable: this is SendableTestClass ";
  num: number = 5;
  printName() {
    console.info("sendable: SendableTestClass desc is: " + this.desc);
  }
  get getNum(): number {
    return this.num;
  }
}

装饰器修饰Function使用示例：

@Sendable
type SendableFuncType = () => void;

@Sendable
class TopLevelSendableClass {
  num: number = 1;
  PrintNum() {
    console.info("Top level sendable class");
  }
}

@Sendable
function TopLevelSendableFunction() {
  console.info("Top level sendable function");
}

@Sendable
function SendableTestFunction() {
  const topClass = new TopLevelSendableClass(); // 顶层sendable class
  topClass.PrintNum();
  TopLevelSendableFunction(); // 顶层sendable function
  console.info("Sendable test function");
}

@Sendable
class SendableTestClass {
  constructor(func: SendableFuncType) {
    this.callback = func;
  }
  callback: SendableFuncType; // 顶层sendable function

  CallSendableFunc() {
    SendableTestFunction(); // 顶层sendable function
  }
}

let sendableClass = new SendableTestClass(SendableTestFunction);
sendableClass.callback();
sendableClass.CallSendableFunc();