延迟任务回调能力开发指导(WorkSchedulerExtensionAbility)

对于实时性要求不高的任务或持久性任务,可以使用延迟任务,该机制会在应用满足应用设定条件(包括网络类型、充电类型、存储状态、电池状态、定时状态)时,根据系统当前状态,由系统统一决策调度时间。

WorkSchedulerExtensionAbility提供了延迟任务回调能力,在延迟任务开始和结束时,系统会调用回调接口来处理任务逻辑,开发者可在回调接口里面编写自己的任务逻辑。

运作机制

延迟任务调度运作机制如图1所示。

图1 延迟任务调度运作机制

WorkSchedulerExtensionAbility

应用通过延迟任务API注册、删除、查询任务,通过延迟任务回调API实现任务开始、结束的执行逻辑。 应用服务侧进行条件检测和判断,若满足条件,则回调WorkSchedulerExtensionAbility拉起应用,执行onWorkStart、onWorkStop回调接口。

接口说明

WorkSchedulerExtensionAbility类拥有如下API接口,具体的API介绍详见接口文档

接口名 描述
onWorkStart(work: workScheduler.WorkInfo): void 延迟任务调度开始回调。
onWorkStop(work: workScheduler.WorkInfo): void 延迟任务调度结束回调。

开发步骤

在DevEco Studio工程中新建一个WorkScheduler工程,主要涉及如下关键步骤:

实现延迟任务回调拓展能力

  1. 在工程根目录新建Module,模板选择为Ohos Library,命名为library。

  2. 在library对应的ets目录(./library/src/main/ets)下,新建ArkTS文件并命名为workAbility.ets,用于实现延迟任务回调接口。

    导入模块。

    import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
    

    实现WorkSchedulerExtension生命周期接口。

    export default class workAbility extends WorkSchedulerExtensionAbility {
      // 延迟任务开始回调
      onWorkStart(workInfo) {
        console.log(`onWorkStart CommonEvent publish start ${JSON.stringify(workInfo)}`);
        // 发送升级通知
        let notificationRequest = notification.getNotificationContentBasic('upgrade', upgradeMessage, '');
        notification.publish(notificationRequest, (err) => {
          if (err) {
            console.log(`onWorkStart notification publish err ${JSON.stringify(err)}`);
          }
          console.log(`onWorkStart notification publish success`);
        });
      }
    
      // 延迟任务结束回调
      onWorkStop(workInfo) {
        // 发送升级完成通知
        let notificationRequest = notification.getNotificationContentBasic('upgrade', 'upgrade success', '');
        notification.publish(notificationRequest, (err) => {
          if (err) {
            console.log(`onWorkStop notification publish err ${JSON.stringify(err)}`);
          }
          console.log(`onWorkStop notification publish success`);
        });
      }
    }
    
  3. 在工程entry Module对应的ets目录(./entry/src/main/ets)下,新建一个目录并命名为workAbility。 在workAbility目录下,新建一个ArkTS文件并命名为WorkTest.ets,实现延迟任务回调接口。

    导入模块。

    import { workAbility } from '@ohos/library';
    

    继承workAbility,实现WorkSchedulerExtension生命周期接口。

    export default class WorkTest extends workAbility {
      onWorkStart(workInfo) {
        console.log(`onWorkStartTest start ${JSON.stringify(workInfo)}`);
        super.onWorkStart(workInfo);
      }
    
      onWorkStopTest(workInfo) {
        super.onWorkStop(workInfo);
        console.log(`onWorkStop value`);
      }
    }
    

实现延迟任务调度能力

  1. 在library对应的ets目录(./library/src/main/ets)下,新建TypeScript文件并命名为DelayWork.ts,用于实现延迟任务API。

    导入模块。

    import workScheduler from '@ohos.resourceschedule.workScheduler';
    

    封装延迟任务注册、停止接口。

    export default class DelayWork {
      private workInfo = {
        workId: 1,
        networkType: workScheduler.NetworkType.NETWORK_TYPE_WIFI,
        bundleName: '',
        abilityName: ''
      }
      // 注册延迟任务
      startWork(bundleName: string, abilityName: string) {
        this.workInfo.bundleName = bundleName;
        this.workInfo.abilityName = abilityName;
        try {
          workScheduler.startWork(this.workInfo);
          console.log(`startWork success`);
        } catch (error) {
          Logger.error(TAG, `startWork startwork failed. code is ${error.code} message is ${error.message}`);
          prompt.showToast({
            message: `${error.message}`
          })
        }
      }
    
      // 停止延迟任务
      stopWork(bundleName: string, abilityName: string) {
        this.workInfo.bundleName = bundleName;
        this.workInfo.abilityName = abilityName;
        workScheduler.stopWork(this.workInfo, false);
        console.log(`stopWork`);
      }
    }
    
  2. 在工程entry Module对应的index页面(./entry/src/main/ets/pages/index.ets)下,增加“升级”按钮,调用library封装的延迟任务注册接口。

    导入模块。

    import { workAbility } from '@ohos/library';
    

    增加“升级”按钮,调用library封装的延迟任务注册接口,传入bundleName和abilityName,其中bilityName为WorkTest。

    Button($r('app.string.upgrade'))
      .width('60%')
      .height(40)
      .fontSize(30)
      .onClick(() => {
        this.work.startWork('ohos.samples.workscheduler', 'WorkTest');
      })
    

    当组件析构时,调用延迟任务停止接口。

    aboutToDisappear() {
      this.work.stopWork('ohos.samples.workscheduler', 'WorkTest');
    }
    

配置文件

  1. 在工程entry Module对应的module.json5配置文件中注册WorkSchedulerExtensionAbility,type标签需要设置为“workScheduler”,srcEnty标签表示当前ExtensionAbility组件所对应的代码路径。
{
  "module": {
      "extensionAbilities": [
        {
          "name": "WorkTest",
          "srcEnty": "./ets/workAbility/WorkTest.ets",
          "label": "$string:WorkSchedulerExtensionAbility_label",
          "description": "$string:WorkSchedulerExtensionAbility_desc",
          "type": "workScheduler"
        }
      ]
  }
}

相关实例

针对WorkSchedulerExtensionAbility开发,有以下相关实例可供参考: