@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)

ServiceExtensionAbility模块提供后台服务相关扩展能力，提供后台服务创建、销毁、连接、断开等生命周期回调。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
本模块接口均为系统接口。
本模块接口仅可在Stage模型下使用。

导入模块

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';

权限

无

属性

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

ServiceExtensionAbility.onCreate

onCreate(want: Want): void;

Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class ServiceExt extends ServiceExtension {
  onCreate(want: Want) {
    console.log('onCreate, want: ${want.abilityName}');
  }
}

ServiceExtensionAbility.onDestroy

onDestroy(): void;

Extension生命周期回调，在销毁时回调，执行资源清理等操作。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';

class ServiceExt extends ServiceExtension {
  onDestroy() {
    console.log('onDestroy');
  }
}

ServiceExtensionAbility.onRequest

onRequest(want: Want, startId: number): void;

Extension生命周期回调，如果是startAbility或者startServiceExtensionAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class ServiceExt extends ServiceExtension {
  onRequest(want: Want, startId: number) {
    console.log('onRequest, want: ${want.abilityName}');
  }
}

ServiceExtensionAbility.onConnect

onConnect(want: Want): rpc.RemoteObject | Promise<rpc.RemoteObject>;

Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于客户端和服务端进行通信。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

返回值：

示例：

import rpc from '@ohos.rpc';
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class StubTest extends rpc.RemoteObject{
    constructor(des: string) {
        super(des);
    }
    onConnect(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption) {
    }
}
class ServiceExt extends ServiceExtension {
  onConnect(want: Want) {
    console.log('onConnect , want: ${want.abilityName}');
    return new StubTest('test');
  }
}

如果生成返回值RemoteObject依赖一个异步接口，可以使用异步生命周期：

import rpc from '@ohos.rpc';
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class StubTest extends rpc.RemoteObject{
  constructor(des: string) {
      super(des);
  }
  onConnect(code: number, data: rpc.MessageSequence, reply: rpc.MessageSequence, option: rpc.MessageOption) {
  }
}
async function getDescriptor() {
  // 调用异步函数...
  return "asyncTest"
}
class ServiceExt extends ServiceExtension {
async onConnect(want: Want) {
  console.log(`onConnect , want: ${want.abilityName}`);
  let descriptor = await getDescriptor();
  return new StubTest(descriptor);
}
}

ServiceExtensionAbility.onDisconnect

onDisconnect(want: Want): void | Promise<void>;

Extension的生命周期回调，客户端执行断开连接服务时回调。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class ServiceExt extends ServiceExtension {
  onDisconnect(want: Want) {
    console.log('onDisconnect, want: ${want.abilityName}');
  }
}

在执行完onDisconnect生命周期回调后，应用可能会退出，从而可能导致onDisconnect中的异步函数未能正确执行，比如异步写入数据库。可以使用异步生命周期，以确保异步onDisconnect完成后再继续后续的生命周期。

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class ServiceExt extends ServiceExtension {
async onDisconnect(want: Want) {
  console.log('onDisconnect, want: ${want.abilityName}');
  // 调用异步函数...
}
}

ServiceExtensionAbility.onReconnect

onReconnect(want: Want): void;

Extension的生命周期回调，当所有以前的客户端都断开连接之后，新客户端尝试连接到服务时调用。预留能力，当前暂未支持。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import Want from '@ohos.app.ability.Want';

class ServiceExt extends ServiceExtension {
  onReconnect(want: Want) {
    console.log('onReconnect, want: ${want.abilityName}');
  }
}

ServiceExtensionAbility.onConfigurationUpdate

onConfigurationUpdate(newConfig: Configuration): void;

当Extension更新配置信息时调用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
import { Configuration } from '@ohos.app.ability.Configuration';

class ServiceExt extends ServiceExtension {
    onConfigurationUpdate(config: Configuration) {
        console.log(`onConfigurationUpdate, config: ${JSON.stringify(config)}`);
    }
}

ServiceExtensionAbility.onDump

onDump(params: Array<string>): Array<string>;

转储客户端信息时调用。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

系统API: 此接口为系统接口，三方应用不支持调用。

参数：

示例：

import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';

class ServiceExt extends ServiceExtension {
    onDump(params: Array<string>) {
        console.log(`dump, params: ${JSON.stringify(params)}`);
        return ['params'];
    }
}