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