js-apis-service-extension.md 3.7 KB
Newer Older
1 2 3 4 5 6
# ServiceExtension

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


7
提供ServiceExtension服务扩展相关接口。
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23


## 导入模块

```
import ServiceExtension from '@ohos.application.ServiceExtension';
```


## 权限




## 属性

24
| 名称 | 参数类型 | 可读 | 可写 | 说明 | 
25
| -------- | -------- | -------- | -------- | -------- |
26
| context | [ServiceExtensionContext](js-apis-service-extension-context.md)  | 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 | 
27 28 29 30


## onCreate

31
onCreate(want: Want): void;
32

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

- 参数:
36
  | 参数名 | 类型 | 必填 | 说明 | 
37
  | -------- | -------- | -------- | -------- |
38
  | want |  [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
39 40 41

- 示例:
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
42 43
  class ServiceExt extends ServiceExtension {
    onCreate(want) {
44
      console.log('onCreate, want:' + want.abilityName);
ahjxliubao2's avatar
ahjxliubao2 已提交
45
    }
46 47 48 49 50 51
  }
  ```


## onDestroy

52
onDestroy(): void;
53

54
Extension生命周期回调,在销毁时回调,执行资源清理等操作。
55 56 57

- 示例:
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
58 59
  class ServiceExt extends ServiceExtension {
    onDestroy() {
60
      console.log('onDestroy');
ahjxliubao2's avatar
ahjxliubao2 已提交
61
    }
62 63 64 65 66 67
  }
  ```


## onRequest

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

70
Extension生命周期回调,如果是startAbility拉起的服务,会在onCreate之后回调。每次拉起服务都会回调,startId会递增。
71 72

- 参数:
73
  | 参数名 | 类型 | 必填 | 说明 | 
74
  | -------- | -------- | -------- | -------- |
75 76
  | want |  [Want](js-apis-featureAbility.md#Want类型说明) | 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
  | startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 | 
77 78 79

- 示例:
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
80 81
  class ServiceExt extends ServiceExtension {
    onRequest(want, startId) {
82
      console.log('onRequest, want:' + want.abilityName);
ahjxliubao2's avatar
ahjxliubao2 已提交
83
    }
84 85 86 87 88 89
  }
  ```


## onConnect

90
onConnect(want: Want): rpc.RemoteObject;
91

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

- 参数:
95
  | 参数名 | 类型 | 必填 | 说明 | 
96
  | -------- | -------- | -------- | -------- |
97
  | want |  [Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
98 99

- 返回值:
100
  | 类型 | 说明 | 
101
  | -------- | -------- |
102
  | rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 | 
103 104 105 106 107 108 109 110 111 112 113

- 示例:
  ```
  import rpc from '@ohos.rpc'
  class StubTest extends rpc.RemoteObject{
      constructor(des) {
          super(des);
      }
      onRemoteRequest(code, data, reply, option) {
      }
  }
ahjxliubao2's avatar
ahjxliubao2 已提交
114 115
  class ServiceExt extends ServiceExtension {
    onConnect(want) {
116 117
      console.log('onConnect , want:' + want.abilityName);
      return new StubTest("test");
ahjxliubao2's avatar
ahjxliubao2 已提交
118
    }
119 120 121 122 123 124
  }
  ```


## onDisconnect

125
onDisconnect(want: Want): void;
126 127 128 129

Extension的生命周期,断开服务连接时回调。

- 参数:
130
  | 参数名 | 类型 | 必填 | 说明 | 
131
  | -------- | -------- | -------- | -------- |
132
  | want |[Want](js-apis-featureAbility.md#Want类型说明)| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 | 
133 134 135

- 示例:
  ```
ahjxliubao2's avatar
ahjxliubao2 已提交
136 137
  class ServiceExt extends ServiceExtension {
    onDisconnect(want) {
138
      console.log('onDisconnect, want:' + want.abilityName);
ahjxliubao2's avatar
ahjxliubao2 已提交
139
    }
140 141
  }
  ```