一、IPC 与 RPC 通信概述
基本概念
IPC（Inter-Process Communication）与 RPC（Remote Procedure Call）用于实现跨进程通信，不同的是前者使用 Binder 驱动，用于设备内的跨进程通信，后者使用软总线驱动，用于跨设备跨进程通信。需要跨进程通信的原因是因为每个进程都有自己独立的资源和内存空间，其他进程不能随意访问不同进程的内存和资源，IPC/RPC 便是为了突破这一点。IPC 和 RPC 通常采用客户端-服务器（Client-Server）模型，在使用时，请求服务的（Client）一端进程可获取提供服务（Server）一端所在进程的代理（Proxy），并通过此代理读写数据来实现进程间的数据通信，更具体的讲，首先请求服务的（Client）一端会建立一个服务提供端（Server）的代理对象，这个代理对象具备和服务提供端（Server）一样的功能，若想访问服务提供端（Server）中的某一个方法，只需访问代理对象中对应的方法即可，代理对象会将请求发送给服务提供端（Server）；然后服务提供端（Server）处理接受到的请求，处理完之后通过驱动返回处理结果给代理对象；最后代理对象将请求结果进一步返回给请求服务端（Client）。通常，Server 会先注册系统能力（System Ability）到系统能力管理者（System Ability Manager，缩写 SAMgr）中，SAMgr 负责管理这些 SA 并向 Client 提供相关的接口。Client 要和某个具体的 SA 通信，必须先从 SAMgr 中获取该 SA 的代理，然后使用代理和 SA 通信。下文直接使用 Proxy 表示服务请求方，Stub 表示服务提供方。
约束与限制
● 单个设备上跨进程通信时，传输的数据量最大约为 1MB，过大的数据量请使用匿名共享内存
● 不支持在 RPC 中订阅匿名 Stub 对象（没有向 SAMgr 注册 Stub 对象）的死亡通知。
● 不支持把跨设备的 Proxy 对象传递回该 Proxy 对象所指向的 Stub 对象所在的设备，即指向远端设备 Stub 的 Proxy 对象不能在本设备内进行二次跨进程传递。
使用建议
首先，需要编写接口类，接口类中必须定义消息码，供通信双方标识操作，可以有未实现的的方法，因为通信双方均需继承该接口类且双方不能是抽象类，所以此时定义的未实现的方法必须在双方继承时给出实现，这保证了继承双方不是抽象类。然后，需要编写 Stub 端相关类及其接口，并且实现 AsObject 方法及 OnRemoteRequest 方法。同时，也需要编写 Proxy 端，实现接口类中的方法和 AsObject 方法，也可以封装一些额外的方法用于调用 SendRequest 向对端发送数据。以上三者都具备后，便可以向 SAMgr 注册 SA 了，此时的注册应该在 Stub 所在进程完成。最后，在需要的地方从 SAMgr 中获取 Proxy，便可通过 Proxy 实现与 Stub 的跨进程通信了。
相关步骤：
● 实现接口类：需继承 IRemoteBroker，需定义消息码，可声明不在此类实现的方法。
● 实现服务提供端（Stub）：需继承 IRemoteStub 或者 RemoteObject，需重写 AsObject 方法及 OnRemoteRequest 方法。
● 实现服务请求端（Proxy）：需继承 IRemoteProxy 或 RemoteProxy，需重写 AsObject 方法，封装所需方法调用 SendRequest。
● 注册 SA：申请 SA 的唯一 ID，向 SAMgr 注册 SA。
● 获取 SA：通过 SA 的 ID 和设备 ID 获取 Proxy，使用 Proxy 与远端通信
二、 IPC 与 RPC 通信开发指导
场景介绍
IPC/RPC 的主要工作是让运行在不同进程的 Proxy 和 Stub 互相通信，包括 Proxy 和 Stub 运行在不同设备的情况。
接口说明
表 1 Native 侧 IPC 接口
开发步骤
Native 侧开发步骤
1. 添加依赖
SDK 依赖：
#ipc场景external_deps = [ "ipc:ipc_single",]
#rpc场景external_deps = [ "ipc:ipc_core",]
复制代码
此外， IPC/RPC 依赖的 refbase 实现在公共基础库下，请增加对 utils 的依赖：
external_deps = [ "c_utils:utils",]
复制代码
2.定义 IPC 接口 ITestAbility
SA 接口继承 IPC 基类接口 IRemoteBroker，接口里定义描述符、业务函数和消息码，其中业务函数在 Proxy 端和 Stub 端都需要实现。
#include "iremote_broker.h"
//定义消息码const int TRANS_ID_PING_ABILITY = 5
const std::string DESCRIPTOR = "test.ITestAbility";
class ITestAbility : public IRemoteBroker {public: // DECLARE_INTERFACE_DESCRIPTOR是必需的，入参需使用std::u16string； DECLARE_INTERFACE_DESCRIPTOR(to_utf16(DESCRIPTOR)); virtual int TestPingAbility(const std::u16string &dummy) = 0; // 定义业务函数};
复制代码
3.定义和实现服务端 TestAbilityStub
该类是和 IPC 框架相关的实现，需要继承 IRemoteStub<ITestAbility>。Stub 端作为接收请求的一端，需重写 OnRemoteRequest 方法用于接收客户端调用。
#include "iability_test.h"#include "iremote_stub.h"
class TestAbilityStub : public IRemoteStub<ITestAbility> {public: virtual int OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override; int TestPingAbility(const std::u16string &dummy) override; };
int TestAbilityStub::OnRemoteRequest(uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option){ switch (code) { case TRANS_ID_PING_ABILITY: { std::u16string dummy = data.ReadString16(); int result = TestPingAbility(dummy); reply.WriteInt32(result); return 0; } default: return IPCObjectStub::OnRemoteRequest(code, data, reply, option); }}
复制代码
4. 定义服务端业务函数具体实现类 TestAbility
#include "iability_server_test.h"
class TestAbility : public TestAbilityStub {public: int TestPingAbility(const std::u16string &dummy);}
int TestAbility::TestPingAbility(const std::u16string &dummy) { return 0;}
复制代码
5. 定义和实现客户端 TestAbilityProxy
该类是 Proxy 端实现，继承 IRemoteProxy<ITestAbility>，调用 SendRequest 接口向 Stub 端发送请求，对外暴露服务端提供的能力。
#include "iability_test.h"#include "iremote_proxy.h"#include "iremote_object.h"
class TestAbilityProxy : public IRemoteProxy<ITestAbility> {public: explicit TestAbilityProxy(const sptr<IRemoteObject> &impl); int TestPingAbility(const std::u16string &dummy) override;private: static inline BrokerDelegator<TestAbilityProxy> delegator_; // 方便后续使用iface_cast宏}
TestAbilityProxy::TestAbilityProxy(const sptr<IRemoteObject> &impl) : IRemoteProxy<ITestAbility>(impl){}
int TestAbilityProxy::TestPingAbility(const std::u16string &dummy){ MessageOption option; MessageParcel dataParcel, replyParcel; dataParcel.WriteString16(dummy); int error = Remote()->SendRequest(TRANS_ID_PING_ABILITY, dataParcel, replyParcel, option); int result = (error == ERR_NONE) ? replyParcel.ReadInt32() : -1; return result;}
复制代码
6. SA 注册与启动
SA 需要将自己的 TestAbilityStub 实例通过 AddSystemAbility 接口注册到 SystemAbilityManager，设备内与分布式的注册参数不同。
// 注册到本设备内auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();samgr->AddSystemAbility(saId, new TestAbility());
// 在组网场景下，会被同步到其他设备上auto samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();ISystemAbilityManager::SAExtraProp saExtra;saExtra.isDistributed = true; // 设置为分布式SAint result = samgr->AddSystemAbility(saId, new TestAbility(), saExtra);
复制代码
7. SA 获取与调用
通过 SystemAbilityManager 的 GetSystemAbility 方法可获取到对应 SA 的代理 IRemoteObject，然后构造 TestAbilityProxy 即可。
// 获取本设备内注册的SA的proxysptr<ISystemAbilityManager> samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();sptr<IRemoteObject> remoteObject = samgr->GetSystemAbility(saId);sptr<ITestAbility> testAbility = iface_cast<ITestAbility>(remoteObject); // 使用iface_cast宏转换成具体类型
// 获取其他设备注册的SA的proxysptr<ISystemAbilityManager> samgr = SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
// networkId是组网场景下对应设备的标识符，可以通过GetLocalNodeDeviceInfo获取sptr<IRemoteObject> remoteObject = samgr->GetSystemAbility(saId, networkId);sptr<TestAbilityProxy> proxy(new TestAbilityProxy(remoteObject)); // 直接构造具体Proxy
复制代码
JS 侧开发步骤
1. 添加依赖
import rpc from "@ohos.rpc"import featureAbility from "@ohos.ability.featureAbility"
复制代码
2.绑定 Ability
首先，构造变量 want，指定要绑定的 Ability 所在应用的包名、组件名，如果是跨设备的场景，还需要绑定目标设备 NetworkId（组网场景下对应设备的标识符，可以使用 deviceManager 获取目标设备的 NetworkId）；然后，构造变量 connect，指定绑定成功、绑定失败、断开连接时的回调函数；最后，使用 featureAbility 提供的接口绑定 Ability。
import rpc from "@ohos.rpc"import featureAbility from "@ohos.ability.featureAbility"
let proxy = nulllet connectId = null
// 单个设备绑定Abilitylet want = { // 包名和组件名写实际的值 "bundleName": "ohos.rpc.test.server", "abilityName": "ohos.rpc.test.server.ServiceAbility",}let connect = { onConnect:function(elementName, remote) { proxy = remote }, onDisconnect:function(elementName) { }, onFailed:function() { proxy = null }}connectId = featureAbility.connectAbility(want, connect)
// 如果是跨设备绑定，可以使用deviceManager获取目标设备NetworkIdimport deviceManager from '@ohos.distributedHardware.deviceManager'function deviceManagerCallback(deviceManager) { let deviceList = deviceManager.getTrustedDeviceListSync() let networkId = deviceList[0].networkId let want = { "bundleName": "ohos.rpc.test.server", "abilityName": "ohos.rpc.test.service.ServiceAbility", "networkId": networkId, "flags": 256 } connectId = featureAbility.connectAbility(want, connect)}// 第一个参数是本应用的包名，第二个参数是接收deviceManager的回调函数deviceManager.createDeviceManager("ohos.rpc.test", deviceManagerCallback)
复制代码
3.服务端处理客户端请求
服务端被绑定的 Ability 在 onConnect 方法里返回继承自 rpc.RemoteObject 的对象，该对象需要实现 onRemoteMessageRequest 方法，处理客户端的请求。
onConnect(want: Want) { var robj:rpc.RemoteObject = new Stub("rpcTestAbility") return robj}class Stub extends rpc.RemoteObject { constructor(descriptor) { super(descriptor) } onRemoteMessageRequest(code, data, reply, option) { // 根据code处理客户端的请求 return true }}
复制代码
4.客户端处理服务端响应
客户端在 onConnect 回调里接收到代理对象，调用 sendRequestAsync 方法发起请求，在期约（JavaScript 期约：用于表示一个异步操作的最终完成或失败及其结果值）或者回调函数里接收结果。
// 使用期约let option = new rpc.MessageOption()let data = rpc.MessageParcel.create()let reply = rpc.MessageParcel.create()// 往data里写入参数proxy.sendRequestAsync(1, data, reply, option) .then(function(result) { if (result.errCode != 0) { console.error("send request failed, errCode: " + result.errCode) return } // 从result.reply里读取结果 }) .catch(function(e) { console.error("send request got exception: " + e) } .finally(() => { data.reclaim() reply.reclaim() })
// 使用回调函数function sendRequestCallback(result) { try { if (result.errCode != 0) { console.error("send request failed, errCode: " + result.errCode) return } // 从result.reply里读取结果 } finally { result.data.reclaim() result.reply.reclaim() }}let option = new rpc.MessageOption()let data = rpc.MessageParcel.create()let reply = rpc.MessageParcel.create()// 往data里写入参数proxy.sendRequest(1, data, reply, option, sendRequestCallback)
复制代码
5.断开连接
IPC 通信结束后，使用 featureAbility 的接口断开连接。
import rpc from "@ohos.rpc"import featureAbility from "@ohos.ability.featureAbility"function disconnectCallback() { console.info("disconnect ability done")}featureAbility.disconnectAbility(connectId, disconnectCallback)
复制代码
评论