鸿蒙语言基础类库：ohos.worker 启动一个Worker

启动一个Worker

说明： 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

Worker是与主线程并行的独立线程。创建Worker的线程称之为宿主线程，Worker自身的线程称之为Worker线程。创建Worker传入的url文件在Worker线程中执行，可以处理耗时操作但不可以直接操作UI。

导入模块

import worker from '@ohos.worker';

属性

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
parentPort	[DedicatedWorkerGlobalScope]	是	是	worker线程用于与宿主线程通信的对象。

WorkerOptions

Worker构造函数的选项信息，用于为Worker添加其他信息。

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
type	"classic"	是	是	按照指定方式执行脚本。
name	string	是	是	Worker的名称。

Worker

使用以下方法前，均需先构造Worker实例，Worker类继承[EventTarget]。

constructor

constructor(scriptURL: string, options?: WorkerOptions)

Worker构造函数。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
scriptURL	string	是	Worker执行脚本的url，路径规范：若DevEco新建工程在pages同级下没有workers目录，需要新建workers目录，将脚本文件放入workers目录。
options	[WorkerOptions]	否	Worker构造的选项。

返回值：

类型	说明
Worker	执行Worker构造函数生成的Worker对象，失败则返回undefined。

示例：

const workerInstance = new worker.Worker("workers/worker.js", {name:"first worker"});

postMessage

postMessage(message: Object, options?: PostMessageOptions): void

向Worker线程发送消息，数据的传输采用结构化克隆算法。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
message	Object	是	发送至Worker的数据。
options	[PostMessageOptions]	否	可转移对象是 ArrayBuffer 的实例对象。transferList数组中不可传入null。

示例：

const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.postMessage("hello world");

const workerInstance= new worker.Worker("workers/worker.js");
var buffer = new ArrayBuffer(8);
workerInstance.postMessage(buffer, [buffer]);

on

on(type: string, listener: EventListener): void

向Worker添加一个事件监听。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
type	string	是	监听事件的type。
listener	[EventListener]	是	回调的事件。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.on("alert", (e)= >{
    console.log("alert listener callback");
})

once

once(type: string, listener: EventListener): void

向Worker添加一个事件监听，事件监听只执行一次便自动删除。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
type	string	是	监听事件的type。
listener	[EventListener]	是	回调的事件。

示例：

const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.once("alert", (e)= >{
    console.log("alert listener callback");
})

off

off(type: string, listener?: EventListener): void

删除Worker的事件监听。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
type	string	是	需要删除事件的type。
listener	[EventListener]	否	需要删除的回调的事件。

示例：

const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.off("alert");

terminate

terminate(): void

关闭Worker线程，终止Worker接收消息。

系统能力： SystemCapability.Utils.Lang

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.terminate()

onexit

onexit?: (code: number) => void

Worker对象的onexit属性表示Worker退出时被调用的事件处理程序，处理程序在宿主线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
code	number	否	Worker退出的code。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onexit = function(e) {
    console.log("onexit")
}

onerror

onerror?: (err: ErrorEvent) => void

Worker对象的onerror属性表示Worker在执行过程中发生异常被调用的事件处理程序，处理程序在宿主线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
err	[ErrorEvent]	否	异常数据。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onerror = function(e) {
    console.log("onerror")
}

onmessage

onmessage?: (event: MessageEvent) => void

Worker对象的onmessage属性表示宿主线程接收到来自其创建的Worker通过parentPort.postMessage接口发送的消息时被调用的事件处理程序，处理程序在宿主线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
event	[MessageEvent]	否	收到的Worker消息数据。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onmessage = function(e) {
    console.log("onerror")
}

onmessageerror

onmessageerror?: (event: MessageEvent) => void

Worker对象的onmessageerror属性表示当Worker对象接收到一条无法被序列化的消息时被调用的事件处理程序，处理程序在宿主线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
event	[MessageEvent]	否	异常数据。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.onmessageerror= function(e) {
    console.log("onmessageerror")
}

EventTarget

addEventListener

addEventListener(type: string, listener: EventListener): void

向Worker添加一个事件监听。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
type	string	是	监听事件的type。
listener	[EventListener]	是	回调的事件。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.addEventListener("alert", (e)= >{
    console.log("alert listener callback");
})

removeEventListener

removeEventListener(type: string, callback?: EventListener): void

删除Worker的事件监听。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
type	string	是	需要删除事件的type。
callback	[EventListener]	否	需要删除的回调的事件。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.removeEventListener("alert")

dispatchEvent

dispatchEvent(event: Event): boolean

分发定义在Worker的事件。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
event	[Event]	是	需要分发的事件。

返回值：

类型	说明
boolean	分发的结果，false表示分发失败。

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.dispatchEvent({type:"alert"})

removeAllListener

removeAllListener(): void

删除Worker的所有事件监听。

系统能力： SystemCapability.Utils.Lang

示例：

const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.removeAllListener({type:"alert"})

DedicatedWorkerGlobalScope

Worker线程用于与宿主线程通信的类，通过postMessage接口发送消息给宿主线程、close接口关闭Worker线程，DedicatedWorkerGlobalScope类继承[WorkerGlobalScope]。

postMessage

postMessage(message: Object, options?: PostMessageOptions): void

Worker向宿主线程发送消息。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
message	Object	是	发送至Worker的数据。
options	[PostMessageOptions]	否	可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。

示例：

// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.postMessage("hello world")
workerInstance.onmessage = function(e) {
    console.log("receive data from worker.js")
}

// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e){
    parentPort.postMessage("receive data from main.js")
}

close

close(): void

关闭Worker线程，终止Worker接收消息。

系统能力： SystemCapability.Utils.Lang

示例：

// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")

// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
    parentPort.close()
}

onmessage

onmessage?: (event: MessageEvent) => void

DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿主线程通过worker.postMessage接口发送的消息时被调用的事件处理程序，处理程序在Worker线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
event	[MessageEvent]	否	收到的Worker消息数据。

示例：

// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")
workerInstance.postMessage("hello world")

// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
    console.log("receive main.js message")
}

onmessageerror

onmessageerror?: (event: MessageEvent) => void

DedicatedWorkerGlobalScope的onmessageerror属性表示当Worker对象接收到一条无法被反序列化的消息时被调用的事件处理程序，处理程序在Worker线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
event	[MessageEvent]	否	异常数据。

示例：

// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")

// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessageerror= function(e) {
    console.log("worker.js onmessageerror")
}

PostMessageOptions

明确数据传递过程中需要转移所有权对象的类，传递所有权的对象必须是ArrayBuffer。

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
transfer	Object[]	是	是	ArrayBuffer数组，用于传递所有权。

Event

事件类。

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
type	string	是	否	指定事件的type。
timeStamp	number	是	否	事件创建时的时间戳（精度为毫秒）。

EventListener

事件监听类。

(evt: Event): void | Promise

执行的回调函数。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
evt	[Event]	是	回调的事件类。

返回值：

类型	说明
void	Promise

示例：

const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.addEventListener("alert", (e)= >{
    console.log("alert listener callback");
})

ErrorEvent

错误事件类，用于表示Worker执行过程中出现异常的详细信息，ErrorEvent类继承[Event]。

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
message	string	是	否	异常发生的错误信息。
filename	string	是	否	出现异常所在的文件。
lineno	number	是	否	异常所在的行数。
colno	number	是	否	异常所在的列数。
error	Object	是	否	异常类型。

MessageEvent

消息类，持有Worker线程间传递的数据。

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型	可读	可写	说明
data	T	是	否	线程间传递的数据。

WorkerGlobalScope

Worker线程自身的运行环境，WorkerGlobalScope类继承[EventTarget]。

属性

系统能力： 以下各项对应的系统能力均为SystemCapability.Utils.Lang。

名称	参数类型HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿	可读	可写	说明
name	string	是	否	Worker的名字，有new Worker时指定。
self	[WorkerGlobalScope] & typeof globalThis	是	否	WorkerGlobalScope本身。

onerror

onerror?: (ev: ErrorEvent) => void

WorkerGlobalScope的onerror属性表示Worker在执行过程中发生异常被调用的事件处理程序，处理程序在Worker线程中执行。

系统能力： SystemCapability.Utils.Lang

参数：

参数名	类型	必填	说明
ev	[ErrorEvent]	否	异常数据。

示例：

// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")

// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort
parentPort.onerror = function(e){
    console.log("worker.js onerror")
}

审核编辑 黄宇