长时任务

概述

功能介绍

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

使用场景

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

表1 长时任务类型

参数名	描述	配置项	场景举例
DATA_TRANSFER	数据传输	dataTransfer	后台下载大文件，如浏览器后台下载等。
AUDIO_PLAYBACK	音视频播放	audioPlayback	音乐类应用在后台播放音乐。
AUDIO_RECORDING	录音	audioRecording	录音机在后台录音。
LOCATION	定位导航	location	导航类应用后台导航。
BLUETOOTH_INTERACTION	蓝牙相关	bluetoothInteraction	通过蓝牙传输分享的文件。
MULTI_DEVICE_CONNECTION	多设备互联	multiDeviceConnection	分布式业务连接。
WIFI_INTERACTION	WLAN相关（仅对系统应用开放）	wifiInteraction	通过WLAN传输分享的文件。
VOIP	音视频通话（仅对系统应用开放）	voip	系统聊天类应用后台音频电话。
TASK_KEEPING	计算任务（仅对特定设备开放）	taskKeeping	杀毒软件。

申请了DATA_TRANSFER（数据传输）的长时任务，系统仅会提升应用进程的优先级，降低系统终止应用进程的概率，但仍然会挂起对应的应用进程。对于上传下载对应的功能，需要调用系统上传下载代理接口托管给系统执行。
使用了媒体会话服务的音视频应用，才能通过申请AUDIO_PLAYBACK长时任务实现后台播放。

约束与限制

申请限制：Stage模型中，长时任务仅支持UIAbility申请；FA模型中，长时任务仅支持ServiceAbility申请。
数量限制：一个UIAbility（FA模型则为ServiceAbility）同一时刻仅支持申请一个长时任务，即在一个长时任务结束后才可能继续申请。如果一个应用同时需要申请多个长时任务，需要创建多个UIAbility；一个应用的一个UIAbility申请长时任务后，整个应用下的所有进程均不会被挂起。
运行限制：在手机产品上，系统会进行长时任务校验。
场景1：若应用申请了长时任务，但未真正执行申请类型的长时任务或申请类型的任务已结束，系统会对应用进行管控。例如系统检测到应用申请了AUDIO_PLAYBACK（音视频播放），但实际未播放音乐，系统则会终止对应的进程。
场景2：若应用没有申请对应的长时任务类型，但执行了相关类型的长时任务，系统会对应用进行管控。例如系统检测到应用只申请了AUDIO_PLAYBACK（音视频播放），但实际上除了播放音乐（对应AUDIO_PLAYBACK类型），还在进行录音（对应AUDIO_RECORDING类型），系统会对应用进行管控。
场景3：若运行长时任务的进程后台负载持续高于所申请类型的典型负载，系统会对应用进行管控。

说明：

应用按需求申请长时任务，当应用无需在后台运行（任务结束）时，要及时主动取消长时任务，否则系统会强行取消。例如用户点击音乐暂停播放时，应用需及时取消对应的长时任务；用户再次点击音乐播放时，需重新申请长时任务。

接口说明

表2 主要接口

以下是长时任务开发使用的相关接口，下表均以Promise形式为例，更多接口及使用方式请见后台任务管理。

接口名	描述
startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: WantAgent): Promise<void>	申请长时任务
stopBackgroundRunning(context: Context): Promise<void>	取消长时任务

开发步骤

本文以申请录音长时任务为例，示例中包含“申请长时任务”和“取消长时任务”两个按钮，显示效果为：

点击“申请长时任务”按钮，应用申请录音长时任务成功，通知栏显示“正在运行录音任务”通知。
点击“取消长时任务”按钮，取消长时任务，通知栏撤销相关通知。

Stage模型

需要申请ohos.permission.KEEP_BACKGROUND_RUNNING权限，配置方式请参见声明权限。

声明后台模式类型。在module.json5配置文件中为需要使用长时任务的UIAbility声明相应的长时任务类型（配置文件中填写长时任务类型的配置项）。

 "module": {
     "abilities": [
         {
             "backgroundModes": [
              // 长时任务类型的配置项
             "audioRecording"
             ], 
         }
     ],
     ...
 }

导入模块。

长时任务相关的模块为@ohos.resourceschedule.backgroundTaskManager和@ohos.app.ability.wantAgent，其余模块按实际需要导入。

 import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
 import UIAbility from '@ohos.app.ability.UIAbility';
 import window from '@ohos.window';
 import AbilityConstant from '@ohos.app.ability.AbilityConstant';
 import Want from '@ohos.app.ability.Want';
 import rpc from '@ohos.rpc';
 import { BusinessError } from '@ohos.base';
 import wantAgent, { WantAgent } from '@ohos.app.ability.wantAgent';

申请和取消长时任务。

在Stage模型中，长时任务支持设备本应用申请，也支持跨设备或跨应用申请。
跨设备或者跨应用在后台执行长时任务时，可以通过Call的方式在后台创建并运行UIAbility，具体使用请参考Call调用开发指南（同设备）和Call调用开发指南（跨设备）。

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

 @Entry
 @Component
 struct Index {
   @State message: string = 'ContinuousTask';
  // 通过getContext方法，来获取page所在的UIAbility上下文。
   private context: Context = getContext(this);

   startContinuousTask() {
     let wantAgentInfo: wantAgent.WantAgentInfo = {
       // 点击通知后，将要执行的动作列表
       // 添加需要被拉起应用的bundleName和abilityName
       wants: [
         {
           bundleName: "com.example.myapplication",
           abilityName: "com.example.myapplication.MainAbility"
         }
       ],
       // 指定点击通知栏消息后的动作是拉起ability
       actionType: wantAgent.OperationType.START_ABILITY,
       // 使用者自定义的一个私有值
       requestCode: 0,
       // 点击通知后，动作执行属性
       wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
     };

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

   stopContinuousTask() {
      backgroundTaskManager.stopBackgroundRunning(this.context).then(() => {
        console.info(`Succeeded in operationing stopBackgroundRunning.`);
      }).catch((err: BusinessError) => {
        console.error(`Failed to operation stopBackgroundRunning. Code is ${err.code}, message is ${err.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%')
   }
 }

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

 const MSG_SEND_METHOD: string = 'CallSendMsg'

 let mContext: Context;

 function startContinuousTask() {
   let wantAgentInfo : wantAgent.WantAgentInfo = {
     // 点击通知后，将要执行的动作列表
     wants: [
       {
         bundleName: "com.example.myapplication",
         abilityName: "com.example.myapplication.MainAbility",
       }
     ],
     // 点击通知后，动作类型
     actionType: wantAgent.OperationType.START_ABILITY,
     // 使用者自定义的一个私有值
     requestCode: 0,
     // 点击通知后，动作执行属性
     wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
   };

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

 function stopContinuousTask() {
   backgroundTaskManager.stopBackgroundRunning(mContext).then(() => {
     console.info(`Succeeded in operationing stopBackgroundRunning.`);
   }).catch((err: BusinessError) => {
     console.error(`Failed to operation stopBackgroundRunning. Code is ${err.code}, message is ${err.message}`);
   });
 }

 class MyParcelable implements rpc.Parcelable {
   num: number = 0;
   str: string = '';

   constructor(num: number, string: string) {
     this.num = num;
     this.str = string;
   }

   marshalling(messageSequence: rpc.MessageSequence) {
     messageSequence.writeInt(this.num);
     messageSequence.writeString(this.str);
     return true;
   }

   unmarshalling(messageSequence: rpc.MessageSequence) {
     this.num = messageSequence.readInt();
     this.str = messageSequence.readString();
     return true;
   }
 }

 function sendMsgCallback(data: rpc.MessageSequence) {
   console.info('BgTaskAbility funcCallBack is called ' + data);
   let receivedData: MyParcelable = new MyParcelable(0, '');
   data.readParcelable(receivedData);
   console.info(`receiveData[${receivedData.num}, ${receivedData.str}]`);
   // 可以根据Caller端发送的序列化数据的str值，执行不同的方法。
   if (receivedData.str === 'start_bgtask') {
     // 申请长时
     startContinuousTask();
   } else if (receivedData.str === 'stop_bgtask') {
     // 取消长时
     stopContinuousTask();
   }
   return new MyParcelable(10, 'Callee test');
 }

 export default class BgTaskAbility extends UIAbility {
   // Ability创建
   onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
     console.info("[Demo] BgTaskAbility onCreate");
     try {
       this.callee.on(MSG_SEND_METHOD, sendMsgCallback)
     } catch (error) {
       console.error(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`);
     }
     mContext = this.context;
   }
  
   // Ability销毁
   onDestroy() {
     console.info('[Demo] BgTaskAbility onDestroy');
   }

   onWindowStageCreate(windowStage: window.WindowStage) {
     console.info('[Demo] BgTaskAbility onWindowStageCreate');

     windowStage.loadContent('pages/Index', (error, data) => {
       if (error.code) {
         console.error(`load content failed with error ${JSON.stringify(error)}`);
         return;
       }
       console.info(`load content succeed with data ${JSON.stringify(data)}`);
     });
   }

   onWindowStageDestroy() {
     console.info('[Demo] BgTaskAbility onWindowStageDestroy');
   }
   
   onForeground() {
     console.info('[Demo] BgTaskAbility onForeground');
   }

   onBackground() {
     console.info('[Demo] BgTaskAbility onBackground');
   }
 };

FA模型

启动并连接ServiceAbility。
- 不需要与用户进行交互时，采用startAbility()方法启动ServiceAbility（具体使用请参考ServiceAbility组件，并在ServiceAbility的onStart回调方法中，调用长时任务的申请和取消接口。
- 需要与用户进行交互时（如播放音乐），采用connectAbility()方法启动并连接ServiceAbility（具体使用请参考ServiceAbility组件，在获取到服务的代理对象后，与服务进行通信，控制长时任务的申请和取消。

配置权限和声明后台模式类型。

在config.json文件中配置长时任务权限ohos.permission.KEEP_BACKGROUND_RUNNING，配置方式请参见声明权限。同时，为需要使用长时任务的ServiceAbility声明相应的长时任务类型。

"module": {
    "package": "com.example.myapplication",
    "abilities": [
        {
            "backgroundModes": [
            "audioRecording",
            ], // 后台模式类型
            "type": "service"  // ability类型为service
        }
    ],
    "reqPermissions": [
        {
            "name": "ohos.permission.KEEP_BACKGROUND_RUNNING"  // 长时任务权限
        }
    ]
}