鸿蒙原生应用/元服务开发-长时任务

概述

功能介绍

应用退至后台后，对于在后台需要长时间运行用户可感知的任务，例如播放音乐、导航等。为防止应用进程被挂起，导致对应功能异常，可以申请长时任务，使应用在后台长时间运行。申请长时任务后，系统会做相应的校验，确保应用在执行相应的长时任务。同时，系统有与长时任务相关联的通知栏消息，用户删除通知栏消息时，系统会自动停止长时任务。

使用场景

下表给出了当前长时任务支持的类型，包含数据传输、音频播放、录音、定位导航、蓝牙相关、多设备互联和计算任务。可以参考下表中的场景举例，选择合适的长时任务类型。

长时任务类型

·申请了DATA_TRANSFER（数据传输）的长时任务，系统仅会提升应用进程的优先级，降低系统终止应用进程的概率，但仍然会挂起对应的应用进程。对于上传下载对应的功能，需要调用系统上传下载代理接口托管给系统执行。

约束与限制

申请限制：Stage模型中，长时任务仅支持UIAbility申请；FA模型中，长时任务仅支持ServiceAbility申请。

数量限制：一个UIAbility（FA模型则为ServiceAbility）同一时刻仅支持申请一个长时任务，即在一个长时任务结束后才可能继续申请。如果一个应用同时需要申请多个长时任务，需要创建多个UIAbility；一个应用的一个UIAbility申请长时任务后，整个应用下的所有进程均不会被挂起。

运行限制：系统会进行长时任务校验。若应用申请了长时任务，但未真正执行申请类型的长时任务或申请类型的任务已结束，系统会对应用进行管控。例如系统检测到应用申请了AUDIO_PLAYBACK（音频播放），但实际未播放音乐，系统则会终止对应的进程。

接口说明：
主要接口：

代码开发：stage模型下

1.申请ohos.permission.KEEP_BACKGROUND_RUNNING权限，配置方式请参见配置文件权限声明。

2.声明后台模式类型。

在module.json5配置文件中为需要使用长时任务的UIAbility声明相应的长时任务类型。

 {
  "module": {
    ...
    "abilities": [
      {
        ...
        // 后台模式类型
        "backgroundModes": [
          "audioRecording"
        ],
      }
    ]
  }
}

3.导入模块

import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
import wantAgent from '@ohos.app.ability.wantAgent';

4.申请和取消长时任务。

设备本应用申请长时任务示例代码如下：

import common from '@ohos.app.ability.common';

@Entry
@Component
struct Index {
  @State message: string = 'ContinuousTask';
  // 获取UIAbilityContext
  private context = getContext(this) as common.UIAbilityContext;
  startContinuousTask() {
    let wantAgentInfo = {
      // 点击通知后，将要执行的动作列表
      wants: [
        {
          bundleName: "com.example.myapplication",
          abilityName: "EntryAbility"
        }
],
// 点击通知后，动作类型
operationType: wantAgent.OperationType.START_ABILITY,
// 使用者自定义的一个私有值
requestCode: 0,
// 点击通知后，动作执行属性
wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};

// 通过wantAgent模块下getWantAgent方法获取WantAgent对象
wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
  try {
    backgroundTaskManager.startBackgroundRunning(this.context,
      backgroundTaskManager.BackgroundMode.AUDIO_RECORDING, wantAgentObj).then(() => {
      console.info(`Succeeded in operationing startBackgroundRunning.`);
    }).catch((err) => {
      console.error(`Failed to operation startBackgroundRunning. Code is ${err.code}, message is ${err.message}`);
    });
  } catch (error) {
    console.error(`Failed to start background running. Code is ${error.code} message is ${error.message}`);
  }
});
}

stopContinuousTask() {
  try {
    backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
      console.info(`Succeeded in operationing stopBackgroundRunning.`);
    }).catch((err) => {
      console.error(`Failed to operation stopBackgroundRunning. Code is ${err.code}, message is ${err.message}`);
    });
  } catch (error) {
    console.error(`Failed to stop background running. Code is ${error.code} message is ${error.message}`);
  }
}

build() {
    Row() {
      Column() {
        Text("Index")
          .fontSize(50)
          .fontWeight(FontWeight.Bold)

        Button() {
          Text('申请长时任务').fontSize(25).fontWeight(FontWeight.Bold)
        }
.type(ButtonType.Capsule)
  .margin({ top: 10 })
  .backgroundColor('#0D9FFB')
  .width(250)
  .height(40)
  .onClick(() => {
    // 通过按钮申请长时任务
    this.startContinuousTask();

    // 此处执行具体的长时任务逻辑，如放音等。
  })

Button() {
  Text('取消长时任务').fontSize(25).fontWeight(FontWeight.Bold)
}
.type(ButtonType.Capsule)
  .margin({ top: 10 })
  .backgroundColor('#0D9FFB')
  .width(250)
  .height(40)
  .onClick(() => {
    // 此处结束具体的长时任务的执行

    // 通过按钮取消长时任务
    this.stopContinuousTask();
  })
}
.width('100%')
}
.height('100%')
}
}