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_RegisterDnsResolver(OH_NetConn_CustomDnsResolver resolver) | 注册自定义dns解析器。 | 26| OH_NetConn_UnregisterDnsResolver(void) | 去注册自定义dns解析器。| 27| OH_NetConn_SetPacUrl(const char \*pacUrl) | 设置系统级代理自动配置(PAC)脚本地址。 | 28| OH_NetConn_GetPacUrl(char \*pacUrl) | 获取系统级代理自动配置(PAC)脚本地址。 | 29 30## 网络管理接口开发示例 31 32### 开发步骤 33 34使用本文档涉及接口获取网络相关信息时，需先创建Native C++工程，在源文件中将相关接口封装，再在ArkTs层对封装的接口进行调用，使用hilog或者console.log等手段选择打印在控制台或者生成设备日志。 35 36本文以实现获取默认激活的数据网络为例，给出具体的开发指导。 37 38### 添加开发依赖 39 40**添加动态链接库** 41 42CMakeLists.txt中添加以下lib: 43 44```txt 45libace_napi.z.so 46libnet_connection.so 47``` 48 49**头文件** 50 51```c 52#include "napi/native_api.h" 53#include "network/netmanager/net_connection.h" 54#include "network/netmanager/net_connection_type.h" 55``` 56 57### 构建工程 58 591、在源文件中编写调用该API的代码，并将结果封装成一个`napi_value`类型的值返回给 Node.js 环境。 60 61```C 62// Get the execution results of the default network connection. 63static napi_value GetDefaultNet(napi_env env, napi_callback_info info) 64{ 65 size_t argc = 1; 66 napi_value args[1] = {nullptr}; 67 napi_get_cb_info(env, info, &argc, args, nullptr, nullptr); 68 int32_t param; 69 napi_get_value_int32(env, args[0], ¶m); 70 71 NetConn_NetHandle netHandle; 72 if (param== 0) { 73 param= OH_NetConn_GetDefaultNet(NULL); 74 } else { 75 param= OH_NetConn_GetDefaultNet(&netHandle); 76 } 77 78 napi_value result; 79 napi_create_int32(env, param, &result); 80 return result; 81} 82 83// Get the ID of the default network connection. 84static napi_value NetId(napi_env env, napi_callback_info info) { 85 int32_t defaultNetId; 86 87 NetConn_NetHandle netHandle; 88 OH_NetConn_GetDefaultNet(&netHandle); 89 defaultNetId = netHandle.netId; // Get the default netId 90 91 napi_value result; 92 napi_create_int32(env, defaultNetId, &result); 93 94 return result; 95} 96``` 97 98简要说明：这两个函数是用于获取系统默认网络连接的相关信息的。其中，GetDefaultNet是接收ArkTs端传入的测试参数，返回调用接口后对应的返回值，param可以自行调整；如果返回值为0，代表获取成功，401代表参数错误，201代表没有权限；而NetId函数则用于获取默认网络连接的ID。这些信息可以用于进一步的网络操作。 99 100 1012、将通过napi封装好的`napi_value`类型对象初始化导出，通过外部函数接口，将以上两个函数暴露给JavaScript使用。 102 103```C 104EXTERN_C_START 105static napi_value Init(napi_env env, napi_value exports) 106{ 107 // Information used to describe an exported attribute. Two properties are defined here: `GetDefaultNet` and `NetId`. 108 napi_property_descriptor desc[] = { 109 {"GetDefaultNet", nullptr, GetDefaultNet, nullptr, nullptr, nullptr, napi_default, nullptr}, 110 {"NetId", nullptr, NetId, nullptr, nullptr, nullptr, napi_default, nullptr}}; 111 napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 112 return exports; 113} 114EXTERN_C_END 115``` 116 1173、将上一步中初始化成功的对象通过`RegisterEntryModule`函数，使用`napi_module_register`函数将模块注册到 Node.js 中。 118 119```C 120static napi_module demoModule = { 121 .nm_version = 1, 122 .nm_flags = 0, 123 .nm_filename = nullptr, 124 .nm_register_func = Init, 125 .nm_modname = "entry", 126 .nm_priv = ((void*)0), 127 .reserved = { 0 }, 128}; 129 130extern "C" __attribute__((constructor)) void RegisterEntryModule(void) 131{ 132 napi_module_register(&demoModule); 133} 134``` 135 1364、在工程的index.d.ts文件中定义两个函数的类型。 137 138- GetDefaultNet 函数接受一个数字参数 code，返回一个数字类型的值。 139- NetId 函数不接受参数，返回一个数字类型的值。 140 141```ts 142export const GetDefaultNet: (code: number) => number; 143export const NetId: () => number; 144``` 145 1465、在index.ets文件中对上述封装好的接口进行调用。 147 148```ts 149import testNetManager from 'libentry.so'; 150 151@Entry 152@Component 153struct Index { 154 @State message: string = ''; 155 156 build() { 157 Row() { 158 Column() { 159 Text(this.message) 160 .fontSize(50) 161 .fontWeight(FontWeight.Bold) 162 Button('GetDefaultNet').onClick(event => { 163 this.GetDefaultNet(); 164 }) 165 Button('CodeNumber').onClick(event =>{ 166 this.CodeNumber(); 167 }) 168 } 169 .width('100%') 170 } 171 .height('100%') 172 } 173 174 GetDefaultNet() { 175 let netid = testNetManager.NetId(); 176 console.log("The defaultNetId is [" + netid + "]"); 177 } 178 179 CodeNumber() { 180 let testParam = 0; 181 let codeNumber = testNetManager.GetDefaultNet(testParam); 182 if (codeNumber === 0) { 183 console.log("Test success. [" + codeNumber + "]"); 184 } else if (codeNumber === 201) { 185 console.log("Missing permissions. [" + codeNumber + "]"); 186 } else if (codeNumber === 401) { 187 console.log("Parameter error. [" + codeNumber + "]"); 188 } 189 } 190} 191 192``` 193 1946、配置`CMakeLists.txt`，本模块需要用到的共享库是`libnet_connection.so`，在工程自动生成的`CMakeLists.txt`中的`target_link_libraries`中添加此共享库。 195 196注意：如图所示，在`add_library`中的`entry`是工程自动生成的`modename`，若要做修改，需和步骤3中`.nm_modname`保持一致； 197 198 199 200经过以上步骤，整个工程的搭建已经完成，接下来就可以连接设备运行工程进行日志查看了。 201 202## 测试步骤 203 2041、连接设备，使用DevEco Studio打开搭建好的工程。 205 2062、运行工程，设备上会弹出以下所示图片： 207 208简要说明： 209 210- 在点击 `GetDefaultNet` 时，获取的是默认网络ID。 211- 在点击 `codeNumber` 时，获取的是接口返回的响应状态码。 212 213 214 2153、点击 `GetDefaultNet` 按钮，控制台会打印日志： 216 217 218 2194、点击 `codeNumber` 按钮，控制台会打印相应的响应状态码： 220 221
