多線程任務開發范例-TaskPool
概念介紹
任務池（taskpool）為應用程序提供一個多線程的運行環境，可以使用任務池API創建后臺任務（Task），并對所創建的任務進行如任務執行、任務取消的操作。使用任務池，無需關心線程實例的生命周期，提升開發體驗，還能降低整體資源的消耗、提高系統的整體性能。
API接口
任務池模塊提供的功能非?；A，只支持任務構造，任務執行，任務取消等3類接口。關于任務池（taskpool）API能力詳細信息，請參考@ohos.taskpool。本節只進行關鍵接口解讀。
Task構造函數
使用線程池運行后臺任務前，可以先構造一個Task實例。Task構造函數如下：
constructor(func: Function, …args: unknown[])其中，參數解釋：
參數名 | 類型 | 必填 | 說明 |
func | Function | 是 | 任務執行需要傳入函數，支持的函數返回值類型請查序列化支持類型。 |
args | unknown[] | 否 | 任務執行傳入函數的參數，支持的參數類型請查序列化支持類型。默認值為undefined。 |
我們來看一個構造的示例。
@Concurrent
function printArgs(args) {
console.log("printArgs: " + args);
return args;
}
let task = new taskpool.Task(printArgs, "this is my first Task");注意：上述實例代碼是官方API提供的，實際上并不可用，使用裝飾器@Concurrent會報錯。實際上使用的是如下代碼：
function concurrentTask(durationMs: number) {
"use concurrent"
console.info("[concurrentTask] task start, the args is " + durationMs)
setTimeout(() => {
console.info("[concurrentTask] task end ")
}, durationMs)
console.info("[concurrentTask] task return")
return '[concurrentTask] returned'
}
function createTask() {
let task = new taskPool.Task(concurrentTask, 10 * 1000)
console.info("[createTask] created successfully")
return task
}執行異步函數
將待執行的函數放入taskpool內部任務隊列等待，等待分發到工作線程執行。此種方式執行的情況下，沒有創建任務，所以不可取消任務。后文將介紹的taskpool.cancel函數需要傳入taskpool.Task參數。
接口定義如下，其中的參數不再解釋，和Task構造函數的參數一樣。
execute(func: Function, …args: unknown[]): Promise<unknown>示例代碼如下：
@Concurrent
function printArgs(args) {
console.log("printArgs: " + args);
return args;
}
async function taskpoolExecute() {
let value = await taskpool.execute(printArgs, 100);
console.log("taskpool result: " + value);
}
...
taskpoolExecute();執行Task任務
將創建好的任務放入taskpool任務池里等待，等待分發到工作線程執行。當前執行模式可嘗試調用cancel進行任務取消。接口定義如下：
execute(task: Task, priority?: Priority): Promise<unknown>其中，參數如下：
參數名 | 類型 | 必填 | 說明 |
task | 是 | 需要在任務池中執行的任務。 | |
priority | 否 | 等待執行的任務的優先級（暫未支持）。 |
示例代碼如下：
@Concurrent
function printArgs(args) {
console.log("printArgs: " + args);
return args;
}
async function taskpoolExecute() {
let task = new taskpool.Task(printArgs, 100);
let value = await taskpool.execute(task);
console.log("taskpool result: " + value);
}
taskpoolExecute();取消Task任務
取消任務池中的任務。在Task構造實例后直接調用cancal接口會找不到要取消的任務，需要調用execute接口后，才會放入任務池，調用cancel接口才有意義。
接口定義如下：
cancel(task: Task): void其中，參數如下：
參數名 | 類型 | 必填 | 說明 |
task | 是 | 需要取消執行的任務。 |
示例代碼如下：
@Concurrent
function printArgs(args) {
console.log("printArgs: " + args);
return args;
}
async function taskpoolCancel() {
let task = new taskpool.Task(printArgs, 100);
taskpool.execute(task);
try {
taskpool.cancel(task);
} catch (e) {
console.log("taskpool.cancel occur error:" + e);
}
}
taskpoolCancel();實現場景
我們主要為了體驗線程池的使用，實現任務創建、任務執行和任務取消的功能。為了簡化，相關輸出使用console控制輸出即可。
設計思路
簡化界面實現，只需要簡單地包含一個text和三個button。text用于展示接口調用信息，不同的button按鈕被點擊后觸發調用不同的接口。通過設置日志查看操作執行情況。
開發步驟
UI界面實現
代碼非常簡單，使用DevEco Studio創建一個Empty Ability空工程后，加3個按鈕就行。
“Create Task"按鈕會創建一個任務。創建的Task實例會賦值給組件的變量，創建任務的代碼如下。現在存在一個問題需要確認，@concurrent裝飾器不知道如何使用，
當前使用的"use concurrent”。需要確認官方文檔是否存在問題。
function concurrentTask(durationMs: number) {
"use concurrent"
console.info("[concurrentTask] task start, the args is " + durationMs)
setTimeout(() => {
console.info("[concurrentTask] task end ")
}, durationMs)
console.info("[concurrentTask] task return")
return '[concurrentTask] returned'
}
function createTask() {
let task = new taskPool.Task(concurrentTask, 10 * 1000)
console.info("[createTask] created successfully")
return task
}"Execute Task"按鈕會執行一個任務。組件的變量持有任務，該按鈕可以持續點擊，反復執行任務。
"Cancel Task"按鈕會取消一個任務。如果認為沒有調用execute接口，不在線程池里，取消會阿伯錯；如果任務正在執行中，再去取消也會報錯。實際上運行，沒有得到想要的效果，需要進一步確認。
UI代碼
entry\src\main\ets\pages\Index.ets文件片段如下：
task: taskPool.Task = null
...
Column() {
Text(this.message)
.fontSize(20)
.fontWeight(FontWeight.Bold)
Blank()
Row() {
Button("Create Task").onClick(() => {
this.task = createTask()
this.message = "Task Created"
})
Button("Execute Task").onClick(() => {
executeTask(this.task)
this.message = "Task Executed"
})
Button("Cancel Task").onClick(() => {
cancelTask(this.task)
this.message = "Task Cancel involved"
})
}
}執行任務代碼實現
我們再執行任務代碼如何實現。
我們從上文知道，taskPool.execute接口有兩種方式，可以傳入異步函數和參數，也可以傳入task實例和優先級參數。
此處，我們使用第二種方法，傳入task實例和優先級參數。任務池模塊尚未支持優先級，該參數也可以省略。
執行任務代碼片段如下：
function executeTask(task: taskPool.Task) {
console.info("[executeTask] executing")
try {
taskPool.execute(task, taskPool.Priority.HIGH).then(() => {
console.info("[executeTask] executed successfully")
})
} catch (e) {
console.error("[executeTask] execute failed, " + e.toString())
}
}取消任務代碼實現
我們再看下取消任務的代碼如何實現。
如果沒有通過調用execute接口，沒有放入任務池的task，執行cancel函數時，會報異常，畢竟在線程池是不存在的。
然后模擬一個延時操作，再去調用cancel函數。
期望可以正常取消任務，實際上，任務沒有被取消，也沒有報異常。這里就很奇怪，需要繼續調查原因。
取消任務代碼片段:
function cancelTask(task: taskPool.Task) {
console.info("[cancelTask] canceling ")
try {
taskPool.execute(task, taskPool.Priority.HIGH)
let start = new Date().getTime()
// 延時1s，確保任務已執行
while (new Date().getTime() - start < 1000) {
continue
}
taskPool.cancel(task)
} catch (e) {
console.error("[cancelTask] cancel failed" + e.toString())
}
}運行測試效果
代碼編寫完畢，可以測試運行查看效果。推薦在模塊級配置文件entry\build-profile.json5中,修改運行時為"HarmonyOS"，這樣就可以在DevEco Studio中使用Simulator模擬器進行運行測試，手頭沒有設備也可以輕松體驗OpenHarmony應用開發。分別點擊按鈕，日志輸出如下:
07-30 22:28:28.357 4214-7232/com.example.taskpooldemo I 0FEFE/JsApp: [createTask] created successfully
07-30 22:28:30.576 4214-7232/com.example.taskpooldemo I 0FEFE/JsApp: [executeTask] executing
07-30 22:28:30.576 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task start, the args is 10000
07-30 22:28:30.576 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task return
07-30 22:28:30.577 4214-7232/com.example.taskpooldemo I 0FEFE/JsApp: [executeTask] executed successfully
07-30 22:28:37.602 4214-7232/com.example.taskpooldemo I 0FEFE/JsApp: [cancelTask] canceling
07-30 22:28:37.608 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task start, the args is 10000
07-30 22:28:37.609 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task return
07-30 22:28:38.607 4214-7232/com.example.taskpooldemo E 0FEFE/JsApp: [cancelTask] cancel failedBusinessError: The task does not exist when it is canceled, taskpool:: can not find the task
07-30 22:28:40.580 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task end
07-30 22:28:47.608 4214-7256/com.example.taskpooldemo I 0FEFE/JsApp: [concurrentTask] task end注意事項
理論上，您可以使用任務池API創建數量不受限制的任務。當同一時間待執行的任務數量大于任務池工作線程數量，任務池會根據負載均衡機制進行擴容，增加工作線程數量，減少整體等待時長。同樣，當執行的任務數量減少，工作線程數量大于執行任務數量，部分工作線程處于空閑狀態，任務池會根據負載均衡機制進行縮容，減少工作線程數量。遺憾的是，負載均衡機制暫未支持。
創建的同一優先級任務的執行順序可以由您決定，任務真實執行的順序與您調用任務池API提供的任務執行接口順序一致。任務默認優先級是taskPool.Priority.MEDIUM。遺憾的是，任務優先級機制暫未支持，可以忽略。
@concurrent裝飾器如何使用，需要繼續確認。另外，官方文檔中提到：僅支持在Stage模型且module的compileMode為esmodule的project中使用taskpool api。compileMode設置為什么看起來并不影響什么，需要進一步確認。
最后，任務池模塊現在屬于基礎版本，接口支持只支持簡單的任務執行和取消功能，查詢運行狀態等接口也不支持。任務一旦執行，不支持取消。不建議您在任務中執行阻塞操作，特別是無限期阻塞操作，長時間的阻塞操作占據工作線程，可能會阻塞其他任務調度，影響您的應用性能。
