1# NetConnection开发指导 2 3## 场景介绍 4 5NetConnection模块提供了常用网络信息查询的能力。 6 7## 接口说明 8 9NetConnection常用接口如下表所示，详细的接口说明请参考[NetConnection](../reference/apis-network-kit/_net_connection.md) 10 11 12| 接口名 | 描述 | 13| -------- | -------- | 14| OH_NetConn_HasDefaultNet(int32_t \*hasDefaultNet) | 检查默认数据网络是否被激活，判断设备是否有网络连接，以便在应用程序中采取相应的措施。 | 15| OH_NetConn_GetDefaultNet(NetConn_NetHandle \*netHandle) | 获得默认激活的数据网络。 | 16| OH_NetConn_IsDefaultNetMetered(int32_t \*isMetered) | 检查当前网络上的数据流量使用是否被计量 | 17| OH_NetConn_GetConnectionProperties(NetConn_NetHandle \*netHandle, NetConn_ConnectionProperties *prop) | 获取netHandle对应的网络的连接信息。 | 18| OH_NetConn_GetNetCapabilities (NetConn_NetHandle \*netHandle, NetConn_NetCapabilities \*netCapacities) | 获取netHandle对应的网络的能力信息。 | 19| OH_NetConn_GetDefaultHttpProxy (NetConn_HttpProxy \*httpProxy) | 获取网络默认的代理配置信息。 如果设置了全局代理，则会返回全局代理配置信息。如果进程已经绑定到指定netHandle对应的网络，则返回网络句柄对应网络的代理配置信息。在其它情况下，将返回默认网络的代理配置信息。 | 20| OH_NetConn_GetAddrInfo (char \*host, char \*serv, struct addrinfo \*hint, struct addrinfo \*\*res, int32_t netId) | 通过netId获取DNS结果。 | 21| OH_NetConn_FreeDnsResult(struct addrinfo \*res) | 释放DNS结果内存。 | 22| OH_NetConn_GetAllNets(NetConn_NetHandleList \*netHandleList) | 获取所有处于连接状态的网络列表。 | 23| OHOS_NetConn_RegisterDnsResolver(OH_NetConn_CustomDnsResolver resolver) | 注册自定义dns解析器。<br/>**弃用：** 从API version 13开始废弃。<br/>**替代：** 推荐使用OH_NetConn_RegisterDnsResolver。| 24| OHOS_NetConn_UnregisterDnsResolver(void) | 去注册自定义dns解析器。<br/>**弃用：** 从API version 13开始废弃。<br/>**替代：** 推荐使用OH_NetConn_UnregisterDnsResolver。| 25| OH_NetConn_BindSocket(int32_t socketFd, NetConn_NetHandle \*netHandle) | 将套接字与指定的网络进行绑定。 | 26| OH_NetConn_RegisterDnsResolver(OH_NetConn_CustomDnsResolver resolver) | 注册自定义dns解析器。 | 27| OH_NetConn_UnregisterDnsResolver(void) | 去注册自定义dns解析器。 | 28| OH_NetConn_SetPacUrl(const char \*pacUrl) | 设置系统级代理自动配置(PAC)脚本地址。 | 29| OH_NetConn_GetPacUrl(char \*pacUrl) | 获取系统级代理自动配置(PAC)脚本地址。 | 30 31## 网络管理接口开发示例 32 33### 开发步骤 34 35使用本文档涉及接口获取网络相关信息时，需先创建Native C++工程，在源文件中将相关接口封装，再在ArkTS层对封装的接口进行调用，使用hilog或者console.log等手段选择打印在控制台或者生成设备日志。 36 37本文以实现获取默认激活的数据网络为例，给出具体的开发指导。 38 39### 添加开发依赖 40 41**添加动态链接库** 42 43CMakeLists.txt中添加以下lib: 44 45```txt 46libace_napi.z.so 47libnet_connection.so 48``` 49 50**头文件** 51 52```c 53#include "napi/native_api.h" 54#include "network/netmanager/net_connection.h" 55#include "network/netmanager/net_connection_type.h" 56``` 57 58### 构建工程 59 601、在源文件中编写调用该API的代码，并将结果封装成一个`napi_value`类型的值返回给 Node.js 环境。 61 62```C 63// Get the execution results of the default network connection. 64static napi_value GetDefaultNet(napi_env env, napi_callback_info info) 65{ 66 size_t argc = 1; 67 napi_value args[1] = {nullptr}; 68 napi_get_cb_info(env, info, &argc, args, nullptr, nullptr); 69 int32_t param; 70 napi_get_value_int32(env, args[0], ¶m); 71 72 NetConn_NetHandle netHandle; 73 if (param== 0) { 74 param= OH_NetConn_GetDefaultNet(NULL); 75 } else { 76 param= OH_NetConn_GetDefaultNet(&netHandle); 77 } 78 79 napi_value result; 80 napi_create_int32(env, param, &result); 81 return result; 82} 83 84// Get the ID of the default network connection. 85static napi_value NetId(napi_env env, napi_callback_info info) { 86 int32_t defaultNetId; 87 88 NetConn_NetHandle netHandle; 89 OH_NetConn_GetDefaultNet(&netHandle); 90 defaultNetId = netHandle.netId; // Get the default netId 91 92 napi_value result; 93 napi_create_int32(env, defaultNetId, &result); 94 95 return result; 96} 97``` 98 99简要说明：这两个函数是用于获取系统默认网络连接的相关信息的。其中，GetDefaultNet是接收ArkTS端传入的测试参数，返回调用接口后对应的返回值，param可以自行调整；如果返回值为0，代表获取成功，401代表参数错误，201代表没有权限；而NetId函数则用于获取默认网络连接的ID。这些信息可以用于进一步的网络操作。 100 101 1022、将通过napi封装好的`napi_value`类型对象初始化导出，通过外部函数接口，将以上两个函数暴露给JavaScript使用。 103 104```C 105EXTERN_C_START 106static napi_value Init(napi_env env, napi_value exports) 107{ 108 // Information used to describe an exported attribute. Two properties are defined here: `GetDefaultNet` and `NetId`. 109 napi_property_descriptor desc[] = { 110 {"GetDefaultNet", nullptr, GetDefaultNet, nullptr, nullptr, nullptr, napi_default, nullptr}, 111 {"NetId", nullptr, NetId, nullptr, nullptr, nullptr, napi_default, nullptr}}; 112 napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 113 return exports; 114} 115EXTERN_C_END 116``` 117 1183、将上一步中初始化成功的对象通过`RegisterEntryModule`函数，使用`napi_module_register`函数将模块注册到 Node.js 中。 119 120```C 121static napi_module demoModule = { 122 .nm_version = 1, 123 .nm_flags = 0, 124 .nm_filename = nullptr, 125 .nm_register_func = Init, 126 .nm_modname = "entry", 127 .nm_priv = ((void*)0), 128 .reserved = { 0 }, 129}; 130 131extern "C" __attribute__((constructor)) void RegisterEntryModule(void) 132{ 133 napi_module_register(&demoModule); 134} 135``` 136 1374、在工程的index.d.ts文件中定义两个函数的类型。 138 139- GetDefaultNet 函数接受一个数字参数 code，返回一个数字类型的值。 140- NetId 函数不接受参数，返回一个数字类型的值。 141 142```ts 143export const GetDefaultNet: (code: number) => number; 144export const NetId: () => number; 145``` 146 1475、在index.ets文件中对上述封装好的接口进行调用 148 149```ts 150import testNetManager from 'libentry.so'; 151 152@Entry 153@Component 154struct Index { 155 @State message: string = ''; 156 157 build() { 158 Row() { 159 Column() { 160 Text(this.message) 161 .fontSize(50) 162 .fontWeight(FontWeight.Bold) 163 Button('GetDefaultNet').onClick(event => { 164 this.GetDefaultNet(); 165 }) 166 Button('CodeNumber').onClick(event =>{ 167 this.CodeNumber(); 168 }) 169 } 170 .width('100%') 171 } 172 .height('100%') 173 } 174 175 GetDefaultNet() { 176 let netid = testNetManager.NetId(); 177 console.log("The defaultNetId is [" + netid + "]"); 178 } 179 180 CodeNumber() { 181 let testParam = 0; 182 let codeNumber = testNetManager.GetDefaultNet(testParam); 183 if (codeNumber === 0) { 184 console.log("Test success. [" + codeNumber + "]"); 185 } else if (codeNumber === 201) { 186 console.log("Missing permissions. [" + codeNumber + "]"); 187 } else if (codeNumber === 401) { 188 console.log("Parameter error. [" + codeNumber + "]"); 189 } 190 } 191} 192 193``` 194 1956、配置`CMakeLists.txt`，本模块需要用到的共享库是`libnet_connection.so`，在工程自动生成的`CMakeLists.txt`中的`target_link_libraries`中添加此共享库。 196 197注意：如图所示，在`add_library`中的`entry`是工程自动生成的`modename`，若要做修改，需和步骤3中`.nm_modname`保持一致； 198 199 200 201经过以上步骤，整个工程的搭建已经完成，接下来就可以连接设备运行工程进行日志查看了。 202 203## 测试步骤 204 2051、连接设备，使用DevEco Studio打开搭建好的工程 206 2072、运行工程，设备上会弹出以下所示图片： 208 209简要说明： 210 211- 在点击 `GetDefaultNet` 时，获取的是默认网络ID。 212- 在点击 `codeNumber` 时，获取的是接口返回的响应状态码。 213 214 215 2163、点击 `GetDefaultNet` 按钮，控制台会打印日志： 217 218 219 2204、点击 `codeNumber` 按钮，控制台会打印相应的响应状态码： 221 222 223
