1# IPC/RPC组件<a name="ZH-CN_TOPIC_0000001103602398"></a> 2 3- [简介](#section11660541593) 4- [系统架构](#section1950291414611) 5- [目录](#section161941989596) 6- [约束](#section119744591305) 7- [编译构建](#section137768191623) 8- [说明](#section1312121216216) 9 - [接口说明](#section1551164914237) 10 - [使用说明](#section129654513264) 11 12- [相关仓](#section1371113476307) 13 14## 简介<a name="section11660541593"></a> 15 16IPC（Inter-Process Communication）与RPC（Remote Procedure Call）机制用于实现跨进程通信，不同的是前者使用Binder驱动，用于设备内的跨进程通信，而后者使用软总线驱动，用于跨设备跨进程通信。IPC和RPC通常采用客户端-服务器（Client-Server）模型，服务请求方（Client）可获取提供服务提供方（Server）的代理 （Proxy），并通过此代理读写数据来实现进程间的数据通信。通常，系统能力（System Ability）Server侧会先注册到系统能力管理者（System Ability Manager，缩写SAMgr）中，SAMgr负责管理这些SA并向Client提供相关的接口。Client要和某个具体的SA通信，必须先从SAMgr中获取该SA的代理，然后使用代理和SA通信。三方应用可以使用FA提供的接口绑定服务提供方的Ability，获取代理，进行通信。下文使用Proxy表示服务请求方，Stub表示服务提供方。 17 18## 系统架构<a name="section1950291414611"></a> 19 20**图 1** IPC通信机制架构图<a name="fig312319321710"></a> 21 22 23## 目录<a name="section161941989596"></a> 24 25``` 26/foundation/communication/ipc 27├── interfaces # 对外接口存放目录 28│ └── innerkits # 对内部子系统暴露的头文件存放目录 29│ ├── ipc_core # ipc 接口存放目录 30│ └── libdbinder # dbinder 接口存放目录 31├── ipc # ipc 框架代码 32│ ├── native # ipc native 实现存放目录 33│ ├── src # ipc native 源代码存放目录 34│ └── test # ipc native 单元测试用例存放目录 35│ └── test # ipc native 模块测试用例存放目录 36├── service # dbinder 实现存放目录 37│ └── dbinder # dbinder 源代码存放目录 38``` 39 40## 约束<a name="section119744591305"></a> 41 421. 单个设备上跨进程通信时，传输的数据量最大约为1MB，过大的数据量请使用匿名共享内存。 432. 不支持把跨设备的Proxy对象传递回该Proxy对象所指向的Stub对象所在的设备。 44 45## 编译构建<a name="section137768191623"></a> 46 47**JS侧依赖** 48 49``` 50import rpc from "@ohos.rpc" 51import featureAbility from "@ohos.ability.featureAbility" 52``` 53 54**Native侧编译依赖** 55 56sdk依赖： 57 58``` 59external_deps = [ 60 "ipc:ipc_core", 61] 62``` 63 64此外， IPC/RPC依赖的refbase实现在公共基础库下，请增加对utils的依赖： 65 66``` 67external_deps = [ 68 "c_utils:utils", 69] 70``` 71 72## 说明<a name="section1312121216216"></a> 73 74**JS侧实现跨进程通信基本步骤：** 75 761. 获取代理 77 78 使用ohos.ability.featureAbility提供的connectAbility方法绑定Ability，在参数里指定要绑定的Ability所在应用的包名、组件名，如果是跨设备的情况，还需要指定所在设备的NetworkId。用户需要在服务端的onConnect方法里返回一个继承自ohos.rpc.RemoteObject的对象，此对象会在其onRemoteMessageRequest方法里接收到请求。 79 802. 发送请求 81 82 客户端在connectAbility参数指定的回调函数接收到代理对象后，使用ohos.rpc模块提供的方法完成RPC通信，其中MessageParcel提供了读写各种类型数据的方法，IRemoteObject提供了发送请求的方法，RemoteObject提供了处理请求的方法onRemoteRequest，用户需要重写。 83 84**Native侧实现跨进程通信的基本步骤：** 85 861. 定义接口类 87 88 接口类继承IRemoteBroker，定义描述符、业务函数和消息码。 89 902. 实现服务提供端\(Stub\) 91 92 Stub继承IRemoteStub\(Native\)，除了接口类中未实现方法外，还需要实现AsObject方法及OnRemoteRequest方法。 93 943. 实现服务请求端\(Proxy\) 95 96 Proxy继承IRemoteProxy\(Native\)，封装业务函数，调用SendRequest将请求发送到Stub。 97 984. 注册SA 99 100 服务提供方所在进程启动后，申请SA的唯一标识，将Stub注册到SAMgr。 101 1025. 获取SA 103 1046. 通过SA的标识和设备NetworkId，从SAMgr获取Proxy，通过Proxy实现与Stub的跨进程通信。 105 106### 接口说明<a name="section1551164914237"></a> 107 108**表 1** JS侧IPC关键API 109 110| 模块 | 方法 | 功能说明 | 111| --------------------------- | ------------------------------------------------------------ | ------------------------------------------- | 112| ohos.ability.featureAbility | connectAbility(request: Want, options:ConnectOptions ): number | 绑定指定的Ability，在回调函数里接收代理对象 | 113| ohos.rpc.RemoteObject | onRemoteMessageRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): boolean \| Promise<boolean> | 服务端处理请求，返回结果 | 114| ohos.rpc.IRemoteObject | sendRequestAsync(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption): Promise<SendRequestResult> | 发送请求，在期约里接收结果 | 115| ohos.rpc.IRemoteObject | sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void | 发送请求，在回调函数里接收结果 | 116| ohos.rpc.MessageParcel | writeRemoteObject(object: IRemoteObject): boolean | 序列化IRemoteObject对象 | 117| ohos.rpc.MessageParcel | readRemoteObject(): IRemoteObject | 反序列化IRemoteObject对象 | 118 119 120 121**表 2** Native侧IPC接口 122 123<a name="table178849240013"></a> 124 125<table><thead align="left"><tr id="row6884924608"><th class="cellrowborder" valign="top" width="14.12141214121412%" id="mcps1.2.4.1.1"><p id="p98846241706"><a name="p98846241706"></a><a name="p98846241706"></a>类/接口</p> 126</th> 127<th class="cellrowborder" valign="top" width="52.54525452545254%" id="mcps1.2.4.1.2"><p id="p1488482414020"><a name="p1488482414020"></a><a name="p1488482414020"></a>方法</p> 128</th> 129<th class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.2.4.1.3"><p id="p388516244016"><a name="p388516244016"></a><a name="p388516244016"></a>功能说明</p> 130</th> 131</tr> 132</thead> 133<tbody><tr id="row15885824402"><td class="cellrowborder" valign="top" width="14.12141214121412%" headers="mcps1.2.4.1.1 "><p id="p08859241008"><a name="p08859241008"></a><a name="p08859241008"></a>IRemoteBroker</p> 134</td> 135<td class="cellrowborder" valign="top" width="52.54525452545254%" headers="mcps1.2.4.1.2 "><p id="p388572412010"><a name="p388572412010"></a><a name="p388572412010"></a>sptr<IRemoteObject> AsObject()</p> 136</td> 137<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p13885724405"><a name="p13885724405"></a><a name="p13885724405"></a>返回通信对象。派生类需要实现，Stub端返回RemoteObject对象本身，Proxy端返回代理对象。</p> 138</td> 139</tr> 140<tr id="row138859241808"><td class="cellrowborder" valign="top" width="14.12141214121412%" headers="mcps1.2.4.1.1 "><p id="p1888515245012"><a name="p1888515245012"></a><a name="p1888515245012"></a>IRemoteStub</p> 141</td> 142<td class="cellrowborder" valign="top" width="52.54525452545254%" headers="mcps1.2.4.1.2 "><p id="p1388516240011"><a name="p1388516240011"></a><a name="p1388516240011"></a>virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option)</p> 143</td> 144<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p1188582414016"><a name="p1188582414016"></a><a name="p1188582414016"></a>请求处理方法，派生类需要重写，处理Proxy的请求并返回结果。</p> 145</td> 146</tr> 147<tr id="row108856241904"><td class="cellrowborder" valign="top" width="14.12141214121412%" headers="mcps1.2.4.1.1 "><p id="p6885924609"><a name="p6885924609"></a><a name="p6885924609"></a>IRemoteProxy</p> 148</td> 149<td class="cellrowborder" valign="top" width="52.54525452545254%" headers="mcps1.2.4.1.2 "> </td> 150<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.2.4.1.3 "><p id="p688592413018"><a name="p688592413018"></a><a name="p688592413018"></a>业务Proxy类派生自IRemoteProxy类。</p> 151</td> 152</tr> 153</tbody> 154</table> 155 156### 使用说明<a name="section129654513264"></a> 157 158**JS侧使用说明** 159 1601. 客户端构造变量want，指定要绑定的Ability所在应用的包名、组件名，如果是跨设备的场景，还需要目标设备NetworkId。构造变量connect，指定绑定成功、绑定失败、断开连接时的回调函数。使用featureAbility提供的接口绑定Ability。 161 162 ``` 163 import rpc from "@ohos.rpc" 164 import featureAbility from "@ohos.ability.featureAbility" 165 166 let proxy = null 167 let connectId = null 168 169 // 单个设备 170 let want = { 171 // 包名和组件名写实际的值 172 "bundleName": "ohos.rpc.test.server", 173 "abilityName": "ohos.rpc.test.server.ServiceAbility", 174 } 175 let connect = { 176 onConnect:function(elementName, remote) { 177 proxy = remote 178 }, 179 onDisconnect:function(elementName) { 180 }, 181 onFailed:function() { 182 proxy = null 183 } 184 } 185 connectId = featureAbility.connectAbility(want, connect) 186 187 // 如果是跨设备绑定，可以使用deviceManager获取目标设备NetworkId 188 import deviceManager from '@ohos.distributedHardware.deviceManager' 189 function deviceManagerCallback(deviceManager) { 190 let deviceList = deviceManager.getTrustedDeviceListSync() 191 let deviceId = deviceList[0].deviceId 192 let want = { 193 "bundleName": "ohos.rpc.test.server", 194 "abilityName": "ohos.rpc.test.service.ServiceAbility", 195 "deviceId": deviceId, 196 "flags": 256 197 } 198 connectId = featureAbility.connectAbility(want, connect) 199 } 200 // 第一个参数是本应用的包名，第二个参数是接收deviceManager的回调函数 201 deviceManager.createDeviceManager("ohos.rpc.test", deviceManagerCallback) 202 ``` 203 204 205 2062. 服务端被绑定的Ability在onConnect方法里返回继承自rpc.RemoteObject的对象，该对象需要实现onRemoteMessageRequest方法，处理客户端的请求。 207 208 ``` 209 import rpc from "@ohos.rpc" 210 onConnect(want: Want) { 211 var robj:rpc.RemoteObject = new Stub("rpcTestAbility") 212 return robj 213 } 214 class Stub extends rpc.RemoteObject { 215 constructor(descriptor) { 216 super(descriptor) 217 } 218 onRemoteMessageRequest(code, data, reply, option) { 219 // 根据code处理客户端的请求 220 return true 221 } 222 } 223 ``` 224 225 226 2273. 客户端在onConnect回调里接收到代理对象，调用sendRequestAsync方法发起请求，在期约或者回调函数里接收结果。 228 229 ``` 230 import rpc from "@ohos.rpc" 231 // 使用期约 232 let option = new rpc.MessageOption() 233 let data = rpc.MessageParcel.create() 234 let reply = rpc.MessageParcel.create() 235 // 往data里写入参数 236 proxy.sendRequestAsync(1, data, reply, option) 237 .then(function(result) { 238 if (result.errCode != 0) { 239 console.error("send request failed, errCode: " + result.errCode) 240 return 241 } 242 // 从result.reply里读取结果 243 }) 244 .catch(function(e) { 245 console.error("send request got exception: " + e) 246 } 247 .finally(() => { 248 data.reclaim() 249 reply.reclaim() 250 }) 251 252 // 使用回调函数 253 function sendRequestCallback(result) { 254 try { 255 if (result.errCode != 0) { 256 console.error("send request failed, errCode: " + result.errCode) 257 return 258 } 259 // 从result.reply里读取结果 260 } finally { 261 result.data.reclaim() 262 result.reply.reclaim() 263 } 264 } 265 let option = new rpc.MessageOption() 266 let data = rpc.MessageParcel.create() 267 let reply = rpc.MessageParcel.create() 268 // 往data里写入参数 269 proxy.sendRequest(1, data, reply, option, sendRequestCallback) 270 ``` 271 272 273 2744. IPC通信结束后，使用featureAbility的接口断开连接。 275 276 ``` 277 import rpc from "@ohos.rpc" 278 import featureAbility from "@ohos.ability.featureAbility" 279 function disconnectCallback() { 280 console.info("disconnect ability done") 281 } 282 featureAbility.disconnectAbility(connectId, disconnectCallback) 283 ``` 284 285 286 287**Native侧使用说明** 288 2891. 定义IPC接口ITestAbility 290 291 IPC接口继承IPC基类接口IRemoteBroker，接口里定义描述符、业务函数和消息码，其中业务函数在Proxy端和Stub端都需要实现。 292 293 ``` 294 class ITestAbility : public IRemoteBroker { 295 public: 296 // DECLARE_INTERFACE_DESCRIPTOR是必须的， 入参需使用std::u16string； 297 DECLARE_INTERFACE_DESCRIPTOR(u"test.ITestAbility"); // DESCRIPTOR接口描述符建议使用"组件名.类名"的格式 298 int TRANS_ID_PING_ABILITY = 1; // 定义消息码 299 virtual int TestPingAbility(const std::u16string &dummy) = 0; // 定义业务函数 300 }; 301 ``` 302 303 304 3052. 定义和实现服务端TestAbilityStub 306 307 该类是和IPC框架相关的实现，需要继承自IRemoteStub<ITestAbility\>。Stub端作为接收请求的一端，需重写OnRemoteRequest方法用于接收客户端调用。 308 309 ``` 310 class TestAbilityStub : public IRemoteStub<ITestAbility> { 311 public: 312 virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override; 313 int TestPingAbility(const std::u16string &dummy) override; 314 }; 315 316 int TestServiceStub::OnRemoteRequest(uint32_t code, 317 MessageParcel &data, MessageParcel &reply, MessageOption &option) 318 { 319 if (data.ReadInterfaceToken() != GetDescriptor()) { //校验是否为本服务的接口描述符，避免中继攻击 320 return -1; 321 } 322 switch (code) { 323 case TRANS_ID_PING_ABILITY: { 324 std::u16string dummy = data.ReadString16(); 325 int result = TestPingAbility(dummy); 326 reply.WriteInt32(result); 327 return 0; 328 } 329 default: 330 return IPCObjectStub::OnRemoteRequest(code, data, reply, option); 331 } 332 } 333 ``` 334 335 336 3373. 定义服务端业务函数具体实现类TestAbility 338 339 ``` 340 class TestAbility : public TestAbilityStub { 341 public: 342 int TestPingAbility(const std::u16string &dummy); 343 } 344 345 int TestAbility::TestPingAbility(const std::u16string &dummy) { 346 return 0; 347 } 348 ``` 349 350 351 3524. 定义和实现客户端TestAbilityProxy 353 354 该类是Proxy端实现，继承自IRemoteProxy<ITestAbility\>，调用SendRequest接口向Stub端发送请求，对外暴露服务端提供的能力。 355 356 ``` 357 class TestAbilityProxy : public IRemoteProxy<ITestAbility> { 358 public: 359 explicit TestAbilityProxy(const sptr<IRemoteObject> &impl); 360 int TestPingService(const std::u16string &dummy) override; 361 private: 362 static inline BrokerDelegator<TestAbilityProxy> delegator_; // 方便使用iface_cast宏 363 } 364 365 TestAbilityProxy::TestAbilityProxy(const sptr<IRemoteObject> &impl) 366 : IRemoteProxy<ITestAbility>(impl) 367 { 368 } 369 370 int TestAbilityProxy::TestPingService(const std::u16string &dummy) { 371 MessageOption option; 372 MessageParcel dataParcel, replyParcel; 373 if(!dataParcel.WriteInterfaceToken(GetDescriptor())) { //所有对外接口的proxy实现都要写入接口描述符，用于stub端检验 374 return -1; 375 } 376 if(!dataParcel.WriteString16(dummy)) { 377 return -1; 378 } 379 int error = Remote()->SendRequest(TRANS_ID_PING_ABILITY, dataParcel, replyParcel, option); 380 int result = (error == ERR_NONE) ? replyParcel.ReadInt32() : -1; 381 return result; 382 } 383 ``` 384 385 386 3875. 同步调用与异步调用 388 389 MessageOption作为发送接口（原型如下）的入参，可设定同步（TF\_SYNC）、异步（TF\_ASYNC），默认情况下设定为同步，其余可通过MessageOption构造方法或void SetFlags\(int flags\)设定。 390 391 ``` 392 int SendRequest(uint32_t code, MessageParcel &data, 393 MessageParcel &reply, MessageOption &option) override; 394 MessageOption option; 395 option.setFlags(option.TF_ASYNC); 396 ``` 397 398 399 4006. SA注册与启动 401 402 SA需要将自己的TestAbilityStub实例通过AddSystemAbility接口注册到SystemAbilityManager，设备内与分布式的注册参数不同。 403 404 ``` 405 // 注册到本设备内 406 auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); 407 samgr->AddSystemAbility(said, new TestAbility()); 408 409 // 在组网场景下，会被同步到其他设备上 410 auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); 411 ISystemAbilityManager::SAExtraProp saExtra; 412 saExtra.isDistributed = true; // 设置为分布式SA 413 int result = samgr->AddSystemAbility(said, new TestAbility(), saExtra); 414 ``` 415 416 417 4187. SA获取与调用 419 420 通过SystemAbilityManager的GetSystemAbility方法可获取到对应SA的代理IRemoteObject，然后构造TestAbilityProxy即可。 421 422 ``` 423 // 获取本设备内注册的SA的proxy 424 sptr<ISystemAbilityManager> samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); 425 sptr<IRemoteObject> remoteObject = samgr->GetSystemAbility(said); 426 sptr<ITestAbility> testAbility = iface_cast<ITestAbility>(remoteObject); // 使用iface_cast宏转换成具体类型 427 428 // 获取其他设备注册的SA的Proxy 429 sptr<ISystemAbilityManager> samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager(); 430 sptr<IRemoteObject> remoteObject = samgr->GetSystemAbility(sdid, deviceId); // deviceId是指定设备的标识符 431 sptr<TestAbilityProxy> proxy(new TestAbilityProxy(remoteObject)); // 直接构造具体Proxy 432 ``` 433 434 435 436## 相关仓<a name="section1371113476307"></a> 437 438分布式软总线子系统 439 440**communication\_ipc** 441 442[commonlibrary\_c\_utils](https://gitee.com/openharmony/commonlibrary_c_utils) 443 444[distributedschedule\_samgr](https://gitee.com/openharmony/distributedschedule_samgr) 445 446 447
