對象Worker

Worker 物件是用來建立子執行緒的對象，可以在程式中建立和處理子執行緒。一個Worker 物件可以理解為一個在與主執行緒不同的執行緒中執行的JavaScript 程序。Worker 不與主線程共享內存，不會阻塞主線程，是一種主流的非同步程式設計方式

Worker 物件的建構子如下：

1
new Worker(String path, Object opts = {})

其中，path參數指定的就是新執行緒的JavaScript 檔案路徑。例如，可以寫一個work.js 文件，內容如下：

1
2
3
4
const {
    Worker
} = require('worker_threads');
console.log('Hi from worker');

在主程式中，透過以下程式碼執行work.js：

1
2
3
4
const {
    Worker
} = require('worker_threads');
const worker = new Worker('path/to/work.js');

運行後，可以在主程式的控制台看到輸出"Hi from worker"。

在下面的例子裡，假設我們有一個長耗時計算，我們希望將它放進另一個執行緒去處理，同時避免在主執行緒中被此計算阻塞。程式碼如下：

主線程:

1
2
3
4
5
6
7
8
9
10
11
12
const {
    Worker
} = require('worker_threads');

// create a worker thread
const fib = new Worker(__dirname + '/fib-worker.js');
// receive the result from the worker thread
fib.onmessage = (ev) => {
    console.log('result: ', ev.data);
};
fib.postMessage(40);
console.log('main thread still working');

在這個例子中，我們透過Worker 物件的建構函式建立了一個工作執行緒來處理Fibonacci 數列的計算，主執行緒透過postMessage() 方法給工作執行緒傳遞數據，並透過onmessage 事件來取得處理結果。同時，主線程顯示'still working' 訊息，以證明已將此計算任務'委託'給了工作線程，並可以繼續處理其他事情。

工作線程程式碼樣式如下：

1
2
3
4
5
6
7
8
9
10
11
12
// fib-worker.js
Master.onmessage = (ev) => {
    const n = ev.data;
    const result = fib(n);
    // Once the calculation has been completed, the result is sent back to the main thread.
    Master.postMessage(result);
};

function fib(n) {
    if (n <= 1) return n;
    return fib(n - 1) + fib(n - 2);
}

在工作執行緒中，我們監聽了主執行緒透過入口參數postMessage() 發送的訊息，將指定的Fibonacci 數列計算並透過Master.postMessage() 方法將計算結果傳送回主執行緒。

這是一個最基礎的Worker 範例，使用Worker 物件開發時，主線程與工作線程是完全非同步的，每個Worker 物件都是單獨的線程，在主線程中實例化的Worker 物件並不會產生任何阻塞。

繼承關係

建構函數

Worker

Worker 物件建構函數

1
2
new Worker(String path,
    Object opts = {});

呼叫參數:

path: String, 指定Worker 入口腳本，只接受絕對路徑
opts: Object, 建構選項，暫未支持

靜態屬性

defaultMaxListeners

Integer, 預設全域最大監聽器數

1
static Integer Worker.defaultMaxListeners;

成員屬性

onload

Function, 查詢與綁定接受load 訊息事件，相當於on("load", func);

1
Function Worker.onload;

onmessage

Function, 查詢和綁定接受postMessage 訊息事件，相當於on("message", func);

1
Function Worker.onmessage;

onerror

Function, 查詢和綁定接受error 訊息事件，相當於on("error", func);

1
Function Worker.onerror;

成員函數

postMessage

向Master 或Worker 發送訊息，

1Worker.postMessage(Value data);

呼叫參數:

data: Value, 指定發送的訊息內容

on

綁定一個事件處理函數到對象

1
2
Object Worker.on(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到對象

1
Object Worker.on(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

addListener

綁定一個事件處理函數到對象

1
2
Object Worker.addListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到對象

1
Object Worker.addListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

prependListener

綁定一個事件處理函數到物件起始

1
2
Object Worker.prependListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到物件起始

1
Object Worker.prependListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

once

綁定一個一次性事件處理函數到對象，一次性處理函數只會觸發一次

1
2
Object Worker.once(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個一次性事件處理函數到對象，一次性處理函數只會觸發一次

1
Object Worker.once(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

prependOnceListener

綁定一個事件處理函數到物件起始

1
2
Object Worker.prependOnceListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

綁定一個事件處理函數到物件起始

1
Object Worker.prependOnceListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱將作為事件名稱，屬性的值將作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

off

從物件處理佇列中取消指定函數

1
2
Object Worker.off(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

取消物件處理佇列中的全部函數

1
Object Worker.off(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消指定函數

1
Object Worker.off(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱作為事件名稱，屬性的值作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

removeListener

從物件處理佇列中取消指定函數

1
2
Object Worker.removeListener(String ev,
    Function func);

呼叫參數:

ev: String, 指定事件的名稱
func: Function, 指定事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

取消物件處理佇列中的全部函數

1
Object Worker.removeListener(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消指定函數

1
Object Worker.removeListener(Object map);

呼叫參數:

map: Object, 指定事件映射關係，物件屬性名稱作為事件名稱，屬性的值作為事件處理函數

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

removeAllListeners

從物件處理佇列中取消所有事件的所有監聽器，如果指定事件，則移除指定事件的所有監聽器。

1
Object Worker.removeAllListeners(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

從物件處理佇列中取消所有事件的所有監聽器，如果指定事件，則移除指定事件的所有監聽器。

1
Object Worker.removeAllListeners(Array evs = []);

呼叫參數:

evs: Array, 指定事件的名稱

回傳結果:

Object, 傳回事件物件本身，便於鍊式調用

setMaxListeners

監聽器的預設限制的數量，僅用於相容

1Worker.setMaxListeners(Integer n);

呼叫參數:

n: Integer, 指定事件的數量

getMaxListeners

取得監聽器的預設限制的數量，僅用於相容

1Integer Worker.getMaxListeners();

回傳結果:

Integer, 回傳預設限制數量

listeners

查詢物件指定事件的監聽器陣列

1
Array Worker.listeners(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Array, 傳回指定事件的監聽器數組

listenerCount

查詢物件指定事件的監聽器數量

1
Integer Worker.listenerCount(String ev);

呼叫參數:

ev: String, 指定事件的名稱

回傳結果:

Integer, 傳回指定事件的監聽器數量

查詢物件指定事件的監聽器數量

1
2Integer Worker.listenerCount(Value o,
    String ev);

呼叫參數:

o: Value, 指定查詢的對象
ev: String, 指定事件的名稱

回傳結果:

Integer, 傳回指定事件的監聽器數量

eventNames

查詢監聽器事件名稱

1
Array Worker.eventNames();

回傳結果:

Array, 傳回事件名稱數組

emit

主動觸發一個事件

1
2
Boolean Worker.emit(String ev,
    ...args);

呼叫參數:

ev: String, 事件名稱
args: ..., 事件參數，將會傳遞給事件處理函數

回傳結果:

Boolean, 回傳事件觸發狀態，有回應事件回傳true，否則回傳false

toString

傳回物件的字串表示，一般回傳"[Native Object]"，物件可以根據自己的特性重新實現

1
String Worker.toString();

回傳結果:

String, 傳回物件的字串表示

toJSON

傳回物件的JSON 格式表示，一般傳回物件定義的可讀屬性集合

1
Value Worker.toJSON(String key = "");

呼叫參數:

key: String, 未使用

回傳結果:

Value, 傳回包含可JSON 序列化的值

開發指南

基礎模組

內建對象

社群模組

對象Worker

繼承關係

建構函數

Worker

靜態屬性

defaultMaxListeners

成員屬性

onload

onmessage

onerror

成員函數

postMessage

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON