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