1# 延迟任务回调能力开发指导（WorkSchedulerExtensionAbility） 2 3对于实时性要求不高的任务或持久性任务，可以使用延迟任务，该机制会在应用满足应用设定条件（包括网络类型、充电类型、存储状态、电池状态、定时状态）时，根据系统当前状态，由系统统一决策调度时间。 4 5WorkSchedulerExtensionAbility提供了延迟任务回调能力，在延迟任务开始和结束时，系统会调用回调接口来处理任务逻辑，开发者可在回调接口里面编写自己的任务逻辑。 6 7## 运作机制 8 9延迟任务调度运作机制如图1所示。 10 11 **图1** 延迟任务调度运作机制 12 13 14 15应用通过[延迟任务API](../reference/apis/js-apis-resourceschedule-workScheduler.md)注册、删除、查询任务，通过[延迟任务回调API](../reference/apis/js-apis-WorkSchedulerExtensionAbility.md)实现任务开始、结束的执行逻辑。 16应用服务侧进行条件检测和判断，若满足条件，则回调WorkSchedulerExtensionAbility拉起应用，执行onWorkStart、onWorkStop回调接口。 17 18## 接口说明 19 20WorkSchedulerExtensionAbility类拥有如下API接口，具体的API介绍详见[接口文档](../reference/apis/js-apis-WorkSchedulerExtensionAbility.md)。 21 22| 接口名 | 描述 | 23| -------- | -------- | 24| onWorkStart(work: workScheduler.WorkInfo): void | 延迟任务调度开始回调。 | 25| onWorkStop(work: workScheduler.WorkInfo): void | 延迟任务调度结束回调。 | 26 27## 开发步骤 28 29在DevEco Studio工程中新建一个WorkScheduler工程，主要涉及如下关键步骤： 30 31- [实现延迟任务回调拓展能力](#实现延迟任务回调拓展能力)：开发延迟任务生命周期回调接口WorkSchedulerExtensionAbility。 32 33- [实现延迟任务调度能力](#实现延迟任务调度能力)：开发延迟任务API，实现延迟任务注册、停止等功能。 34 35- [配置文件](#配置文件)：配置应用配置文件module.json5。 36 37### 实现延迟任务回调拓展能力 38 391. 在工程根目录新建Module，模板选择为Ohos Library，命名为library。 40 412. 在library对应的ets目录(./library/src/main/ets)下，新建ArkTS文件并命名为workAbility.ets，用于实现延迟任务回调接口。 42 43 导入模块。 44 45 ```ts 46 import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility'; 47 ``` 48 49 实现WorkSchedulerExtension生命周期接口。 50 51 ```ts 52 export default class workAbility extends WorkSchedulerExtensionAbility { 53 // 延迟任务开始回调 54 onWorkStart(workInfo) { 55 console.log(`onWorkStart CommonEvent publish start ${JSON.stringify(workInfo)}`); 56 // 发送升级通知 57 let notificationRequest = notification.getNotificationContentBasic('upgrade', upgradeMessage, ''); 58 notification.publish(notificationRequest, (err) => { 59 if (err) { 60 console.log(`onWorkStart notification publish err ${JSON.stringify(err)}`); 61 } 62 console.log(`onWorkStart notification publish success`); 63 }); 64 } 65 66 // 延迟任务结束回调 67 onWorkStop(workInfo) { 68 // 发送升级完成通知 69 let notificationRequest = notification.getNotificationContentBasic('upgrade', 'upgrade success', ''); 70 notification.publish(notificationRequest, (err) => { 71 if (err) { 72 console.log(`onWorkStop notification publish err ${JSON.stringify(err)}`); 73 } 74 console.log(`onWorkStop notification publish success`); 75 }); 76 } 77 } 78 ``` 79 803. 在工程entry Module对应的ets目录(./entry/src/main/ets)下，新建一个目录并命名为workAbility。 81 在workAbility目录下，新建一个ArkTS文件并命名为WorkTest.ets，实现延迟任务回调接口。 82 83 导入模块。 84 85 ```ts 86 import { workAbility } from '@ohos/library'; 87 ``` 88 89 继承workAbility，实现WorkSchedulerExtension生命周期接口。 90 91 ```ts 92 export default class WorkTest extends workAbility { 93 onWorkStart(workInfo) { 94 console.log(`onWorkStartTest start ${JSON.stringify(workInfo)}`); 95 super.onWorkStart(workInfo); 96 } 97 98 onWorkStopTest(workInfo) { 99 super.onWorkStop(workInfo); 100 console.log(`onWorkStop value`); 101 } 102 } 103 ``` 104 105### 实现延迟任务调度能力 106 1071. 在library对应的ets目录(./library/src/main/ets)下，新建TypeScript文件并命名为DelayWork.ts，用于实现延迟任务API。 108 109 导入模块。 110 111 ```ts 112 import workScheduler from '@ohos.resourceschedule.workScheduler'; 113 ``` 114 115 封装延迟任务注册、停止接口。 116 117 ```ts 118 export default class DelayWork { 119 private workInfo = { 120 workId: 1, 121 networkType: workScheduler.NetworkType.NETWORK_TYPE_WIFI, 122 bundleName: '', 123 abilityName: '' 124 } 125 // 注册延迟任务 126 startWork(bundleName: string, abilityName: string) { 127 this.workInfo.bundleName = bundleName; 128 this.workInfo.abilityName = abilityName; 129 try { 130 workScheduler.startWork(this.workInfo); 131 console.log(`startWork success`); 132 } catch (error) { 133 Logger.error(TAG, `startWork startwork failed. code is ${error.code} message is ${error.message}`); 134 prompt.showToast({ 135 message: `${error.message}` 136 }) 137 } 138 } 139 140 // 停止延迟任务 141 stopWork(bundleName: string, abilityName: string) { 142 this.workInfo.bundleName = bundleName; 143 this.workInfo.abilityName = abilityName; 144 workScheduler.stopWork(this.workInfo, false); 145 console.log(`stopWork`); 146 } 147 } 148 ``` 149 1502. 在工程entry Module对应的index页面(./entry/src/main/ets/pages/index.ets)下，增加“升级”按钮，调用library封装的延迟任务注册接口。 151 152 导入模块。 153 154 ```ts 155 import { workAbility } from '@ohos/library'; 156 ``` 157 158 增加“升级”按钮，调用library封装的延迟任务注册接口，传入bundleName和abilityName，其中bilityName为WorkTest。 159 160 ```ts 161 Button($r('app.string.upgrade')) 162 .width('60%') 163 .height(40) 164 .fontSize(30) 165 .onClick(() => { 166 this.work.startWork('ohos.samples.workscheduler', 'WorkTest'); 167 }) 168 ``` 169 170 当组件析构时，调用延迟任务停止接口。 171 172 ```ts 173 aboutToDisappear() { 174 this.work.stopWork('ohos.samples.workscheduler', 'WorkTest'); 175 } 176 ``` 177 178### 配置文件 179 1801. 在工程entry Module对应的[module.json5配置文件](../quick-start/module-configuration-file.md)中注册WorkSchedulerExtensionAbility，type标签需要设置为“workScheduler”，srcEnty标签表示当前ExtensionAbility组件所对应的代码路径。 181 182 ```json 183 { 184 "module": { 185 "extensionAbilities": [ 186 { 187 "name": "WorkTest", 188 "srcEnty": "./ets/workAbility/WorkTest.ets", 189 "label": "$string:WorkSchedulerExtensionAbility_label", 190 "description": "$string:WorkSchedulerExtensionAbility_desc", 191 "type": "workScheduler" 192 } 193 ] 194 } 195 } 196 ``` 197 198## 相关实例 199 200针对WorkSchedulerExtensionAbility开发，有以下相关实例可供参考： 201 202- [WorkScheduler的创建与使用（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-3.2-Release/code/BasicFeature/TaskManagement/WorkScheduler) 203 204
