【HarmonyOS NEXT】鸿蒙系统如何执行后台任务

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

ConneyWu

6179人浏览 · 2024-06-11 16:38:39

ConneyWu · 2024-06-11 16:38:39 发布

应用退至后台后，在后台需要长时间运行用户可感知的任务，如播放音乐、导航等。为防止应用进程被挂起，导致对应功能异常，可以申请长时任务，使应用在后台长时间运行。、

申请长时任务后，系统会做相应的校验，确保应用在执行相应的长时任务。同时，系统有与长时任务相关联的通知栏消息，用户删除通知栏消息时，系统会自动停止长时任务。

使用场景

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

表1 长时任务类型

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

使用了网络管理服务的应用，才能通过申请DATA_TRANSFER长时任务实现后台上传下载，不被挂起。如果使用上传下载代理接口托管给系统执行，无论是否申请DATA_TRANSFER，应用都会被挂起。
使用了媒体会话服务的音视频应用，才能通过申请AUDIO_PLAYBACK长时任务实现后台播放。

约束与限制

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

场景1：若应用申请了长时任务，但未真正执行申请类型的长时任务或申请类型的任务已结束，系统会对应用进行管控。例如系统检测到应用申请了AUDIO_PLAYBACK（音视频播放），但实际未播放音乐，长时任务会被取消。

场景2：若应用没有申请对应的长时任务类型，但执行了相关类型的长时任务，系统会对应用进行管控。例如系统检测到应用只申请了AUDIO_PLAYBACK（音视频播放），但实际上除了播放音乐（对应AUDIO_PLAYBACK类型），还在进行录音（对应AUDIO_RECORDING类型），系统会对应用进行管控。

场景3：若运行长时任务的进程后台负载持续高于所申请类型的典型负载，系统会对应用进行管控。

以下是长时任务开发使用的相关接口，下表均以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，其余模块按实际需要导入。
申请和取消长时任务。

在Stage模型中，长时任务支持设备本应用申请，也支持跨设备或跨应用申请，跨设备或跨应用仅对系统应用开放。

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

  // 通过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}`);
      });
   }

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"  // 长时任务权限
        }
    ]
}

导入模块。
import backgroundTaskManager from '@ohos.resourceschedule.backgroundTaskManager';
申请和取消长时任务。在 ServiceAbility 中，调用 startBackgroundRunning() 接口和 stopBackgroundRunning() 接口实现长时任务的申请和取消，通过js代码实现。

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

 async function processAsyncJobs() {
   // 此处执行具体的长时任务。

   // 长时任务执行完，调用取消接口，释放资源。
   stopContinuousTask();
 }

 let mMyStub: MyStub;

 // 采用connectAbility的方式启动服务
 class MyStub extends rpc.RemoteObject {
   constructor(des: string) {
     super(des);
   }

   onRemoteRequest(code: number, data: rpc.MessageParcel, reply: rpc.MessageParcel, option: rpc.MessageOption) {
     console.log('ServiceAbility onRemoteRequest called');
     // code 的具体含义用户自定义
     if (code === 1) {
       // 接收到申请长时任务的请求码
       startContinuousTask();
       // 此处执行具体长时任务
     } else if (code === 2) {
       // 接收到取消长时任务的请求码
       stopContinuousTask();
     } else {
       console.log('ServiceAbility unknown request code');
     }
     return true;
   }
 }

 // 采用startAbility的方式启动服务
 class ServiceAbility {
   onStart(want: Want) {
     console.info('ServiceAbility onStart');
     mMyStub = new MyStub("ServiceAbility-test");
     // 在执行长时任务前，调用申请接口。
     startContinuousTask();
     processAsyncJobs();
   }

   onStop() {
     console.info('ServiceAbility onStop');
   }

   onConnect(want: Want) {
     console.info('ServiceAbility onConnect');
     return mMyStub;
   }

   onReconnect(want: Want) {
     console.info('ServiceAbility onReconnect');
   }

   onDisconnect() {
     console.info('ServiceAbility onDisconnect');
   }

   onCommand(want: Want, startId: number) {
     console.info('ServiceAbility onCommand');
   }
 }

 export default new ServiceAbility();

HarmonyOS NEXT Developer Beta1