1# Native子进程开发指导（C/C++） 2 3本模块提供了两种创建子进程的方式，开发者可根据需要进行选择。 4- [创建支持IPC回调的子进程](#创建支持ipc回调的子进程)：创建子进程，并在父子进程间建立IPC通道，适用于父子进程需要IPC通信的场景。对[IPCKit](../ipc/ipc-capi-development-guideline.md)存在依赖。 5- [创建支持参数传递的子进程](#创建支持参数传递的子进程)：创建子进程，并传递字符串和fd句柄参数到子进程。适用于需要传递参数到子进程的场景。 6 7 8## 创建支持IPC回调的子进程 9 10### 场景介绍 11 12本章节介绍如何在主进程中创建Native子进程，并在父子进程间建立IPC通道，方便开发者在Native层进行多进程编程。 13 14### 接口说明 15 16| 名称 | 描述 | 17| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | 18| int [OH_Ability_CreateNativeChildProcess](../reference/apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_createnativechildprocess) (const char *libName, [OH_Ability_OnNativeChildProcessStarted](../reference/apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_onnativechildprocessstarted) onProcessStarted) | 创建子进程并加载参数中指定的动态链接库文件，进程启动结果通过回调参数异步通知，需注意回调通知为独立线程，回调函数实现需要注意线程同步，且不能执行高耗时操作避免长时间阻塞。 | 19 20> **说明：** 21> 22> 当前仅支持2in1设备，且单个进程只能启动一个Native子进程。 23 24### 开发步骤 25 26基于已创建完成的Native应用开发工程，在此基础上介绍如何使用`AbilityKit`提供的C API接口，创建Native子进程，并同时在父子进程间建立IPC通道。 27 28**动态库文件** 29 30```txt 31libipc_capi.so 32libchild_process.so 33``` 34 35**头文件** 36 37```c++ 38#include <IPCKit/ipc_kit.h> 39#include <AbilityKit/native_child_process.h> 40``` 41 421. 子进程-实现必要的导出方法。 43 44 在子进程中，实现必要的两个函数**NativeChildProcess_OnConnect**及**NativeChildProcess_MainProc**并导出（假设代码所在的文件名为ChildProcessSample.cpp）。其中NativeChildProcess_OnConnect方法返回的OHIPCRemoteStub对象负责主进程进行IPC通信，具体实现方法请参考[IPC通信开发指导（C/C++)](../ipc/ipc-capi-development-guideline.md)，本文不再赘述。 45 46 子进程启动后会先调用NativeChildProcess_OnConnect获取IPC Stub对象，之后再调用NativeChildProcess_MainProc移交主线程控制权，该函数返回后子进程随即退出。 47 48 ```c++ 49 #include <IPCKit/ipc_kit.h> 50 51 extern "C" { 52 53 OHIPCRemoteStub* NativeChildProcess_OnConnect() 54 { 55 // ipcRemoteStub指向子进程实现的ipc stub对象，用于接收来自主进程的IPC消息并响应 56 // 子进程根据业务逻辑控制其生命周期 57 return ipcRemoteStub; 58 } 59 60 void NativeChildProcess_MainProc() 61 { 62 // 相当于子进程的Main函数，实现子进程的业务逻辑 63 // ... 64 // 函数返回后子进程随即退出 65 } 66 67 } // extern "C" 68 ``` 69 702. 子进程-编译为动态链接库。 71 72 修改CMakeList.txt文件，编译为动态链接库（假设需要编译出的库文件名称为libchildprocesssample.so），并添加IPC动态库依赖。 73 74 ```txt 75 add_library(childprocesssample SHARED 76 # 实现必要导出方法的源文件 77 ChildProcessSample.cpp 78 79 # 其它代码源文件 80 # ... 81 ) 82 83 target_link_libraries(childprocesssample PUBLIC 84 # 添加依赖的IPC动态库 85 libipc_capi.so 86 87 # 其它所依赖的动态库 88 # ... 89 ) 90 ``` 91 923. 主进程-实现子进程启动结果回调函数。 93 94 ```c++ 95 #include <IPCKit/ipc_kit.h> 96 97 static void OnNativeChildProcessStarted(int errCode, OHIPCRemoteProxy *remoteProxy) 98 { 99 if (errCode != NCP_NO_ERROR) { 100 // 子进程未能正常启动时的异常处理 101 // ... 102 return; 103 } 104 105 // 保存remoteProxy对象，后续基于IPC Kit提供的API同子进程间进行IPC通信 106 // 耗时操作建议转移到独立线程去处理，避免长时间阻塞回调线程 107 // IPC对象使用完毕后，需要调用OH_IPCRemoteProxy_Destroy方法释放 108 // ... 109 } 110 ``` 111 112 回调函数传递的第二个参数OHIPCRemoteProxy对象，会与子进程实现的**NativeChildProcess_OnConnect**方法返回的OHIPCRemoteStub对象间建立IPC通道，具体使用方法参考[IPC通信开发指导（C/C++)](../ipc/ipc-capi-development-guideline.md)，本文不再赘述；OHIPCRemoteProxy对象使用完毕后，需要调用[OH_IPCRemoteProxy_Destroy](../reference/apis-ipc-kit/_o_h_i_p_c_remote_object.md#oh_ipcremoteproxy_destroy)函数释放。 113 1144. 主进程-启动Native子进程。 115 116 调用API启动Native子进程，需要注意返回值为NCP_NO_ERROR仅代表成功调用native子进程启动逻辑，实际的启动结果通过第二个参数中指定的回调函数异步通知。需注意**仅允许在主进程中创建子进程**。 117 118 ```c++ 119 #include <AbilityKit/native_child_process.h> 120 121 // 第一个参数"libchildprocesssample.so"为实现了子进程必要导出方法的动态库文件名称 122 int32_t ret = OH_Ability_CreateNativeChildProcess("libchildprocesssample.so", OnNativeChildProcessStarted); 123 if (ret != NCP_NO_ERROR) { 124 // 子进程未能正常启动时的异常处理 125 // ... 126 } 127 ``` 128 1295. 主进程-添加编译依赖项。 130 131 修改CMaklist.txt添加必要的依赖库，假设主进程所在的so名称为libmainprocesssample.so（主进程和子进程的实现也可以选择编译到同一个动态库文件）。 132 133 ```txt 134 target_link_libraries(mainprocesssample PUBLIC 135 # 添加依赖的IPC及元能力动态库 136 libipc_capi.so 137 libchild_process.so 138 139 # 其它依赖的动态库 140 # ... 141 ) 142 ``` 143 144## 创建支持参数传递的子进程 145 146### 场景介绍 147 148本章节介绍如何创建Native子进程，并传递参数到子进程。 149 150### 接口说明 151 152| 名称 | 描述 | 153| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | 154| [Ability_NativeChildProcess_ErrCode](../reference/apis-ability-kit/c-apis-ability-childprocess.md#ability_nativechildprocess_errcode) [OH_Ability_StartNativeChildProcess](../reference/apis-ability-kit/c-apis-ability-childprocess.md#oh_ability_startnativechildprocess) (const char \*entry, [NativeChildProcess_Args](../reference/apis-ability-kit/c-apis-ability-childprocess.md#nativechildprocess_args) args, [NativeChildProcess_Options](../reference/apis-ability-kit/c-apis-ability-childprocess.md#nativechildprocess_options) options, int32_t *pid) | 启动子进程并返回子进程pid。 | 155 156### 开发步骤 157 158 159**动态库文件** 160 161```txt 162libchild_process.so 163``` 164 165**头文件** 166 167```c++ 168#include <AbilityKit/native_child_process.h> 169``` 170 1711. 子进程-实现必要的导出方法。 172 173 在子进程中，实现参数为[NativeChildProcess_Args](../reference/apis-ability-kit/c-apis-ability-childprocess.md#nativechildprocess_args)入口函数并导出（假设代码所在的文件名为ChildProcessSample.cpp）。子进程启动后会调用该入口函数，该函数返回后子进程随即退出。 174 175 ```c++ 176 #include <AbilityKit/native_child_process.h> 177 178 extern "C" { 179 180 /** 181 * 子进程的入口函数，实现子进程的业务逻辑 182 * 函数名称可以自定义，在主进程调用OH_Ability_StartNativeChildProcess方法时指定，此示例中为Main 183 * 函数返回后子进程退出 184 */ 185 void Main(NativeChildProcess_Args args) 186 { 187 // 获取传入的entryPrams 188 char *entryParams = args.entryParams; 189 // 获取传入的fd列表 190 NativeChildProcess_Fd *current = args.fdList.head; 191 while (current != nullptr) { 192 char *fdName = current->fdName; 193 int32_t fd = current->fd; 194 current = current->next; 195 // 业务逻辑.. 196 } 197 } 198 } // extern "C" 199 ``` 200 2012. 子进程-编译为动态链接库。 202 203 修改CMakeList.txt文件，编译为动态链接库（假设需要编译出的库文件名称为libchildprocesssample.so），并添加元能力动态库依赖。 204 205 ```txt 206 add_library(childprocesssample SHARED 207 # 实现必要导出方法的源文件 208 ChildProcessSample.cpp 209 210 # 其它代码源文件 211 # ... 212 ) 213 214 target_link_libraries(childprocesssample PUBLIC 215 # 添加依赖的元能力动态库 216 libchild_process.so 217 218 # 其它所依赖的动态库 219 # ... 220 ) 221 ``` 222 2233. 主进程-启动Native子进程。 224 225 调用API启动Native子进程，返回值为NCP_NO_ERROR代表成功启动native子进程。 226 227 ```c++ 228 #include <AbilityKit/native_child_process.h> 229 #include <stdlib.h> 230 #include <string.h> 231 #include <fcntl.h> 232 233 void startNativeChildProcess() 234 { 235 // ... 236 NativeChildProcess_Args args; 237 // 设置entryParams，支持传输的最大数据量为150KB 238 args.entryParams = (char*)malloc(sizeof(char) * 10); 239 (void)strcpy(args.entryParams, "testParam"); 240 241 // 插入节点到链表头节点中 242 args.fdList.head = (NativeChildProcess_Fd*)malloc(sizeof(NativeChildProcess_Fd)); 243 // fd关键字，最多不超过20个字符 244 args.fdList.head->fdName = (char*)malloc(sizeof(char) * 4); 245 (void)strcpy(args.fdList.head->fdName, "fd1"); 246 // 获取fd逻辑 247 int32_t fd = open("/data/storage/el2/base/haps/entry/files/test.txt", O_RDWR | O_CREAT, 0644); 248 args.fdList.head->fd = fd; 249 // 此处只插入一个fd记录，根据需求可以插入更多fd记录到链表中，最多不超过16个 250 args.fdList.head->next = NULL; 251 NativeChildProcess_Options options = { 252 .isolationMode = NCP_ISOLATION_MODE_ISOLATED 253 }; 254 255 // 第一个参数"libchildprocesssample.so:Main"为实现了子进程Main方法的动态库文件名称和入口方法名 256 int32_t pid = -1; 257 Ability_NativeChildProcess_ErrCode ret = OH_Ability_StartNativeChildProcess( 258 "libchildprocesssample.so:Main", args, options, &pid); 259 if (ret != NCP_NO_ERROR) { 260 // 释放NativeChildProcess_Args中的内存空间防止内存泄漏 261 // 子进程未能正常启动时的异常处理 262 // ... 263 } 264 265 // 其他逻辑 266 // ... 267 268 // 释放NativeChildProcess_Args中的内存空间防止内存泄漏 269 } 270 ``` 271 2724. 主进程-添加编译依赖项。 273 274 修改CMaklist.txt添加必要的依赖库，假设主进程所在的so名称为libmainprocesssample.so（主进程和子进程的实现也可以选择编译到同一个动态库文件）。 275 276 ```txt 277 target_link_libraries(mainprocesssample PUBLIC 278 # 添加依赖的元能力动态库 279 libchild_process.so 280 281 # 其它依赖的动态库 282 # ... 283 ) 284 ``` 285