js-apis-worker.md 55.8 KB
Newer Older
Z
zengyawen 已提交
1
# 启动一个Worker
Z
zengyawen 已提交
2

Z
zengyawen 已提交
3
Worker是与主线程并行的独立线程。创建Worker的线程称之为宿主线程,Worker自身的线程称之为Worker线程。创建Worker传入的url文件在Worker线程中执行,可以处理耗时操作但不可以直接操作UI。
Y
yqhan 已提交
4 5 6

Worker主要作用是为应用程序提供一个多线程的运行环境,可满足应用程序在执行过程中与主线程分离,在后台线程中运行一个脚本操作耗时操作,极大避免类似于计算密集型或高延迟的任务阻塞主线程的运行。由于Worker一旦被创建则不会主动被销毁,若不处于任务状态一直运行,在一定程度上会造成资源的浪费,应及时关闭空闲的Worker。

7 8
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**<br/>
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zengyawen 已提交
9 10

## 导入模块
Z
zengyawen 已提交
11

Y
yqhan 已提交
12
```js
Z
zengyawen 已提交
13 14 15
import worker from '@ohos.worker';
```

Z
zengyawen 已提交
16 17 18

## 属性

19
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
20

21
| 名称                              | 类型                                                      | 可读 | 可写 | 说明                                                         |
22 23
| --------------------------------- | --------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| workerPort<sup>9+</sup>           | [ThreadWorkerGlobalScope](#threadworkerglobalscope9)      | 是   | 是   | worker线程用于与宿主线程通信的对象。                         |
24
| parentPort<sup>(deprecated)</sup> | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscope) | 是   | 是   | worker线程用于与宿主线程通信的对象。<br/>此属性从API version 7开始支持,从API version 9 开始被废弃。<br/>建议使用workerPort<sup>9+</sup>替代。 |
Z
zengyawen 已提交
25 26 27


## WorkerOptions
Z
zengyawen 已提交
28

Z
zengyawen 已提交
29 30
Worker构造函数的选项信息,用于为Worker添加其他信息。

31
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
32

33
| 名称 | 类型 | 可读 | 可写 | 说明           |
34
| ---- | -------- | ---- | ---- | -------------- |
35
| type | "classic" \| "module" | 是   | 是   | Worker执行脚本的模式类型,默认为classic类型,暂不支持module类型。 |
36
| name | string   | 是   | 是   | Worker的名称。 |
37
| shared | boolean | 是   | 是   | 暂不支持共享Worker功能。 |
Z
zengyawen 已提交
38 39


40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
## ThreadWorker<sup>9+</sup>

使用以下方法前,均需先构造Worker实例,Worker类继承[WorkerEventTarget](#workereventtarget9)

### constructor<sup>9+</sup>

constructor(scriptURL: string, options?: WorkerOptions)

Worker构造函数。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名    | 类型                            | 必填 | 说明                                                         |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| scriptURL | string                          | 是   | Worker执行脚本的路径。<br/>在FA和Stage模型下,DevEco Studio新建Worker工程路径分别存在以下两种情况:<br/>(a) worker脚本所在目录与pages目录同级。<br/>(b) worker脚本所在目录与pages目录不同级。 |
| options   | [WorkerOptions](#workeroptions) | 否   | Worker构造的选项。                                           |

**返回值:**

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

**示例:**

```js
import worker from '@ohos.worker';
// worker线程创建

// FA模型-目录同级
const workerFAModel01 = new worker.ThreadWorker("workers/worker.js", {name:"first worker in FA model"});
// FA模型-目录不同级(以workers目录放置pages目录前一级为例)
const workerFAModel02 = new worker.ThreadWorker("../workers/worker.js");

// Stage模型-目录同级
const workerStageModel01 = new worker.ThreadWorker('entry/ets/workers/worker.ts', {name:"first worker in Stage model"});
// Stage模型-目录不同级(以workers目录放置pages目录后一级为例)
const workerStageModel02 = new worker.ThreadWorker('entry/ets/pages/workers/worker.ts');

// 理解Stage模型scriptURL的"entry/ets/workers/worker.ts":
// entry: 为module.json5文件中module的name属性对应的值;
// ets: 表明当前使用的语言。
```

同时,需在工程的模块级build-profile.json5文件的buildOption属性中添加配置信息,主要分为下面两种情况:

(1) 目录同级

FA模型:

```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/MainAbility/workers/worker.ts"
      ]
    }
  }
```

Stage模型:

```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/workers/worker.ts"
      ]
    }
  }
```

(2) 目录不同级

FA模型:

```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/workers/worker.ts"
      ]
    }
  }
```

Stage模型:

```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/pages/workers/worker.ts"
      ]
    }
  }
```


### postMessage<sup>9+</sup>

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

向Worker线程发送数据,数据类型必须是序列化所支持的类型。序列化支持类型见其他说明。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");

workerInstance.postMessage("hello world");

var buffer = new ArrayBuffer(8);
workerInstance.postMessage(buffer, [buffer]);
```


### on<sup>9+</sup>

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

Y
yqhan 已提交
172
向Worker添加一个事件监听,该接口与[addEventListener<sup>9+</sup>](#addeventlistener9)接口功能一致。
173 174 175 176 177 178 179 180

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名   | 类型                                         | 必填 | 说明                   |
| -------- | -------------------------------------------- | ---- | ---------------------- |
| type     | string                                       | 是   | 监听的事件类型。       |
181
| listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。回调事件。 |
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

**示例:**

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


### once<sup>9+</sup>

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

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名   | 类型                                         | 必填 | 说明                   |
| -------- | -------------------------------------------- | ---- | ---------------------- |
| type     | string                                       | 是   | 监听的事件类型。       |
206
| listener | [WorkerEventListener](#workereventlistener9) | 是 | 回调的事件。回调事件。 |
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221

**示例:**

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


### off<sup>9+</sup>

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

Y
yqhan 已提交
222
删除类型为type的事件监听,该接口与[removeEventListener<sup>9+</sup>](#removeeventlistener9)接口功能一致。
223 224 225 226 227 228 229 230

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名   | 类型                                         | 必填 | 说明                         |
| -------- | -------------------------------------------- | ---- | ---------------------------- |
| type     | string                                       | 是   | 需要删除的事件类型。         |
231
| listener | [WorkerEventListener](#workereventlistener9) | 否 | 回调的事件。删除的回调事件。 |
232 233 234 235 236

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
Y
yqhan 已提交
237
//使用on接口、once接口或addEventListener接口创建“alert”事件,使用off接口删除事件。
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
workerInstance.off("alert");
```


### terminate<sup>9+</sup>

terminate(): void

销毁Worker线程,终止Worker接收消息。

**系统能力:** SystemCapability.Utils.Lang

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
workerInstance.terminate();
```


### onexit<sup>9+</sup>

onexit?: (code: number) =&gt; void

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型   | 必填 | 说明               |
| ------ | ------ | ---- | ------------------ |
270
| code   | number | 是   | Worker退出的code。 |
271 272 273 274 275 276 277 278

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
workerInstance.onexit = function(e) {
    console.log("onexit");
}
Y
yqhan 已提交
279 280 281 282 283 284

//onexit被执行两种方式:
//主线程:
workerInstance.terminate();

//worker线程:
Y
yqhan 已提交
285
//parentPort.close()
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
```


### onerror<sup>9+</sup>

onerror?: (err: ErrorEvent) =&gt; void

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型                      | 必填 | 说明       |
| ------ | ------------------------- | ---- | ---------- |
301
| err    | [ErrorEvent](#errorevent) | 是   | 异常数据。 |
302 303 304 305 306 307 308 309 310 311 312 313 314

**示例:**

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


### onmessage<sup>9+</sup>

315
onmessage?: (event: MessageEvents) =&gt; void
316 317 318 319 320 321 322

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

323 324 325
| 参数名 | 类型                             | 必填 | 说明                   |
| ------ | -------------------------------- | ---- | ---------------------- |
| event  | [MessageEvents](#messageevents9) | 是   | 收到的Worker消息数据。 |
326 327 328 329 330 331

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
workerInstance.onmessage = function(e) {
Y
yqhan 已提交
332
    // e : MessageEvents, 用法如下:
333 334 335 336 337 338 339 340
    // let data = e.data;
    console.log("onmessage");
}
```


### onmessageerror<sup>9+</sup>

341
onmessageerror?: (event: MessageEvents) =&gt; void
342 343 344 345 346 347 348

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

349 350 351
| 参数名 | 类型                             | 必填 | 说明       |
| ------ | -------------------------------- | ---- | ---------- |
| event  | [MessageEvents](#messageevents9) | 是   | 异常数据。 |
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368

**示例:**

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


## WorkerEventTarget<sup>9+</sup>

### addEventListener<sup>9+</sup>

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

Y
yqhan 已提交
369
向Worker添加一个事件监听,该接口与[on<sup>9+</sup>](#on9)接口功能一致。
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名   | 类型                                         | 必填 | 说明             |
| -------- | -------------------------------------------- | ---- | ---------------- |
| type     | string                                       | 是   | 监听的事件类型。 |
| listener | [WorkerEventListener](#workereventlistener9) | 是   | 回调的事件。     |

**示例:**

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


### removeEventListener<sup>9+</sup>

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

Y
yqhan 已提交
394
删除Worker的事件监听,该接口与[off<sup>9+</sup>](#off9)接口功能一致。
395 396 397 398 399 400 401 402

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名   | 类型                                         | 必填 | 说明                         |
| -------- | -------------------------------------------- | ---- | ---------------------------- |
| type     | string                                       | 是   | 需要删除的监听事件类型。     |
403
| callback | [WorkerEventListener](#workereventlistener9) | 否 | 回调的事件。删除的回调事件。 |
404 405 406 407 408

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
Y
yqhan 已提交
409 410 411
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
412 413
workerInstance.removeEventListener("alert");
```
Z
zengyawen 已提交
414 415


416
### dispatchEvent<sup>9+</sup>
Z
zengyawen 已提交
417

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
dispatchEvent(event: Event): boolean

分发定义在Worker的事件。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

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

**返回值:**

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

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
Y
yqhan 已提交
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
//用法一:
workerInstance.on("alert_on", (e)=>{
    console.log("alert listener callback");
})
workerInstance.once("alert_once", (e)=>{
    console.log("alert listener callback");
})
workerInstance.addEventListener("alert_add", (e)=>{
    console.log("alert listener callback");
})

//once接口创建的事件执行一次便会删除。
workerInstance.dispatchEvent({type:"alert_once", timeStamp:0});
//on接口创建的事件可以一直被分发,不能主动删除。
workerInstance.dispatchEvent({type:"alert_on", timeStamp:0});
workerInstance.dispatchEvent({type:"alert_on", timeStamp:0});
//addEventListener接口创建的事件可以一直被分发,不能主动删除。
workerInstance.dispatchEvent({type:"alert_add", timeStamp:0});
workerInstance.dispatchEvent({type:"alert_add", timeStamp:0});

//用法二:
//event类型的type支持自定义,同时存在"message"/"messageerror"/"error"特殊类型,如下所示
//当type = "message",onmessage接口定义的方法同时会执行。
//当type = "messageerror",onmessageerror接口定义的方法同时会执行。
//当type = "error",onerror接口定义的方法同时会执行。
//若调用removeEventListener接口或者off接口取消事件时,能且只能取消使用addEventListener/on/once创建的事件。

workerInstance.addEventListener("message", (e)=>{
    console.log("message listener callback");
})
workerInstance.onmessage = function(e) {
    console.log("onmessage : message listener callback");
}
//调用dispatchEvent分发“message”事件,addEventListener和onmessage中定义的方法都会被执行。
workerInstance.dispatchEvent({type:"message", timeStamp:0});
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
```


### removeAllListener<sup>9+</sup>

removeAllListener(): void

删除Worker所有的事件监听。

**系统能力:** SystemCapability.Utils.Lang

**示例:**

```js
const workerInstance = new worker.ThreadWorker("workers/worker.js");
Y
yqhan 已提交
490 491 492
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
493 494 495 496 497 498
workerInstance.removeAllListener();
```


## ThreadWorkerGlobalScope<sup>9+</sup>

W
wangzhaoyong 已提交
499
Worker线程用于与宿主线程通信的类,通过postMessage接口发送消息给宿主线程、close接口销毁Worker线程。ThreadWorkerGlobalScope类继承[GlobalScope<sup>9+</sup>](#globalscope9)
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568


### postMessage<sup>9+</sup>

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

Worker线程向宿主线程发送消息。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| message | Object                                    | 是   | 发送至宿主线程的数据。                                       |
| options | [PostMessageOptions](#postmessageoptions) | 否   | 可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。 |

**示例:**

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

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


### close<sup>9+</sup>

close(): void

销毁Worker线程,终止Worker接收消息。

**系统能力:** SystemCapability.Utils.Lang

**示例:**

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

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


### onmessage<sup>9+</sup>

Y
yqhan 已提交
569
onmessage?: (this: ThreadWorkerGlobalScope, event: MessageEvents) =&gt; void
570 571 572 573 574 575 576

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

Y
yqhan 已提交
577 578 579 580
| 参数名 | 类型                                                 | 必填 | 说明                     |
| ------ | ---------------------------------------------------- | ---- | ------------------------ |
| this   | [ThreadWorkerGlobalScope](#threadworkerglobalscope9) | 是   | 指向调用者对象。         |
| event  | [MessageEvents](#messageevents9)                     | 是   | 收到宿主线程发送的数据。 |
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

**示例:**

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

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


### onmessageerror<sup>9+</sup>

Y
yqhan 已提交
603
onmessageerror?: (this: ThreadWorkerGlobalScope, event: MessageEvents) =&gt; void
604 605 606 607 608 609 610

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

611 612
| 参数名 | 类型                             | 必填 | 说明       |
| ------ | -------------------------------- | ---- | ---------- |
Y
yqhan 已提交
613
| this   | [ThreadWorkerGlobalScope](#threadworkerglobalscope9) | 是   | 指向调用者对象。         |
614
| event  | [MessageEvents](#messageevents9) | 是   | 异常数据。 |
615 616 617 618 619 620 621 622 623 624 625 626 627

**示例:**

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

```js
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.workerPort;
Y
yqhan 已提交
628
parentPort.onmessageerror = function(e) {
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
    console.log("worker.js onmessageerror")
}
```


## WorkerEventListener<sup>9+</sup>

(event: Event): void | Promise&lt;void&gt;

事件监听类。

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型            | 必填 | 说明           |
| ------ | --------------- | ---- | -------------- |
| event  | [Event](#event) | 是   | 回调的事件类。 |

**返回值:**

| 类型                                  | 说明                            |
| ------------------------------------- | ------------------------------- |
| void&nbsp;\|&nbsp;Promise&lt;void&gt; | 无返回值或者以Promise形式返回。 |

**示例:**

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


## GlobalScope<sup>9+</sup>

W
wangzhaoyong 已提交
666
Worker线程自身的运行环境,GlobalScope类继承[WorkerEventTarget](#workereventtarget9)
667 668 669 670 671

### 属性

**系统能力:** SystemCapability.Utils.Lang

672
| 名称 | 类型                                                         | 可读 | 可写 | 说明                                  |
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
| ---- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------- |
| name | string                                                       | 是   | 否   | Worker的名字,new&nbsp;Worker时指定。 |
| self | [GlobalScope](#globalscope9)&nbsp;&amp;&nbsp;typeof&nbsp;globalThis | 是   | 否   | GlobalScope本身。                     |


### onerror<sup>9+</sup>

onerror?: (ev: ErrorEvent) =&gt; void

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

**系统能力:** SystemCapability.Utils.Lang

**参数:**

| 参数名 | 类型                      | 必填 | 说明       |
| ------ | ------------------------- | ---- | ---------- |
690
| ev     | [ErrorEvent](#errorevent) | 是   | 异常数据。 |
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

**示例:**

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

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

709 710 711 712 713 714 715 716 717
## MessageEvents<sup>9+</sup>

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

**系统能力:** SystemCapability.Utils.Lang

| 名称 | 类型 | 可读 | 可写 | 说明               |
| ---- | ---- | ---- | ---- | ------------------ |
| data | any  | 是   | 否   | 线程间传递的数据。 |
718 719 720 721 722 723 724

## Worker<sup>(deprecated)</sup>


使用以下方法前,均需先构造Worker实例,Worker类继承[EventTarget](#eventtarget)

> **说明:**<br/>
725 726 727
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker<sup>9+</sup>](#threadworker9)替代。

### constructor<sup>(deprecated)</sup>
Z
zengyawen 已提交
728 729

constructor(scriptURL: string, options?: WorkerOptions)
Z
zengyawen 已提交
730

Z
zengyawen 已提交
731 732
Worker构造函数。

733 734 735
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.constructor<sup>9+</sup>](#constructor9)替代。

Z
zengyawen 已提交
736
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
737

Z
zengyawen 已提交
738 739
**参数:**

Z
zengyawen 已提交
740 741
| 参数名    | 类型                            | 必填 | 说明                                                         |
| --------- | ------------------------------- | ---- | ------------------------------------------------------------ |
742
| scriptURL | string                          | 是   | Worker执行脚本的路径。<br/>在FA和Stage模型下,DevEco Studio新建Worker工程路径分别存在以下两种情况:<br/>(a) worker脚本所在目录与pages目录同级。<br/>(b) worker脚本所在目录与pages目录不同级。 |
Z
zengyawen 已提交
743
| options   | [WorkerOptions](#workeroptions) | 否   | Worker构造的选项。                                           |
Z
zengyawen 已提交
744

Z
zengyawen 已提交
745
**返回值:**
Z
zengyawen 已提交
746

Z
zengyawen 已提交
747 748 749
| 类型   | 说明                                                      |
| ------ | --------------------------------------------------------- |
| Worker | 执行Worker构造函数生成的Worker对象,失败则返回undefined。 |
Z
zengyawen 已提交
750 751 752

**示例:**

Y
yqhan 已提交
753
```js
W
wangzhaoyong 已提交
754
import worker from '@ohos.worker';
Y
yqhan 已提交
755 756 757
// worker线程创建

// FA模型-目录同级
W
wangzhaoyong 已提交
758
const workerFAModel01 = new worker.Worker("workers/worker.js", {name:"first worker in FA model"});
Y
yqhan 已提交
759
// FA模型-目录不同级(以workers目录放置pages目录前一级为例)
W
wangzhaoyong 已提交
760
const workerFAModel02 = new worker.Worker("../workers/worker.js");
Y
yqhan 已提交
761 762

// Stage模型-目录同级
W
wangzhaoyong 已提交
763
const workerStageModel01 = new worker.Worker('entry/ets/workers/worker.ts', {name:"first worker in Stage model"});
Y
yqhan 已提交
764
// Stage模型-目录不同级(以workers目录放置pages目录后一级为例)
W
wangzhaoyong 已提交
765
const workerStageModel02 = new worker.Worker('entry/ets/pages/workers/worker.ts');
Y
yqhan 已提交
766

W
wangzhaoyong 已提交
767 768
// 理解Stage模型scriptURL的"entry/ets/workers/worker.ts":
// entry: 为module.json5文件中module的name属性对应的值;
Y
yqhan 已提交
769 770
// ets: 表明当前使用的语言。
```
W
wangzhaoyong 已提交
771
同时,需在工程的模块级build-profile.json5文件的buildOption属性中添加配置信息,主要分为下面两种情况:
Y
yqhan 已提交
772

W
wangzhaoyong 已提交
773
(1) 目录同级
W
wangzhaoyong 已提交
774

Y
yqhan 已提交
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
FA模型:

```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/MainAbility/workers/worker.ts"
      ]
    }
  }
```
Stage模型:
```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/workers/worker.ts"
      ]
    }
  }
```
W
wangzhaoyong 已提交
796
(2) 目录不同级
W
wangzhaoyong 已提交
797

Y
yqhan 已提交
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
FA模型:
```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/workers/worker.ts"
      ]
    }
  }
```
Stage模型:
```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/pages/workers/worker.ts"
      ]
    }
  }
Z
zengyawen 已提交
817
```
818 819
### postMessage<sup>(deprecated)</sup>

Z
zengyawen 已提交
820
postMessage(message: Object, options?: PostMessageOptions): void
Z
zengyawen 已提交
821

W
wangzhaoyong 已提交
822
向Worker线程发送数据,数据类型必须是序列化所支持的类型。序列化支持类型见其他说明。
Z
zengyawen 已提交
823

824 825 826
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.postMessage<sup>9+</sup>](#postmessage9)替代。

Z
zengyawen 已提交
827
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
828

Z
zengyawen 已提交
829 830
**参数:**

Z
zengyawen 已提交
831 832 833 834
| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| message | Object                                    | 是   | 发送至Worker的数据。                                         |
| options | [PostMessageOptions](#postmessageoptions) | 否   | 可转移对象是&nbsp;ArrayBuffer&nbsp;的实例对象。transferList数组中不可传入null。 |
Z
zengyawen 已提交
835

Z
zengyawen 已提交
836 837
**示例:**

Y
yqhan 已提交
838
```js
Z
zengyawen 已提交
839
const workerInstance = new worker.Worker("workers/worker.js");
W
wangzhaoyong 已提交
840

Z
zengyawen 已提交
841
workerInstance.postMessage("hello world");
W
wangzhaoyong 已提交
842

Z
zengyawen 已提交
843 844 845
var buffer = new ArrayBuffer(8);
workerInstance.postMessage(buffer, [buffer]);
```
Z
zengyawen 已提交
846 847


848 849
### on<sup>(deprecated)</sup>

Z
zengyawen 已提交
850
on(type: string, listener: EventListener): void
Z
zengyawen 已提交
851

Y
yqhan 已提交
852
向Worker添加一个事件监听,该接口与[addEventListener<sup>(deprecated)</sup>](#addeventlistenerdeprecated)接口功能一致。
Z
zengyawen 已提交
853

854 855 856
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.on<sup>9+</sup>](#on9)替代。

Z
zengyawen 已提交
857
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
858

Z
zengyawen 已提交
859
**参数:**
Z
zengyawen 已提交
860

Z
zengyawen 已提交
861 862
| 参数名   | 类型                            | 必填 | 说明             |
| -------- | ------------------------------- | ---- | ---------------- |
W
wangzhaoyong 已提交
863
| type     | string                          | 是   | 监听的事件类型。 |
864
| listener | [EventListener](#eventlistener) | 是   | 回调事件。       |
Z
zengyawen 已提交
865 866 867

**示例:**

Y
yqhan 已提交
868 869
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
870 871 872 873
workerInstance.on("alert", (e)=>{
    console.log("alert listener callback");
})
```
Z
zengyawen 已提交
874 875


876 877
### once<sup>(deprecated)</sup>

Z
zengyawen 已提交
878
once(type: string, listener: EventListener): void
Z
zengyawen 已提交
879

Z
zengyawen 已提交
880 881
向Worker添加一个事件监听,事件监听只执行一次便自动删除。

882 883 884
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.once<sup>9+</sup>](#once9)替代。

Z
zengyawen 已提交
885
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
886

Z
zengyawen 已提交
887
**参数:**
Z
zengyawen 已提交
888

Z
zengyawen 已提交
889 890
| 参数名   | 类型                            | 必填 | 说明             |
| -------- | ------------------------------- | ---- | ---------------- |
W
wangzhaoyong 已提交
891
| type     | string                          | 是   | 监听的事件类型。 |
892
| listener | [EventListener](#eventlistener) | 是   | 回调事件。       |
Z
zengyawen 已提交
893 894 895

**示例:**

Y
yqhan 已提交
896
```js
Z
zengyawen 已提交
897 898 899 900 901
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.once("alert", (e)=>{
    console.log("alert listener callback");
})
```
Z
zengyawen 已提交
902 903


904 905
### off<sup>(deprecated)</sup>

Z
zengyawen 已提交
906
off(type: string, listener?: EventListener): void
Z
zengyawen 已提交
907

Y
yqhan 已提交
908
删除类型为type的事件监听,该接口与[removeEventListener<sup>(deprecated)</sup>](#removeeventlistenerdeprecated)接口功能一致。
Z
zengyawen 已提交
909

910 911 912
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.off<sup>9+</sup>](#off9)替代。

Z
zengyawen 已提交
913
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
914

Z
zengyawen 已提交
915
**参数:**
Z
zengyawen 已提交
916

917 918 919 920
| 参数名   | 类型                            | 必填 | 说明                 |
| -------- | ------------------------------- | ---- | -------------------- |
| type     | string                          | 是   | 需要删除的事件类型。 |
| listener | [EventListener](#eventlistener) | 否   | 删除的回调事件。     |
Z
zengyawen 已提交
921 922 923

**示例:**

Y
yqhan 已提交
924
```js
Z
zengyawen 已提交
925
const workerInstance = new worker.Worker("workers/worker.js");
Y
yqhan 已提交
926
//使用on接口、once接口或addEventListener接口创建“alert”事件,使用off接口删除事件。
Z
zengyawen 已提交
927 928
workerInstance.off("alert");
```
Z
zengyawen 已提交
929 930


931 932
### terminate<sup>(deprecated)</sup>

Z
zengyawen 已提交
933 934
terminate(): void

W
wangzhaoyong 已提交
935
销毁Worker线程,终止Worker接收消息。
Z
zengyawen 已提交
936

937 938 939
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.terminate<sup>9+</sup>](#terminate9)替代。

Z
zengyawen 已提交
940
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
941

Z
zengyawen 已提交
942 943
**示例:**

Y
yqhan 已提交
944 945 946
```js
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.terminate();
Z
zengyawen 已提交
947
```
Z
zengyawen 已提交
948 949


950 951
### onexit<sup>(deprecated)</sup>

Z
zengyawen 已提交
952
onexit?: (code: number) =&gt; void
Z
zengyawen 已提交
953

W
wangzhaoyong 已提交
954
Worker对象的onexit属性表示Worker销毁时被调用的事件处理程序,处理程序在宿主线程中执行。
Z
zengyawen 已提交
955

956 957 958
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.onexit<sup>9+</sup>](#onexit9)替代。

Z
zengyawen 已提交
959
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
960

Z
zengyawen 已提交
961
**参数:**
Z
zengyawen 已提交
962

Z
zengyawen 已提交
963 964
| 参数名 | 类型   | 必填 | 说明               |
| ------ | ------ | ---- | ------------------ |
965
| code   | number | 是   | Worker退出的code。 |
Z
zengyawen 已提交
966 967 968

**示例:**

Y
yqhan 已提交
969 970
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
971
workerInstance.onexit = function(e) {
Y
yqhan 已提交
972
    console.log("onexit");
Z
zengyawen 已提交
973
}
Y
yqhan 已提交
974 975 976 977 978 979

//onexit被执行两种方式:
//主线程:
workerInstance.terminate();

//worker线程:
Y
yqhan 已提交
980
//parentPort.close()
Z
zengyawen 已提交
981
```
Z
zengyawen 已提交
982 983


984 985
### onerror<sup>(deprecated)</sup>

Z
zengyawen 已提交
986
onerror?: (err: ErrorEvent) =&gt; void
Z
zengyawen 已提交
987

Z
zengyawen 已提交
988 989
Worker对象的onerror属性表示Worker在执行过程中发生异常被调用的事件处理程序,处理程序在宿主线程中执行。

990 991 992
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.onerror<sup>9+</sup>](#onerror9)替代。

Z
zengyawen 已提交
993
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
994

Z
zengyawen 已提交
995
**参数:**
Z
zengyawen 已提交
996

Z
zengyawen 已提交
997 998
| 参数名 | 类型                      | 必填 | 说明       |
| ------ | ------------------------- | ---- | ---------- |
999
| err    | [ErrorEvent](#errorevent) | 是   | 异常数据。 |
Z
zengyawen 已提交
1000 1001 1002

**示例:**

Y
yqhan 已提交
1003 1004
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1005
workerInstance.onerror = function(e) {
Y
yqhan 已提交
1006
    console.log("onerror");
Z
zengyawen 已提交
1007 1008
}
```
Z
zengyawen 已提交
1009 1010


1011 1012
### onmessage<sup>(deprecated)</sup>

Y
yqhan 已提交
1013
onmessage?: (event: MessageEvent) =&gt; void
Z
zengyawen 已提交
1014

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

1017 1018 1019
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.onmessage<sup>9+</sup>](#onmessage9)替代。

Z
zengyawen 已提交
1020
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1021

Z
zengyawen 已提交
1022 1023
**参数:**

Y
yqhan 已提交
1024 1025 1026
| 参数名 | 类型                           | 必填 | 说明                   |
| ------ | ------------------------------ | ---- | ---------------------- |
| event  | [MessageEvent](#messageeventt) | 是   | 收到的Worker消息数据。 |
Z
zengyawen 已提交
1027 1028

**示例:**
Z
zengyawen 已提交
1029

Y
yqhan 已提交
1030 1031
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1032
workerInstance.onmessage = function(e) {
Y
yqhan 已提交
1033
    // e : MessageEvent, 用法如下:
Y
yqhan 已提交
1034 1035
    // let data = e.data;
    console.log("onmessage");
Z
zengyawen 已提交
1036 1037
}
```
Z
zengyawen 已提交
1038 1039


1040 1041
### onmessageerror<sup>(deprecated)</sup>

Y
yqhan 已提交
1042
onmessageerror?: (event: MessageEvent) =&gt; void
Z
zengyawen 已提交
1043

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

1046 1047 1048
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorker.onmessageerror<sup>9+</sup>](#onmessageerror9)替代。

Z
zengyawen 已提交
1049
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1050

Z
zengyawen 已提交
1051 1052
**参数:**

Y
yqhan 已提交
1053 1054 1055
| 参数名 | 类型                           | 必填 | 说明       |
| ------ | ------------------------------ | ---- | ---------- |
| event  | [MessageEvent](#messageeventt) | 是   | 异常数据。 |
Z
zengyawen 已提交
1056

Z
zengyawen 已提交
1057 1058
**示例:**

Y
yqhan 已提交
1059 1060
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1061
workerInstance.onmessageerror= function(e) {
Y
yqhan 已提交
1062
    console.log("onmessageerror");
Z
zengyawen 已提交
1063 1064
}
```
Z
zengyawen 已提交
1065 1066


1067 1068
## EventTarget<sup>(deprecated)</sup>
> **说明:**<br/>
1069
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[WorkerEventTarget<sup>9+</sup>](#workereventtarget9)替代。
Z
zengyawen 已提交
1070

1071
### addEventListener<sup>(deprecated)</sup>
Z
zengyawen 已提交
1072 1073

addEventListener(type: string, listener: EventListener): void
Z
zengyawen 已提交
1074

Y
yqhan 已提交
1075
向Worker添加一个事件监听,该接口与[on<sup>(deprecated)</sup>](#ondeprecated)接口功能一致。
Z
zengyawen 已提交
1076

1077 1078 1079
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[addEventListener<sup>9+</sup>](#addeventlistener9)替代。

Z
zengyawen 已提交
1080
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1081

Z
zengyawen 已提交
1082 1083
**参数:**

Z
zengyawen 已提交
1084 1085
| 参数名   | 类型                            | 必填 | 说明             |
| -------- | ------------------------------- | ---- | ---------------- |
W
wangzhaoyong 已提交
1086
| type     | string                          | 是   | 监听的事件类型。 |
Z
zengyawen 已提交
1087
| listener | [EventListener](#eventlistener) | 是   | 回调的事件。     |
Z
zengyawen 已提交
1088

Z
zengyawen 已提交
1089 1090
**示例:**

Y
yqhan 已提交
1091 1092
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1093 1094 1095 1096
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
```
Z
zengyawen 已提交
1097 1098


1099 1100
### removeEventListener<sup>(deprecated)</sup>

Z
zengyawen 已提交
1101
removeEventListener(type: string, callback?: EventListener): void
Z
zengyawen 已提交
1102

Y
yqhan 已提交
1103
删除Worker的事件监听,该接口与[off<sup>(deprecated)</sup>](#offdeprecated)接口功能一致。
Z
zengyawen 已提交
1104

1105 1106 1107
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[removeEventListener<sup>9+</sup>](#removeeventlistener9)替代。

Z
zengyawen 已提交
1108
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1109

Z
zengyawen 已提交
1110
**参数:**
Z
zengyawen 已提交
1111

1112 1113
| 参数名   | 类型                            | 必填 | 说明                     |
| -------- | ------------------------------- | ---- | ------------------------ |
W
wangzhaoyong 已提交
1114
| type     | string                          | 是   | 需要删除的监听事件类型。 |
1115
| callback | [EventListener](#eventlistener) | 否   | 删除的回调事件。         |
Z
zengyawen 已提交
1116 1117 1118

**示例:**

Y
yqhan 已提交
1119 1120
```js
const workerInstance = new worker.Worker("workers/worker.js");
Y
yqhan 已提交
1121 1122 1123
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
Y
yqhan 已提交
1124
workerInstance.removeEventListener("alert");
Z
zengyawen 已提交
1125
```
Z
zengyawen 已提交
1126 1127


1128 1129
### dispatchEvent<sup>(deprecated)</sup>

Z
zengyawen 已提交
1130
dispatchEvent(event: Event): boolean
Z
zengyawen 已提交
1131

Z
zengyawen 已提交
1132 1133
分发定义在Worker的事件。

1134 1135 1136
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[dispatchEvent<sup>9+</sup>](#dispatchevent9)替代。

Z
zengyawen 已提交
1137
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1138

Z
zengyawen 已提交
1139 1140
**参数:**

Z
zengyawen 已提交
1141 1142 1143
| 参数名 | 类型            | 必填 | 说明             |
| ------ | --------------- | ---- | ---------------- |
| event  | [Event](#event) | 是   | 需要分发的事件。 |
Z
zengyawen 已提交
1144 1145

**返回值:**
Z
zengyawen 已提交
1146

Z
zengyawen 已提交
1147 1148
| 类型    | 说明                            |
| ------- | ------------------------------- |
Z
zengyawen 已提交
1149
| boolean | 分发的结果,false表示分发失败。 |
Z
zengyawen 已提交
1150

Z
zengyawen 已提交
1151 1152
**示例:**

Y
yqhan 已提交
1153 1154
```js
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1155

Y
yqhan 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
//用法一:
workerInstance.on("alert_on", (e)=>{
    console.log("alert listener callback");
})
workerInstance.once("alert_once", (e)=>{
    console.log("alert listener callback");
})
workerInstance.addEventListener("alert_add", (e)=>{
    console.log("alert listener callback");
})
Z
zengyawen 已提交
1166

Y
yqhan 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
//once接口创建的事件执行一次便会删除。
workerInstance.dispatchEvent({type:"alert_once", timeStamp:0});
//on接口创建的事件可以一直被分发,不能主动删除。
workerInstance.dispatchEvent({type:"alert_on", timeStamp:0});
workerInstance.dispatchEvent({type:"alert_on", timeStamp:0});
//addEventListener接口创建的事件可以一直被分发,不能主动删除。
workerInstance.dispatchEvent({type:"alert_add", timeStamp:0});
workerInstance.dispatchEvent({type:"alert_add", timeStamp:0});

//用法二:
//event类型的type支持自定义,同时存在"message"/"messageerror"/"error"特殊类型,如下所示
//当type = "message",onmessage接口定义的方法同时会执行。
//当type = "messageerror",onmessageerror接口定义的方法同时会执行。
//当type = "error",onerror接口定义的方法同时会执行。
//若调用removeEventListener接口或者off接口取消事件时,能且只能取消使用addEventListener/on/once创建的事件。

workerInstance.addEventListener("message", (e)=>{
    console.log("message listener callback");
})
workerInstance.onmessage = function(e) {
    console.log("onmessage : message listener callback");
}
//调用dispatchEvent分发“message”事件,addEventListener和onmessage中定义的方法都会被执行。
workerInstance.dispatchEvent({type:"message", timeStamp:0});
```
1192 1193
### removeAllListener<sup>(deprecated)</sup>

Z
zengyawen 已提交
1194
removeAllListener(): void
Z
zengyawen 已提交
1195

W
wangzhaoyong 已提交
1196
删除Worker所有的事件监听。
Z
zengyawen 已提交
1197

1198 1199 1200
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[removeAllListener<sup>9+</sup>](#removealllistener9)替代。

Z
zengyawen 已提交
1201
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1202

Z
zengyawen 已提交
1203 1204
**示例:**

Y
yqhan 已提交
1205 1206
```js
const workerInstance = new worker.Worker("workers/worker.js");
Y
yqhan 已提交
1207 1208 1209
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
Y
yqhan 已提交
1210
workerInstance.removeAllListener();
Z
zengyawen 已提交
1211
```
Z
zengyawen 已提交
1212 1213


1214 1215
## DedicatedWorkerGlobalScope<sup>(deprecated)</sup>

W
wangzhaoyong 已提交
1216
Worker线程用于与宿主线程通信的类,通过postMessage接口发送消息给宿主线程、close接口销毁Worker线程。DedicatedWorkerGlobalScope类继承[WorkerGlobalScope](#workerglobalscope)
Z
zengyawen 已提交
1217

1218 1219
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorkerGlobalScope<sup>9+</sup>](#threadworkerglobalscope9)替代。
Z
zengyawen 已提交
1220

1221 1222
### postMessage<sup>(deprecated)</sup>

Y
yqhan 已提交
1223
postMessage(messageObject: Object, options?: PostMessageOptions): void
Z
zengyawen 已提交
1224

W
wangzhaoyong 已提交
1225
Worker线程向宿主线程发送消息。
Z
zengyawen 已提交
1226

1227 1228 1229
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorkerGlobalScope<sup>9+</sup>](#threadworkerglobalscope9).postMessage<sup>9+</sup>替代。

Z
zengyawen 已提交
1230
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1231

Z
zengyawen 已提交
1232 1233
**参数:**

Z
zengyawen 已提交
1234 1235
| 参数名  | 类型                                      | 必填 | 说明                                                         |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
1236
| message | Object                                    | 是   | 发送至宿主线程的数据。                                       |
Z
zengyawen 已提交
1237
| options | [PostMessageOptions](#postmessageoptions) | 否   | 可转移对象是ArrayBuffer的实例对象。transferList数组中不可传入null。 |
Z
zengyawen 已提交
1238 1239 1240

**示例:**

Y
yqhan 已提交
1241
```js
Z
zengyawen 已提交
1242 1243
// main.js
import worker from '@ohos.worker';
Y
yqhan 已提交
1244 1245
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.postMessage("hello world");
Z
zengyawen 已提交
1246
workerInstance.onmessage = function(e) {
Y
yqhan 已提交
1247 1248
    // let data = e.data;
    console.log("receive data from worker.js");
Z
zengyawen 已提交
1249 1250
}
```
Y
yqhan 已提交
1251
```js
Z
zengyawen 已提交
1252 1253 1254 1255
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e){
Y
yqhan 已提交
1256 1257
    // let data = e.data;
    parentPort.postMessage("receive data from main.js");
Z
zengyawen 已提交
1258 1259
}
```
Z
zengyawen 已提交
1260 1261


1262 1263
### close<sup>(deprecated)</sup>

Z
zengyawen 已提交
1264
close(): void
Z
zengyawen 已提交
1265

W
wangzhaoyong 已提交
1266
销毁Worker线程,终止Worker接收消息。
Z
zengyawen 已提交
1267

1268 1269 1270
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorkerGlobalScope<sup>9+</sup>](#threadworkerglobalscope9).close<sup>9+</sup>替代。

Z
zengyawen 已提交
1271
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1272

Z
zengyawen 已提交
1273 1274
**示例:**

Y
yqhan 已提交
1275
```js
Z
zengyawen 已提交
1276 1277
// main.js
import worker from '@ohos.worker';
Y
yqhan 已提交
1278
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1279
```
Y
yqhan 已提交
1280
```js
Z
zengyawen 已提交
1281 1282 1283 1284 1285 1286 1287
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
    parentPort.close()
}
```
Z
zengyawen 已提交
1288 1289


1290 1291
### onmessage<sup>(deprecated)</sup>

Y
yqhan 已提交
1292
onmessage?: (this: DedicatedWorkerGlobalScope, event: MessageEvent) =&gt; void
Z
zengyawen 已提交
1293

W
wangzhaoyong 已提交
1294
DedicatedWorkerGlobalScope的onmessage属性表示Worker线程收到来自其宿主线程通过postMessage接口发送的消息时被调用的事件处理程序,处理程序在Worker线程中执行。
Z
zengyawen 已提交
1295

1296 1297 1298
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorkerGlobalScope<sup>9+</sup>](#threadworkerglobalscope9).onmessage<sup>9+</sup>替代。

Z
zengyawen 已提交
1299
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1300

Z
zengyawen 已提交
1301 1302
**参数:**

Y
yqhan 已提交
1303 1304 1305 1306
| 参数名 | 类型                                                         | 必填 | 说明                     |
| ------ | ------------------------------------------------------------ | ---- | ------------------------ |
| this   | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscopedeprecated) | 是   | 指向调用者对象。         |
| event  | [MessageEvent](#messageeventt)                               | 是   | 收到宿主线程发送的数据。 |
Z
zengyawen 已提交
1307 1308 1309

**示例:**

Y
yqhan 已提交
1310
```js
Z
zengyawen 已提交
1311 1312
// main.js
import worker from '@ohos.worker';
Y
yqhan 已提交
1313 1314
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.postMessage("hello world");
Z
zengyawen 已提交
1315
```
Y
yqhan 已提交
1316
```js
Z
zengyawen 已提交
1317 1318 1319 1320
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
parentPort.onmessage = function(e) {
Y
yqhan 已提交
1321
    console.log("receive main.js message");
Z
zengyawen 已提交
1322 1323
}
```
Z
zengyawen 已提交
1324 1325


1326 1327
### onmessageerror<sup>(deprecated)</sup>

Y
yqhan 已提交
1328
onmessageerror?: (this: DedicatedWorkerGlobalScope, event: MessageEvent) =&gt; void
Z
zengyawen 已提交
1329

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

1332 1333 1334
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[ThreadWorkerGlobalScope<sup>9+</sup>](#threadworkerglobalscope9).onmessageerror<sup>9+</sup>替代。

Z
zengyawen 已提交
1335
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1336

Z
zengyawen 已提交
1337 1338
**参数:**

Y
yqhan 已提交
1339 1340
| 参数名 | 类型                           | 必填 | 说明       |
| ------ | ------------------------------ | ---- | ---------- |
Y
yqhan 已提交
1341
| this   | [DedicatedWorkerGlobalScope](#dedicatedworkerglobalscopedeprecated) | 是   | 指向调用者对象。 |
Y
yqhan 已提交
1342
| event  | [MessageEvent](#messageeventt) | 是   | 异常数据。 |
Z
zengyawen 已提交
1343 1344 1345

**示例:**

Y
yqhan 已提交
1346
```js
Z
zengyawen 已提交
1347 1348
// main.js
import worker from '@ohos.worker';
Y
yqhan 已提交
1349
const workerInstance = new worker.Worker("workers/worker.js");
Z
zengyawen 已提交
1350
```
Y
yqhan 已提交
1351
```js
Z
zengyawen 已提交
1352 1353 1354
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort;
Y
yqhan 已提交
1355
parentPort.onmessageerror = function(e) {
Z
zengyawen 已提交
1356 1357 1358
    console.log("worker.js onmessageerror")
}
```
Z
zengyawen 已提交
1359 1360 1361


## PostMessageOptions
Z
zengyawen 已提交
1362 1363 1364

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

1365
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1366

1367
| 名称     | 类型     | 可读 | 可写 | 说明                              |
Z
zengyawen 已提交
1368 1369
| -------- | -------- | ---- | ---- | --------------------------------- |
| transfer | Object[] | 是   | 是   | ArrayBuffer数组,用于传递所有权。 |
Z
zengyawen 已提交
1370 1371 1372


## Event
Z
zengyawen 已提交
1373 1374 1375

事件类。

1376
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1377

1378 1379 1380 1381
| 名称      | 类型   | 可读 | 可写 | 说明                               |
| --------- | ------ | ---- | ---- | ---------------------------------- |
| type      | string | 是   | 否   | 指定事件的类型。                   |
| timeStamp | number | 是   | 否   | 事件创建时的时间戳(精度为毫秒)。 |
Z
zengyawen 已提交
1382 1383


1384 1385
## EventListener<sup>(deprecated)</sup>

1386
(evt: Event): void | Promise&lt;void&gt;
Z
zengyawen 已提交
1387

1388
事件监听类。
Z
zengyawen 已提交
1389

1390 1391 1392
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[WorkerEventListener<sup>9+</sup>](#workereventlistener9)替代。

Z
zengyawen 已提交
1393 1394
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
1395
**参数:**
Z
zengyawen 已提交
1396

Z
zengyawen 已提交
1397 1398 1399
| 参数名 | 类型            | 必填 | 说明           |
| ------ | --------------- | ---- | -------------- |
| evt    | [Event](#event) | 是   | 回调的事件类。 |
Z
zengyawen 已提交
1400

Z
zengyawen 已提交
1401 1402
**返回值:**

Z
zengyawen 已提交
1403 1404
| 类型                                  | 说明                            |
| ------------------------------------- | ------------------------------- |
Z
zengyawen 已提交
1405 1406 1407 1408
| void&nbsp;\|&nbsp;Promise&lt;void&gt; | 无返回值或者以Promise形式返回。 |

**示例:**

Y
yqhan 已提交
1409
```js
Z
zengyawen 已提交
1410 1411 1412 1413 1414
const workerInstance = new worker.Worker("workers/worker.js");
workerInstance.addEventListener("alert", (e)=>{
    console.log("alert listener callback");
})
```
Z
zengyawen 已提交
1415 1416 1417 1418


## ErrorEvent

Z
zengyawen 已提交
1419 1420
错误事件类,用于表示Worker执行过程中出现异常的详细信息,ErrorEvent类继承[Event](#event)

1421
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1422

1423 1424 1425 1426 1427 1428 1429
| 名称     | 类型   | 可读 | 可写 | 说明                 |
| -------- | ------ | ---- | ---- | -------------------- |
| message  | string | 是   | 否   | 异常发生的错误信息。 |
| filename | string | 是   | 否   | 出现异常所在的文件。 |
| lineno   | number | 是   | 否   | 异常所在的行数。     |
| colno    | number | 是   | 否   | 异常所在的列数。     |
| error    | Object | 是   | 否   | 异常类型。           |
Z
zengyawen 已提交
1430 1431


1432
## MessageEvent\<T\>
Z
zengyawen 已提交
1433

Z
zengyawen 已提交
1434
消息类,持有Worker线程间传递的数据。
Z
zengyawen 已提交
1435

1436
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1437

1438
| 名称 | 类型 | 可读 | 可写 | 说明               |
1439 1440
| ---- | ---- | ---- | ---- | ------------------ |
| data | T    | 是   | 否   | 线程间传递的数据。 |
Z
zengyawen 已提交
1441 1442


1443 1444
## WorkerGlobalScope<sup>(deprecated)</sup>

Z
zengyawen 已提交
1445
Worker线程自身的运行环境,WorkerGlobalScope类继承[EventTarget](#eventtarget)
Z
zengyawen 已提交
1446

1447 1448 1449
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[GlobalScope<sup>9+</sup>](#globalscope9)替代。

Z
zengyawen 已提交
1450
### 属性
Z
zengyawen 已提交
1451

1452
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1453

1454
| 名称 | 类型                                                         | 可读 | 可写 | 说明                                  |
1455
| ---- | ------------------------------------------------------------ | ---- | ---- | ------------------------------------- |
W
wangzhaoyong 已提交
1456
| name | string                                                       | 是   | 否   | Worker的名字,new&nbsp;Worker时指定。 |
1457 1458
| self | [WorkerGlobalScope](#workerglobalscope)&nbsp;&amp;&nbsp;typeof&nbsp;globalThis | 是   | 否   | WorkerGlobalScope本身。               |

Z
zengyawen 已提交
1459

1460
### onerror<sup>(deprecated)</sup>
Z
zengyawen 已提交
1461 1462 1463

onerror?: (ev: ErrorEvent) =&gt; void

Z
zengyawen 已提交
1464 1465
WorkerGlobalScope的onerror属性表示Worker在执行过程中发生异常被调用的事件处理程序,处理程序在Worker线程中执行。

1466 1467 1468
> **说明:**<br/>
> 从API version 7 开始支持,从API version 9 开始废弃,建议使用[GlobalScope<sup>9+</sup>](#globalscope9).onerror替代。

Z
zengyawen 已提交
1469
**系统能力:** SystemCapability.Utils.Lang
Z
zengyawen 已提交
1470

Z
zengyawen 已提交
1471 1472
**参数:**

Z
zengyawen 已提交
1473 1474
| 参数名 | 类型                      | 必填 | 说明       |
| ------ | ------------------------- | ---- | ---------- |
1475
| ev     | [ErrorEvent](#errorevent) | 是   | 异常数据。 |
Z
zengyawen 已提交
1476 1477

**示例:**
Z
zengyawen 已提交
1478

Y
yqhan 已提交
1479
```js
Z
zengyawen 已提交
1480 1481 1482 1483
// main.js
import worker from '@ohos.worker';
const workerInstance = new worker.Worker("workers/worker.js")
```
Y
yqhan 已提交
1484
```js
Z
zengyawen 已提交
1485 1486 1487 1488 1489 1490
// worker.js
import worker from '@ohos.worker';
const parentPort = worker.parentPort
parentPort.onerror = function(e){
    console.log("worker.js onerror")
}
Y
yqhan 已提交
1491 1492
```

1493

W
wangzhaoyong 已提交
1494 1495
## 其他说明

W
wangzhaoyong 已提交
1496
### 序列化支持类型
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
| Type               | 备注                                   | 是否支持 |
| ------------------ | -------------------------------------- | -------- |
| All Primitive Type | 不包括symbol                           | 是       |
| Date               |                                        | 是       |
| String             |                                        | 是       |
| RegExp             |                                        | 是       |
| Array              |                                        | 是       |
| Map                |                                        | 是       |
| Set                |                                        | 是       |
| Object             | 只支持Plain Object,不支持带function的 | 是       |
| ArrayBuffer        | 提供transfer能力                       | 是       |
| TypedArray         |                                        | 是       |
W
wangzhaoyong 已提交
1509

1510
特例:传递通过自定义class创建出来的object时,不会发生序列化错误,但是自定义class的属性(如Function)无法通过序列化传递。
1511 1512 1513
> **说明:**<br/>
> 以API version 9的FA工程为例。

1514 1515 1516
```js
// main.js
import worker from '@ohos.worker';
W
wangzhaoyong 已提交
1517
const workerInstance = new worker.ThreadWorker("workers/worker.js");
1518 1519 1520 1521 1522 1523 1524 1525 1526
workerInstance.postMessage("message from main to worker");
workerInstance.onmessage = function(d) {
  // 当worker线程传递obj2时,data即为obj2。data没有Init、SetName的方法
  let data = d.data;
}
```
```js
// worker.js
import worker from '@ohos.worker';
1527
const parentPort = worker.workerPort;
1528
class MyModel {
小马奔腾 已提交
1529
    name = "undefined"
1530
    Init() {
W
wangzhaoyong 已提交
1531
        this.name = "MyModel"
1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
    }
}
parentPort.onmessage = function(d) {
    console.log("worker.js onmessage");
    let data = d.data;
    let func1 = function() {
        console.log("post message is function");
    }
    let obj1 = {
        "index": 2,
        "name1": "zhangshan",
        setName() {
            this.index = 3;
        }
    }
    let obj2 = new MyModel();
    // parentPort.postMessage(func1); 传递func1发生序列化错误
    // parentPort.postMessage(obj1);  传递obj1发生序列化错误
    parentPort.postMessage(obj2);     // 传递obj2不会发生序列化错误
}
parentPort.onmessageerror = function(e) {
    console.log("worker.js onmessageerror");
}
parentPort.onerror = function(e) {
    console.log("worker.js onerror");
}
```

W
wangzhaoyong 已提交
1560 1561
### 内存模型
Worker基于Actor并发模型实现。在Worker的交互流程中,JS主线程可以创建多个Worker子线程,各个Worker线程间相互隔离,并通过序列化传递对象,等到Worker线程完成计算任务,再把结果返回给主线程。 
1562

W
wangzhaoyong 已提交
1563 1564 1565 1566
Actor并发模型的交互原理:各个Actor并发地处理主线程任务,每个Actor内部都有一个消息队列及单线程执行模块,消息队列负责接收主线程及其他Actor的请求,单线程执行模块则负责串行地处理请求、向其他Actor发送请求以及创建新的Actor。由于Actor采用的是异步方式,各个Actor之间相互隔离没有数据竞争,因此Actor可以高并发运行。

### 注意事项
- Worker存在数量限制,当前支持最多同时存在7个Worker。
1567 1568
- 在API version 8及之前的版本,当Worker数量超出限制时,会抛出错误Error "Too many workers, the number of workers exceeds the maximum."。
- 从API version 9开始,当Worker数量超出限制时,会抛出错误BusinessError "Worker initialization failure, the number of workers exceeds the maximum"。
W
wangzhaoyong 已提交
1569
- 主动销毁Worker可以调用新创建Worker对象的terminate()或parentPort.close()方法。
1570
- 自API version 9版本开始,若Worker处于已经销毁或正在销毁等非运行状态时,调用其功能接口,会抛出相应的BusinessError。
W
wangzhaoyong 已提交
1571
- Worker的创建和销毁耗费性能,建议管理已创建的Worker并重复使用。
Y
yqhan 已提交
1572
- 创建Worker工程时,new worker.Worker构造函数和new worker.ThreadWorker构造函数不能同时使用,否则将导致工程中Worker的功能异常。自API version 9版本开始,建议使用[new worker.ThreadWorker](#constructor9)构造函数,在API version 8及之前的版本,建议使用[new worker.Worker](#constructordeprecated)构造函数。
W
wangzhaoyong 已提交
1573

Y
yqhan 已提交
1574
## 完整示例
1575 1576
> **说明:**<br/>
> 以API version 9的工程为例。<br> API version 8及之前的版本仅支持FA模型,如需使用,注意更换构造Worker的接口和创建worker线程中与主线程通信的对象的两个方法。
Y
yqhan 已提交
1577
### FA模型
1578

Y
yqhan 已提交
1579 1580 1581
```js
// main.js(同级目录为例)
import worker from '@ohos.worker';
W
wangzhaoyong 已提交
1582
// 主线程中创建Worker对象
1583
const workerInstance = new worker.ThreadWorker("workers/worker.ts");
Y
yqhan 已提交
1584
// 创建js和ts文件都可以
1585 1586 1587
// const workerInstance = new worker.ThreadWorker("workers/worker.js");

// API version 9之前版本,worker对象的构造方法
Y
yqhan 已提交
1588 1589
// const workerInstance = new worker.Worker("workers/worker.js");

W
wangzhaoyong 已提交
1590
// 主线程向worker线程传递信息
Y
yqhan 已提交
1591
workerInstance.postMessage("123");
W
wangzhaoyong 已提交
1592 1593

// 主线程接收worker线程信息
Y
yqhan 已提交
1594
workerInstance.onmessage = function(e) {
W
wangzhaoyong 已提交
1595
    // data:worker线程发送的信息
Y
yqhan 已提交
1596 1597
    let data = e.data;
    console.log("main.js onmessage");
W
wangzhaoyong 已提交
1598 1599

    // 销毁Worker对象
Y
yqhan 已提交
1600 1601
    workerInstance.terminate();
}
W
wangzhaoyong 已提交
1602 1603

// 在调用terminate后,执行回调onexit
Y
yqhan 已提交
1604 1605 1606 1607 1608
workerInstance.onexit = function() {
    console.log("main.js terminate");
}
```
```js
1609
// worker.ts
Y
yqhan 已提交
1610
import worker from '@ohos.worker';
W
wangzhaoyong 已提交
1611 1612

// 创建worker线程中与主线程通信的对象
1613 1614 1615 1616
const parentPort = worker.workerPort

// API version 9之前版本,创建worker线程中与主线程通信的对象
// const parentPort = worker.parentPort
Y
yqhan 已提交
1617

W
wangzhaoyong 已提交
1618
// worker线程接收主线程信息
Y
yqhan 已提交
1619
parentPort.onmessage = function(e) {
W
wangzhaoyong 已提交
1620
    // data:主线程发送的信息
Y
yqhan 已提交
1621
    let data = e.data;
1622
    console.log("worker.ts onmessage");
W
wangzhaoyong 已提交
1623 1624

    // worker线程向主线程发送信息
Y
yqhan 已提交
1625 1626 1627
    parentPort.postMessage("123")
}

W
wangzhaoyong 已提交
1628
// worker线程发生error的回调
Y
yqhan 已提交
1629
parentPort.onerror= function(e) {
1630
    console.log("worker.ts onerror");
Y
yqhan 已提交
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646
}
```
build-profile.json5 配置 :
```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/MainAbility/workers/worker.ts"
      ]
    }
  }
```
### Stage模型
```js
// main.js(以不同目录为例)
import worker from '@ohos.worker';
W
wangzhaoyong 已提交
1647 1648

// 主线程中创建Worker对象
1649
const workerInstance = new worker.ThreadWorker("entry/ets/pages/workers/worker.ts");
Y
yqhan 已提交
1650
// 创建js和ts文件都可以
1651
// const workerInstance = new worker.ThreadWorker("entry/ets/pages/workers/worker.js");
W
wangzhaoyong 已提交
1652 1653

// 主线程向worker线程传递信息
Y
yqhan 已提交
1654
workerInstance.postMessage("123");
W
wangzhaoyong 已提交
1655 1656

// 主线程接收worker线程信息
Y
yqhan 已提交
1657
workerInstance.onmessage = function(e) {
W
wangzhaoyong 已提交
1658
    // data:worker线程发送的信息
Y
yqhan 已提交
1659 1660
    let data = e.data;
    console.log("main.js onmessage");
W
wangzhaoyong 已提交
1661 1662

    // 销毁Worker对象
Y
yqhan 已提交
1663 1664 1665 1666 1667 1668 1669 1670
    workerInstance.terminate();
}
// 在调用terminate后,执行onexit
workerInstance.onexit = function() {
    console.log("main.js terminate");
}
```
```js
1671
// worker.ts
Y
yqhan 已提交
1672
import worker from '@ohos.worker';
W
wangzhaoyong 已提交
1673 1674

// 创建worker线程中与主线程通信的对象
1675
const parentPort = worker.workerPort
Y
yqhan 已提交
1676

W
wangzhaoyong 已提交
1677
// worker线程接收主线程信息
Y
yqhan 已提交
1678
parentPort.onmessage = function(e) {
W
wangzhaoyong 已提交
1679
    // data:主线程发送的信息
Y
yqhan 已提交
1680
    let data = e.data;
1681
    console.log("worker.ts onmessage");
W
wangzhaoyong 已提交
1682 1683

    // worker线程向主线程发送信息
Y
yqhan 已提交
1684 1685 1686
    parentPort.postMessage("123")
}

W
wangzhaoyong 已提交
1687
// worker线程发生error的回调
Y
yqhan 已提交
1688
parentPort.onerror= function(e) {
1689
    console.log("worker.ts onerror");
Y
yqhan 已提交
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700
}
```
build-profile.json5 配置:
```json
  "buildOption": {
    "sourceOption": {
      "workers": [
        "./src/main/ets/pages/workers/worker.ts"
      ]
    }
  }
Y
yqhan 已提交
1701 1702
```
<!--no_check-->