概念介绍
鸿蒙的多线程并发TaskPool
和Worker
,他们具有相同内存模型,线程间隔离内存不共享
。在项目中若使用到,有几个较重要的条件或特点这里简单作出列举。
CPU密集型任务,说白了是计算型耗时任务;
I/O密集型任务,说白了是读写型耗时任务;
官方文档重点介绍了这两种基于多线程并发机制处理任务类型,我们是要深度思考下的?!「很有意义」,是否已经包含且指明了我们使用「TaskPool/Worker」来解决项目问题的方案呢?
-
Worker
- 使用Worker,创建线程个数最多是64个。超过则创建失败。
- 使用Worker,传输序列化数据大小限制在16MB。
- 引用HAR/HSP前,首先要配置对HAR/HSP的依赖。
不支持
跨HAP使用Worker线程文件。 - 使用Worker模块时,需要在主线程中注册onerror接口,否则当worker线程出现异常时会发生jscrash问题。
- 任务执行时长上限,无限制。
-
TaskPool
- TaskPool内部会动态调整线程个数,不支持设置数量。
- TaskPool线程池的数量会根据硬件条件、任务负载等情况动态调整。
- 任务执行时长上限,为3分钟(执行耗时不能超过3分钟)。
- Promise不支持跨线程传递,不能作为concurrent function的返回值。
使用详解
对Worker以及TaskPool的使用详解,个人准备以一种特别的角度来详述。从我个人初始接触及学习研究的视角,针对 如何选用
、如何创建
、如何使用
、注意事项
和条件限制
多个方面,全面剖析。
选用
依据限制条件,若考虑到任务执行时间已超过3分钟,传输数据不大。且需创建的线程个数仅几个这样子,考虑选用Worker;若考虑到任务执行时间较短,且会有大量的线程需要创建、销毁和复用,不想手动对线程数量的控制,可考虑选用TaskPool。如果使用条件上,都未超出两种限制条件,那么请随意。
创建|使用
Worker创建
Worker在进行创建使用时,有手动和自动两种方式,自动的较简单。手动创建Worker线程目录及文件时,还需同步进行相关配置。 「注意事项」 Worker线程文件需要放在"{moduleName}/src/main/ets/"目录层级之下,否则不会被打包到应用中。
自动操作: 在
moduleName
目录下任意位置,点击鼠标右键 > New > Worker,即可自动生成Worker的模板文件及配置信息,无需再手动在build-profile.json5
中进行相关配置。
自动创建演示:假如创建Worker文件
entry/src/main/ets/workers/MyTestWorker1.ets
; 「workers是我自己建的文件目录」则同时deveco studio将在build-profile.json5
文件中发现自动配置信息如下
/// build-profile.json5
{"apiType": "stageMode","buildOption": {"sourceOption": {"workers": [ // 这里就是自动生成的worker配置;换言之,手动创建Worker的话,需要在这里配置下信息'./src/main/ets/workers/MyTestWorker1.ets']}},"targets": [{"name": "default","runtimeOS": "HarmonyOS"}]
}
创建MyTestWorker1.ets文件,自动生成Worker文件模板如下
手动创建Worker文件的话,文件内容如监听方法和错误捕捉方法的监听,需要
仿照模板
编写。同时要在build-profile.json5
文件中配置下配置信息。
import { ErrorEvent, MessageEvents, ThreadWorkerGlobalScope, worker } from '@kit.ArkTS';const workerPort: ThreadWorkerGlobalScope = worker.workerPort;/*** Defines the event handler to be called when the worker thread receives a message sent by the host thread.* [当工作线程接收到主线程发送的消息时,onmessage将被触发]* The event handler is executed in the worker thread.* [onmessage将在工作线程中被执行]* @param e message data*/
workerPort.onmessage = (e: MessageEvents) => {
}/*** Defines the event handler to be called when the worker receives a message that cannot be deserialized.* [当工作线程接收到无法反序列化的消息时,onmessageerror将被触发]* The event handler is executed in the worker thread.*[onmessageerror将在工作线程中被执行]* @param e message data*/
workerPort.onmessageerror = (e: MessageEvents) => {
}/*** Defines the event handler to be called when an exception occurs during worker execution.* [在工作线程执行期间发生异常时,将会调用onerror程序]* The event handler is executed in the worker thread.*[onerror将在工作线程中被执行]* @param e error message*/
workerPort.onerror = (e: ErrorEvent) => {
}
Worker使用
Worker多线程并发,在创建工作线程文件后。在主线程中发起对工作线程调用时,传入文件地址作为入参。若传入地址不对,则报错提示:
Error message:The worker file path is invalid path, the file path is invaild, can't find the file.
Error code:
SourceCode:const workerThread: worker.ThreadWorker = new worker.ThreadWorker('entry/src/main/ets/workers/MyTestWorker1.ets');
「注意事项」 如何传入正确工作线程文件路径?
工作线程创建过程解释说明,
- 先在
entry/src/main/ets
目录下创建了workers文件目录
,(「注意事项」 Worker线程文件需要放在"{moduleName}/src/main/ets/"目录层级之下,否则不会被打包到应用中。) - 然后在该workers文件目录下新建工作线程
文件MyTestWorker1.ets
, - 此时
build-file.json5
中自动配置信息是"workers": ['./src/main/ets/workers/MyTestWorker1.ets' ]
- 但不能直接使用这个配置的信息地址作为入参,而实际应该传入的入参地址,示例「可自行对比区别」:
const workerThread: worker.ThreadWorker = new worker.ThreadWorker('entry/ets/workers/MyTestWorker1.ets');
手动编写一个简单DEMO,在UI界面
onPageShow
生命周期方法中创建Worker实例对象,构造方法中传入Worker线程文件的路径。实现主线程和worker工作线程之间的通信逻辑。
使用Worker实现多线程并发这一能力,首要要搞懂哪里写执行耗时任务
、在哪里开启且如何开启线程
这就和安卓起一个Thread线程的思路很像。
「使用要点」「注意事项」
worker.ThreadWorker
的实例对象是向Worker线程文件发送消息或接收Worker线程文件发送的消息。说白了就是开启线程执行的位置,如通过postMessage发送消息。即可通知worker线程文件中方法执行耗时任务。
worker.ThreadWorker
就是用来开启线程工作用的。
workerThread.onmessage
方法,监听并接收Worker线程文件发出的消息。比如耗时线程工作完成了,需要告知主线程此时此刻的进度
workerThread.postMessage
方法,向Worker线程文件发送消息。比如通知耗时线程开始工作
/// 下面是部分主要代码,为方便阅读非重要内容已省略
/// ets/pages/HomePage.ets
import { worker, MessageEvents, ErrorEvent } from '@kit.ArkTS';@Entry
@Component
struct HomePage {onPageShow(): void {// constructor(scriptURL: string, options?: WorkerOptions);// 构造方法入参Worker线程文件路径「关注」const workerThread: worker.ThreadWorker = new worker.ThreadWorker('entry/src/main/ets/workers/MyTestWorker1.ets');// 「通信」这里接收Worker线程文件中发出的消息workerThread.onmessage = ((event: MessageEvents) => {const type = event.data.type as number;if (type === 2) { // 这里是的匹配工作,是由worker工作线程通过workerPort.postMessage({type: 2, ..})发来的信息。console.error("打印日志,worker主线程收到worker工作线程发来的消息:", event.data.value)}})workerThread.onerror = ((event: ErrorEvent) => {})// 「通信」这里向Worker线程文件发送消息workerThread.postMessage({ 'type': 1, value: '「主线程数据包」' })}build() {Stack({ alignContent: Alignment.Top }) {... 省略...
「使用要点」「注意事项」
worker.workerPort
的实例对象是主线程发送消息或接收主线程发送的消息。worker.workerPort
就是用来执行耗时任务工作用的。
workerPort.onmessage
方法,监听并接收主线程发出的消息。
workerPort.postMessage
方法,向主线程发送消息。
/// ets/workers/MyTestWorker1.ets
import { ErrorEvent, MessageEvents, ThreadWorkerGlobalScope, worker } from '@kit.ArkTS';const workerPort: ThreadWorkerGlobalScope = worker.workerPort;/*** Defines the event handler to be called when the worker thread receives a message sent by the host thread.* The event handler is executed in the worker thread.** @param e message data*/
workerPort.onmessage = (e: MessageEvents) => {const type = e.data.type as number;// 耗时操作,逻辑处理等if (type === 1) {console.error("打印日志,worker工作线程收到主线程发来的消息:", e.data.value)workerPort.postMessage({type: 2, value: '「工作线程数据包」'}) // 通知zhuworker线程}
}
...省略...
运行上面源码执行结果
TaskPool创建|使用
TaskPool在创建及使用上较Worker则过度简单了,等同于拿来即用。
进入TaskPool#execute方法源码,(即从下面截图中)看到在taskpool命名空间中定义有三个重载的方法在提供使用
function execute(func: Function, ...args: Object[]): Promise<Object>;
function execute(task: Task, priority?: Priority): Promise<Object>;
function execute(group: TaskGroup, priority?: Priority): Promise<Object[]>;
针对这三种重载方法创建执行方式,没有太合适且简单易懂的示例代码做演示。就现场手动码一段正确代码演示下
import { taskpool } from '@kit.ArkTS';/**工作任务,用来执行耗时操作:CPU/IO密集型*/
// 「提示」1,需要加装饰器@Concurrent;2,需要function关键字;3,需要声明在@Component外;4,返回值须要是值类型。
@Concurrent
async function taskMethod1 (): Promise<number> {// return Promise.resolve(9) // 不支持。Promise.resolve仍是Promise,其状态是pending,无法作为返回值使用。return 1; // 返回值仅能是「携带值res引用,如const res = [1,2,3]」值类型
}
/**工作任务,用来执行耗时操作:CPU/IO密集型*/
@Concurrent
async function taskMethod2 (): Promise<string> {return 'hello world'; // 返回值仅能是「携带值res引用,如const res = [1,2,3]」值类型
}@Entry
@Component
struct HomePage {onPageShow(): void {this.execute()}async execute() {// function execute(func: Function, ...args: Object[]): Promise<Object>;const resultMethod = await taskpool.execute(taskMethod1, taskMethod2)// function execute(task: Task, priority?: Priority): Promise<Object>;const task1 = new taskpool.Task('任务名称「非必填」', taskMethod1)const resultTask = await taskpool.execute(task1, taskpool.Priority.HIGH)// function execute(group: TaskGroup, priority?: Priority): Promise<Object[]>;const group1 = new taskpool.TaskGroup('定义任务组名称「非必填」') // TaskGroup有两个构造方法,一个无参,一个有字符串入参group1.addTask(taskMethod1) // 向任务组中添加任务方法的引用group1.addTask(taskMethod2) // 向任务组中添加任务方法的引用const resultGroup = await taskpool.execute(group1, taskpool.Priority.HIGH)console.error('打印输出:', resultMethod, resultTask, resultGroup)}build() {Stack({ alignContent: Alignment.Top }) {
...省略...
「注意事项」「提示」实现任务的函数需要①使用装饰器@Concurrent标注
,且②仅支持在.ets文件中
使用,③方法需要function
修饰。
如果在@Component内部创建任务,会提示报错The @Concurrent decorator can decorate only common functions and async functions. <ArkTSCheck>
,因此④需要在@Component外部创建才可以。
「注意事项」「另外」如果在使用装饰器@Concurrent标注
的任务方法中调用了某类的方法类.方法名(args) 或 类实例.方法名(args)
,①声明类须使用装饰器@Sendable标注
。如果不是②通过import方式导入使用,则提示报错:Only imported variables and local variables can be used in @Concurrent decorated functions. <ArkTSCheck>
- 未使用import引入时,错误提示截图图示
正确通过import方式
引入并调用方法的方式,如下。
/**声明类,任务方法中将引用该类SendableTask,使用装饰器@Sendable修饰*/
@Sendable
export default class SendableTask {private static instance: SendableTask = new SendableTask();static getInstance(): SendableTask {// 获取单例return SendableTask.instance;}// 声明模拟一个方法static oneSyncMethod(): number {return 10;}oneMethod(): number {return 2;}
}
下面的截图中张贴了具体的调用逻辑,如何在任务方法@Concurrent async function taskMethod1
中对使用外部类方法SendableTask.oneSyncMethod
调用,
接下来跑下DEMO程序,执行TaskPool多线程并发代码,运行结果输出如截图所示:
08-14 14:43:34.406 45415-45415 A03D00/JSAPP pid-45415 E 打印输出: 10 10 10,hello world
「总结」从截图debug显示及输出日志结果,可以发现并得出结论,taskpool.execute执行并发任务的三种重载方法
,在执行时,各自输出的结果来源~如下
// 输出结果值来源:结果值为func方法执行结果。
function execute(func: Function, ...args: Object[]): Promise<Object>;// 输出结果值来源:结果值为task中调用执行的func方法执行结果。
function execute(task: Task, priority?: Priority): Promise<Object>;// 输出结果值来源:结果值是个数组,数组中每个元素值,为每个task中调用执行的func方法执行结果。
function execute(group: TaskGroup, priority?: Priority): Promise<Object[]>;