harmony 鸿蒙@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)
@ohos.app.ability.ServiceExtensionAbility (ServiceExtensionAbility)
ServiceExtensionAbility模块提供后台服务相关扩展能力,提供后台服务创建、销毁、连接、断开等生命周期回调。
说明:
本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口仅可在Stage模型下使用。
导入模块
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
权限
无
属性
系统能力:SystemCapability.Ability.AbilityRuntime.Core
系统API: 此接口为系统接口,三方应用不支持调用。
名称 | 类型 | 可读 | 可写 | 说明 |
---|---|---|---|---|
context | ServiceExtensionContext | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
ServiceExtensionAbility.onCreate
onCreate(want: Want): void;
Extension生命周期回调,在创建时回调,执行初始化业务逻辑操作。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
系统API: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
示例:
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: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
示例:
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
Extension生命周期回调,如果是connectAbility拉起的服务,会在onCreate之后回调。返回一个RemoteObject对象,用于客户端和服务端进行通信。
系统能力:SystemCapability.Ability.AbilityRuntime.Core
系统API: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
返回值:
类型 | 说明 |
---|---|
rpc.RemoteObject | 一个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) {
}
}
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: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
示例:
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: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
want | Want | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
示例:
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: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
newConfig | Configuration | 是 | 表示需要更新的配置信息。 |
示例:
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: 此接口为系统接口,三方应用不支持调用。
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
params | Array<string> | 是 | 表示命令形式的参数。 |
示例:
import ServiceExtension from '@ohos.app.ability.ServiceExtensionAbility';
class ServiceExt extends ServiceExtension {
onDump(params: Array<string>) {
console.log(`dump, params: ${JSON.stringify(params)}`);
return ['params'];
}
}
你可能感兴趣的鸿蒙文章
harmony 鸿蒙BundleStatusCallback
harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)
harmony 鸿蒙@ohos.distributedBundle (分布式包管理)
harmony 鸿蒙@ohos.bundle (Bundle模块)
harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦