团结引擎官方对其线程模型已经有讲述:Unite Shanghai 2024 团结引擎专场 | 团结引擎 OpenHarmony 工程剖析
简而言之团结导出的鸿蒙工程最开始的pages、ability等ArkTS代码(如TuanjiePlayerAbility.ets
、TuajiePlayerAbilityIndex.ets
),是运行在UI线程,用于UI布局、相应app生命周期事件。UI线程可以有鸿蒙的UI(如文字、按钮等),但对游戏引擎来说,没有特殊需求的情况下,只会用用来显示gles渲染结果的XComponent
组件。
为了不阻塞UI线程的事件相应事件,团结引擎的主要循环逻辑会运行在创建出来的ThreadWorker线程中(上图的TuanjieMain线程),这部分代码可以看导出工程中的TuanjieMainWorker.ets
和TuanjieMainWorkerHandle.ets
,TuanjieMainWorkerHandle
用于设置这个worker线程的循环逻辑和对主线程发送过来的消息相应,TuanjieMainWorker
用于接收worker线程发送给UI线程的消息并响应。
在TuanjieMainWorkerHandle.ets
中,会调用tuanjie.nativeSetWorker();
,这是调用团结引擎的鸿蒙平台.so中的方法。
在原文作者提到,tuanjie.nativeSetWorker()
会注册libuv回调,作为引擎Loop。
libuv是一个异步事件库,可以理解为他可以方便得组织一个事件循环,执行一些常见操作,例如每秒执行三十次某些方法,或是接收其他线程的消息。
鸿蒙的线程消息管理就是基于libuv库,它的napi也有一些libuv操作,例如用
napi_get_uv_event_loop
获取鸿蒙为当前worker线程创建的loop对象。最开始我以为
tuanjie.nativeSetWorker()
中会创建一个libuv循环,例如这样:
uv_timer_t logic_timer;
uv_timer_t render_timer;
static void LogicUpdate(uv_timer_t* handle=nullptr)
{
((void)OH_LOG_Print(LOG_APP, LOG_INFO, LOG_DOMAIN, "TestWorker", "Logic Update:", count));
}
static void RenderUpdate(uv_timer_t* handle=nullptr)
{
((void)OH_LOG_Print(LOG_APP, LOG_INFO, LOG_DOMAIN, "TestWorker", "Render Update:", count));
}
napi_value nativeSetWorker(napi_env env, napi_callback_info info)
{
uv_loop_s *loop = nullptr;
napi_get_uv_event_loop(env, &loop);
uv_timer_init(loop, &logic_timer);
uv_timer_start(&logic_timer, LogicUpdate, 0, 16); // 16ms = 60 FPS
uv_timer_init(loop, &render_timer);
uv_timer_start(&render_timer, RenderUpdate, 0, 16); // 16ms = 60 FPS
uv_run(loop, UV_RUN_DEFAULT);
return nullptr;
}
但这样创建出来的事件循环,显然会在调用uv_run
后直接进入循环而,调用这个tuanjie.nativeSetWorker()
方法的ArkTS就无法继续往下走了。
随后是第二个推测,团结是否是在tuanjie.nativeSetWorker()
方法中创建一个线程,类似下面的写法:
napi_value nativeSetWorker(napi_env env, napi_callback_info info)
{
uv_thread_t thread;
if (uv_thread_create(&thread, thread_function, (void*)env) != 0)
{
return nullptr;
}
}
void thread_function(void* inputEnv)
{
napi_env env = (napi_env)inputEnv;
while (1)
{
LogicUpdate();
RenderUpdate();
}
}
这样不会阻塞worker线程,但有鸿蒙系统开发上的问题,上述代码可以发现,我将env传到了子线程中使用,但实际这样会导致bug,用这个env调用napi无法正常执行。
我修改了一种调度方法:
void thread_function(void*)
{
napi_env env;
napi_create_ark_runtime(&env);
while (1)
{
LogicUpdate();
RenderUpdate();
}
napi_destroy_ark_runtime(&env);
}
这样或许可行,但实际打印env中的值发现,子线程的env与worker线程的env内容不同。
那团结引擎时怎么做的呢?随后通过一些手段得到了结果;我之前忽视了worker线程在被ArkTS创建时,本身就会创建一个循环,所以我们现需要的是将回调注册给循环,并且让回调给循环发送消息,让回调自循环,大致结构如下:
#include <uv.h>
#include <iostream>
#include <thread>
#include <chrono>
// 工作线程的 libuv 循环和异步句柄
uv_loop_t* worker_loop;
uv_async_t async_handle; // 用于触发回调并实现自循环
// 回调函数:每次触发时都会执行
void async_callback(uv_async_t* handle) {
std::cout << "Async event triggered in worker thread!" << std::endl;
// 模拟一些工作
std::this_thread::sleep_for(std::chrono::seconds(1));
//Logic
//Render
// 继续触发回调,实现自循环
uv_async_send(&async_handle);
}
// 工作线程:运行 libuv 循环
void worker_thread() {
// 相当于鸿蒙系统在创建worker线程时,自动创建一个loop
worker_loop = uv_loop_new();
// 设置loop在async_handle被send时,会触发async_callback回调
uv_async_init(worker_loop, &async_handle, async_callback);
// 向自己的loop async_handle发送信号
uv_async_send(&async_handle);
// 启动 libuv 循环,开始事件处理
uv_run(worker_loop, UV_RUN_DEFAULT);
// 清理资源
uv_loop_delete(worker_loop);
}
// 主线程
int main() {
// 创建并启动工作线程,模拟ets中创建worker线程
std::thread worker(worker_thread);
// 等待工作线程启动并运行
std::this_thread::sleep_for(std::chrono::seconds(1));
// 等待工作线程结束
worker.join();
return 0;
}
上述代码中,tuanjie.nativeSetWorker()
相当于调用其中的uv_async_init(worker_loop, &async_handle, async_callback);
和uv_async_send(&async_handle);
设置回调并用send启动自循环,之后发送消息都由回调自己设置。
可能有一点差距是,这两者不是在uv_run
之前调用的,而是循环中只执行一次的方法中调用,所以实际更像:
// 空闲回调,只执行一次
void idle_callback(uv_idle_t* handle)
{
std::cout << "This is a one-time task executed in the event loop!" << std::endl;
// 设置loop在async_handle被send时,会触发async_callback回调
uv_async_init(worker_loop, &async_handle, async_callback);
// 向自己的loop async_handle发送信号
uv_async_send(&async_handle);
// 停止空闲回调,使其只执行一次
uv_idle_stop(handle);
}
// 工作线程:运行 libuv 循环
void worker_thread() {
// 相当于鸿蒙系统在创建worker线程时,自动创建一个loop
worker_loop = uv_loop_new();
uv_idle_t idle_handle;
uv_idle_init(worker_loop, &idle_handle);
uv_idle_start(&idle_handle, idle_callback);
// 启动 libuv 循环,开始事件处理
uv_run(worker_loop, UV_RUN_DEFAULT);
// 清理资源
uv_loop_delete(worker_loop);
}
这样输出是:
This is a one-time task executed in the event loop!
Async event triggered in worker thread!
Async event triggered in worker thread!
Async event triggered in worker thread!
Async event triggered in worker thread!
Async event triggered in worker thread!
Async event triggered in worker thread!
....
就像引擎循环一样