同步任务开发指导 (TaskPool和Worker)

使用TaskPool处理同步任务

以下场景推荐使用TaskPool。

• 调度相互独立的任务。

• 静态方法实现的任务。

• 单例构造的句柄或者类对象跨线程使用。

1. 定义并发函数，实现业务逻辑。

2. 创建任务Task，通过execute()接口执行该任务。

3. 对任务返回的结果进行操作。

如下示例中业务使用TaskPool调用相关同步方法的代码，首先定义并发函数taskpoolFunc，需要注意必须使用@Concurrent装饰器装饰该函数；其次定义函数mainFunc，该函数功能为创建任务，执行任务并处理任务返回的结果。

import { taskpool } from '@kit.ArkTS';
// ...

// 步骤1: 定义并发函数，实现业务逻辑
@Concurrent
async function taskpoolFunc(num: number): Promise<number> {
  // 根据业务逻辑实现相应的功能
  let tmpNum: number = num + 100;
  return tmpNum;
}

async function mainFunc(): Promise<void> {
  // 步骤2: 创建任务并执行
  let task1: taskpool.Task = new taskpool.Task(taskpoolFunc, 1);
  let res1: number = await taskpool.execute(task1) as number;
  let task2: taskpool.Task = new taskpool.Task(taskpoolFunc, res1);
  let res2: number = await taskpool.execute(task2) as number;
  // 步骤3: 对任务返回的结果进行操作
  console.info(`taskpool: task res1 is: ${res1}`);
  console.info(`taskpool: task res2 is: ${res2}`);
}

const MSG_SET = 0;
const MSG_GET = 1;

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

  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
          .onClick(async () => {
            await mainFunc();
            // ...
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

使用Worker处理关联的同步任务

当一系列同步任务需要使用同一个句柄调度，或者需要依赖某个类对象调度，且无法在不同任务池之间共享时，需要使用Worker。

1. 在UI主线程中创建Worker对象并接收Worker线程发送的消息。DevEco Studio支持一键生成Worker。在{moduleName}目录下任意位置，点击鼠标右键 > New > Worker，即可生成Worker的模板文件及配置信息。

   收起

   自动换行

   深色代码主题

   复制

   import { MessageEvents, worker } from '@kit.ArkTS';
   // ...
   @Entry
   @Component
   struct Index {
     @State message: string = 'Hello World';
   
     build() {
       Row() {
         Column() {
           Text(this.message)
             .fontSize(50)
             .fontWeight(FontWeight.Bold)
             .onClick(async () => {
               // ...
               let w: worker.ThreadWorker = new worker.ThreadWorker('entry/ets/workers/MyWorker2.ets');
               w.onmessage = (e: MessageEvents): void => {
                 // 接收Worker子线程的结果
                 console.info(`main thread onmessage, ${e.data.message}`);
                 // 销毁Worker
                 if (e.data.isTerminate) {
                   w.terminate();
                 }
               }
               // 向Worker子线程发送Set消息
               w.postMessage({'type': MSG_SET, 'data': 10});
               // 向Worker子线程发送Get消息
               w.postMessage({'type': MSG_GET});
             })
         }
         .width('100%')
       }
       .height('100%')
     }
   }

   SyncTaskDevelopment.ets

2. 在Worker线程中绑定Worker对象，同时处理同步任务逻辑。

   收起

   自动换行

   深色代码主题

   复制

   export default class Handle {
     id: number = 0;
   
     syncGet(): number {
       return this.id;
     }
   
     syncSet(num: number): boolean {
       this.id = num;
       return true;
     }
   }

   handle.ts
   收起

   自动换行

   深色代码主题

   复制

   import { worker, ThreadWorkerGlobalScope, MessageEvents } from '@kit.ArkTS';
   // 导入句柄类型
   import Handle from './handle';
   
   const MSG_SET = 0;
   const MSG_GET = 1;
   
   let workerPort : ThreadWorkerGlobalScope = worker.workerPort;
   
   // 无法传输的句柄，所有操作依赖此句柄
   let handler: Handle = new Handle();
   
   // Worker线程的onmessage逻辑
   workerPort.onmessage = (e : MessageEvents): void => {
     switch (e.data.type as number) {
       case MSG_SET:
         let result: boolean = handler.syncSet(e.data.data);
         console.info('worker: result is ' + result);
         workerPort.postMessage({'message': 'the result of syncSet() is ' + result, 'isTerminate': false});
         break;
       case MSG_GET:
         let num: number = handler.syncGet();
         console.info('worker: num is ' + num);
         workerPort.postMessage({'message': 'the result of syncGet() is ' + num, 'isTerminate': true});
         break;
       default:
         workerPort.postMessage({ 'message': 'send message is invalid', 'isTerminate': false });
         break;
     }
   }