操作对象需要符合Sendable对象的规则,具体可见Sendable使用规则与约束。
在C++层进行多线程并发计算时,需要在每个C++线程上创建ArkTS执行环境,直接调用API。这样可以避免在非UI主线程回调时等待UI主线程的API调用结果。同时,还需要在C++线程之间共享和操作Sendable对象。
为了支持此类场景,C++线程需要能够创建并调用ArkTS,同时支持对Sendable对象进行多线程共享和操作。
使用Node-API接口在C++线程中创建ArkTS运行环境并调用的方法,可以参考使用Node-API接口创建ArkTS运行时环境。
核心代码片段如下所示:
ArkTS文件定义。
- @Sendable
- export class SendableObjTest {
- private value: number = 1024;
- static newSendable(): SendableObjTest {
- return new SendableObjTest();
- }
- public getValue(): number {
- return this.value;
- }
- }
实现Native加载ArkTS模块的能力。
- #include <thread>
-
- #include "napi/native_api.h"
- // 用于对比确认获取的sendable对象的value的值
- const int SENDABLE_VALUE = 1024;
-
- static void* g_serializationData = nullptr;
- static void* CreateEnvAndSendSendable(void*)
- {
- // 1. 创建基础运行环境
- napi_env env = nullptr;
- napi_status ret = napi_create_ark_runtime(&env);
- if (ret != napi_ok) {
- std::abort();
- }
- // 2. 加载自定义模块,假定SendableObjTest中提供创建sendable对象的方法newSendable
- napi_value test = nullptr;
- ret = napi_load_module_with_info(
- env, "entry/src/main/ets/pages/SendableObjTest", "com.example.myapplication/entry", &test);
- if (ret != napi_ok) {
- std::abort();
- }
- napi_value sendableObjTest = nullptr;
- ret = napi_get_named_property(env, test, "SendableObjTest", &sendableObjTest);
- if (ret != napi_ok) {
- std::abort();
- }
- // 3. 使用ArkTS中的newSendable,假设sendableObjTest中有一个函数newSendable能返回sendable对象
- napi_value newSendable = nullptr;
- ret = napi_get_named_property(env, sendableObjTest, "newSendable", &newSendable);
- if (ret != napi_ok) {
- std::abort();
- }
- // 4. 调用newSendable函数返回新创建的sendable对象,并保存在result中
- napi_value result = nullptr;
- ret = napi_call_function(env, sendableObjTest, newSendable, 0, nullptr, &result);
- if (ret != napi_ok) {
- std::abort();
- }
- // 5. 序列化sendable对象
- napi_value undefined;
- napi_get_undefined(env, &undefined);
- ret = napi_serialize(env, result, undefined, undefined, &g_serializationData);
- if (ret != napi_ok) {
- std::abort();
- }
- napi_destroy_ark_runtime(&env);
- return nullptr;
- }
主要步骤包括:创建执行环境、加载模块、查找并调用模块函数(或直接通过Node-API接口创建Sendable对象),最后销毁执行环境。加载模块的详细信息,请参见使用Node-API接口进行模块加载。查找并调用函数及更多Node-API接口能力,请参见Node-API。
在C++中调用ArkTS能力后,需要通过序列化和反序列化跨线程传递。napi_value不是多线程安全的,不能直接在多线程之间操作和共享。
下面代码例子说明了如何序列化和反序列化传递对象,注意因为Sendable共享对象是引用传递,所以序列化不会产生另外一份拷贝数据,而是直接传递对象引用到反序列化线程,所以在性能上相比非Sendable对象的序列化和反序列化更为高效。
ArkTS文件定义。
- @Sendable
- export class SendableObjTest {
- private value: number = 1024;
- static newSendable(): SendableObjTest {
- return new SendableObjTest();
- }
- public getValue(): number {
- return this.value;
- }
- }
在Native中实现两个线程的序列化和反序列化Sendable的逻辑。
- #include <thread>
-
- #include "napi/native_api.h"
- // 用于对比确认获取的sendable对象的value的值
- const int SENDABLE_VALUE = 1024;
-
- static void* g_serializationData = nullptr;
- static void* CreateEnvAndSendSendable(void*)
- {
- // 1. 创建基础运行环境
- napi_env env = nullptr;
- napi_status ret = napi_create_ark_runtime(&env);
- if (ret != napi_ok) {
- std::abort();
- }
- // 2. 加载自定义模块,假定SendableObjTest中提供创建sendable对象的方法newSendable
- napi_value test = nullptr;
- ret = napi_load_module_with_info(
- env, "entry/src/main/ets/pages/SendableObjTest", "com.example.myapplication/entry", &test);
- if (ret != napi_ok) {
- std::abort();
- }
- napi_value sendableObjTest = nullptr;
- ret = napi_get_named_property(env, test, "SendableObjTest", &sendableObjTest);
- if (ret != napi_ok) {
- std::abort();
- }
- // 3. 使用ArkTS中的newSendable,假设sendableObjTest中有一个函数newSendable能返回sendable对象
- napi_value newSendable = nullptr;
- ret = napi_get_named_property(env, sendableObjTest, "newSendable", &newSendable);
- if (ret != napi_ok) {
- std::abort();
- }
- // 4. 调用newSendable函数返回新创建的sendable对象,并保存在result中
- napi_value result = nullptr;
- ret = napi_call_function(env, sendableObjTest, newSendable, 0, nullptr, &result);
- if (ret != napi_ok) {
- std::abort();
- }
- // 5. 序列化sendable对象
- napi_value undefined;
- napi_get_undefined(env, &undefined);
- ret = napi_serialize(env, result, undefined, undefined, &g_serializationData);
- if (ret != napi_ok) {
- std::abort();
- }
- napi_destroy_ark_runtime(&env);
- return nullptr;
- }
-
- static void* CreateEnvAndReceiveSendable(void*)
- {
- // 1. 创建基础运行环境
- napi_env env = nullptr;
- napi_status ret = napi_create_ark_runtime(&env);
- if (ret != napi_ok) {
- std::abort();
- }
- // 2. 反序列化获取sendable共享对象,结果保存在result中,这个result就可以通过napi接口进行各种操作了
- napi_value result = nullptr;
- ret = napi_deserialize(env, g_serializationData, &result);
- if (ret != napi_ok) {
- std::abort();
- }
- // 3. 删除序列化数据
- ret = napi_delete_serialization_data(env, g_serializationData);
- if (ret != napi_ok) {
- std::abort();
- }
- // 4. 从 result 对象上获取 getValue 方法
- napi_value getValueFunc = nullptr;
- ret = napi_get_named_property(env, result, "getValue", &getValueFunc);
- if (ret != napi_ok) {
- std::abort();
- }
- // 5. 以 result 作为 this 调用 getValue 方法,返回值存入 valueResult
- napi_value valueResult = nullptr;
- ret = napi_call_function(env, result, getValueFunc, 0, nullptr, &valueResult);
- if (ret != napi_ok) {
- std::abort();
- }
- // 6. 确认valueResult为 number 类型
- napi_valuetype valuetype0;
- napi_typeof(env, valueResult, &valuetype0);
- if (valuetype0 != napi_number) {
- std::abort();
- }
- // 7. 1024是判断ArkTS返回的结果是否正确
- int value0;
- napi_get_value_int32(env, valueResult, &value0);
- if (value0 != SENDABLE_VALUE) {
- std::abort();
- }
- napi_destroy_ark_runtime(&env);
- return nullptr;
- }
-
- static napi_value TestSendSendable([[maybe_unused]] napi_env env, [[maybe_unused]] napi_callback_info info)
- {
- // UI 主线程创建 t1 线程
- std::thread t1(CreateEnvAndSendSendable, nullptr);
- t1.join();
- // UI 主线程创建 t2 线程
- std::thread t2(CreateEnvAndReceiveSendable, nullptr);
- t2.join();
- return nullptr;
- }
-
- EXTERN_C_START
- static napi_value Init(napi_env env, napi_value exports)
- {
- napi_property_descriptor desc[] = { { "testSendSendable", nullptr, TestSendSendable, nullptr, nullptr, nullptr,
- napi_default, nullptr } };
- napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
- return exports;
- }
- EXTERN_C_END
-
- static napi_module demoModule = {
- .nm_version = 1,
- .nm_flags = 0,
- .nm_filename = nullptr,
- .nm_register_func = Init,
- .nm_modname = "entry",
- .nm_priv = ((void*)0),
- .reserved = { 0 },
- };
-
- extern "C" __attribute__((constructor)) void RegisterEntryModule(void)
- {
- napi_module_register(&demoModule);
- }
- export const testSendSendable: () => void;
UI主线程发起调用。
- import { hilog } from '@kit.PerformanceAnalysisKit';
- import testNapi from 'libentry.so';
- import { SendableObjTest } from './SendableObjTest'
-
- @Entry
- @Component
- struct Index {
- @State message: string = 'Hello World';
-
- build() {
- Row() {
- Column() {
- Text(this.message)
- .fontSize(50)
- .fontWeight(FontWeight.Bold)
- .onClick(() => {
- SendableObjTest.newSendable()
- hilog.info(0x0000, 'testTag', 'Test send Sendable begin');
- testNapi.testSendSendable();
- hilog.info(0x0000, 'testTag', 'Test send Sendable end');
- this.message = 'success';
- })
- }
- .width('100%')
- }
- .height('100%')
- }
- }
整个过程主要包括的逻辑实现为:
UI主线程创建C++子线程t1,创建ArkTS运行环境并加载ArkTS模块,并创建Sendable对象,保存到result中,然后将result引用的Sendable对象序列化到全局序列化数据serializationData中。
当这些流程完成后,UI主线程创建C++子线程t2,并在这个新的线程中创建ArkTS运行环境。然后再通过反序列化接口从serializationData中反序列化出t1线程创建的Sendable对象,并保存到result中,从而实现了Sendable对象的跨C++线程传递。反序列化完成后,需要销毁序列化数据避免内存泄漏。
操作对象需要符合Sendable对象的规则,具体可见Sendable使用规则与约束。