Harmony学习 -- 网络管理

一、网络管理开发概述

官网地址
HarmonyOS网络管理模块主要提供以下功能：

• ​​HTTP数据请求​​：通过HTTP发起一个数据请求。
• ​​WebSocket连接​​：使用WebSocket建立服务器与客户端的双向连接。
• ​​Socket连接​​：通过Socket进行数据传输。

二、 约束与限制

使用网络管理模块的相关功能时，需要请求相应的权限。

权限名	说明
ohos.permission.GET_NETWORK_INFO	获取网络连接信息。
ohos.permission.SET_NETWORK_INFO	修改网络连接状态。
ohos.permission.INTERNET	允许程序打开网络套接字，进行网络连接。

三、HTTP数据请求

1. 场景介绍

应用通过HTTP发起一个数据请求，支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。

2. 接口说明

HTTP数据请求功能主要由http模块提供。
使用该功能需要申请ohos.permission.INTERNET权限。
权限申请请参考访问控制（权限）开发指导。
涉及的接口如下表，具体的接口说明请参考API文档。

接口名	功能描述
createHttp()	创建一个http请求。
request()	根据URL地址，发起HTTP网络请求。
destroy()	中断请求任务。
on(type: ‘headersReceive’)	订阅HTTP Response Header 事件。
off(type: ‘headersReceive’)	取消订阅HTTP Response Header 事件。
once(‘headersReceive’)8+	订阅HTTP Response Header 事件，但是只触发一次。

3. request接口开发步骤

1. 从@ohos.net.http.d.ts中导入http命名空间。
2. 调用createHttp()方法，创建一个HttpRequest对象。
3. 调用该对象的on()方法，订阅http响应头事件，此接口会比request请求先返回。可以根据业务4. 需要订阅此消息。
4. 调用该对象的request()方法，传入http请求的url地址和可选参数，发起网络请求。
5. 按照实际业务需要，解析返回结果。
6. 调用该对象的off()方法，取消订阅http响应头事件。
7. 当该请求使用完毕时，调用destroy()方法主动销毁。

// 引入包名
import http from '@ohos.net.http';

// 每一个httpRequest对应一个HTTP请求任务，不可复用
let httpRequest = http.createHttp();
// 用于订阅HTTP响应头，此接口会比request请求先返回。可以根据业务需要订阅此消息
// 从API 8开始，使用on('headersReceive', Callback)替代on('headerReceive', AsyncCallback)。 8+
httpRequest.on('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // 填写HTTP请求的URL地址，可以带参数也可以不带参数。URL地址需要开发者自定义。请求的参数可以在extraData中指定
    "EXAMPLE_URL",
    {
        method: http.RequestMethod.POST, // 可选，默认为http.RequestMethod.GET
        // 开发者根据自身业务需要添加header字段
        header: {
            'Content-Type': 'application/json'
        },
        // 当使用POST请求时此字段用于传递内容
        extraData: {
            "data": "data to send",
        },
        expectDataType: http.HttpDataType.STRING, // 可选，指定返回数据的类型
        usingCache: true, // 可选，默认为true
        priority: 1, // 可选，默认为1
        connectTimeout: 60000, // 可选，默认为60000ms
        readTimeout: 60000, // 可选，默认为60000ms
        usingProtocol: http.HttpProtocol.HTTP1_1, // 可选，协议类型默认值由系统自动指定
    }, (err, data) => {
        if (!err) {
            // data.result为HTTP响应内容，可根据业务需要进行解析
            console.info('Result:' + JSON.stringify(data.result));
            console.info('code:' + JSON.stringify(data.responseCode));
            // data.header为HTTP响应头，可根据业务需要进行解析
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + JSON.stringify(data.cookies)); // 8+
        } else {
            console.info('error:' + JSON.stringify(err));
            // 取消订阅HTTP响应头事件
            httpRequest.off('headersReceive');
            // 当该请求使用完毕时，调用destroy方法主动销毁
            httpRequest.destroy();
        }
    }
);

四、WebSocket连接

使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。

1. 接口说明

接口名	功能描述
createWebSocket()	创建一个WebSocket连接。
connect()	根据URL地址，建立一个WebSocket连接。
send()	通过WebSocket连接发送数据。
close()	关闭WebSocket连接。
on(type: ‘open’)	订阅WebSocket的打开事件。
off(type: ‘open’)	取消订阅WebSocket的打开事件。
on(type: ‘message’)	订阅WebSocket的接收到服务器消息事件。
off(type: ‘message’)	取消订阅WebSocket的接收到服务器消息事件。
on(type: ‘close’)	订阅WebSocket的关闭事件。
off(type: ‘close’)	取消订阅WebSocket的关闭事件
on(type: ‘error’)	订阅WebSocket的Error事件。
off(type: ‘error’)	取消订阅WebSocket的Error事件。

2. 开发步骤

1. 导入需要的webSocket模块。
2. 创建一个WebSocket连接，返回一个WebSocket对象。
3. （可选）订阅WebSocket的打开、消息接收、关闭、Error事件。
4. 根据URL地址，发起WebSocket连接。
5. 使用完WebSocket连接之后，主动断开连接。

import webSocket from '@ohos.net.webSocket';

var defaultIpAddress = "ws://";
let ws = webSocket.createWebSocket();
ws.on('open', (err, value) => {
    console.log("on open, status:" + JSON.stringify(value));
    // 当收到on('open')事件时，可以通过send()方法与服务器进行通信
    ws.send("Hello, server!", (err, value) => {
        if (!err) {
            console.log("Message sent successfully");
        } else {
            console.log("Failed to send the message. Err:" + JSON.stringify(err));
        }
    });
});
ws.on('message', (err, value) => {
    console.log("on message, message:" + value);
    // 当收到服务器的`bye`消息时（此消息字段仅为示意，具体字段需要与服务器协商），主动断开连接
    if (value === 'bye') {
        ws.close((err, value) => {
            if (!err) {
                console.log("Connection closed successfully");
            } else {
                console.log("Failed to close the connection. Err: " + JSON.stringify(err));
            }
        });
    }
});
ws.on('close', (err, value) => {
    console.log("on close, code is " + value.code + ", reason is " + value.reason);
});
ws.on('error', (err) => {
    console.log("on error, error:" + JSON.stringify(err));
});
ws.connect(defaultIpAddress, (err, value) => {
    if (!err) {
        console.log("Connected successfully");
    } else {
        console.log("Connection failed. Err:" + JSON.stringify(err));
    }
});

五、Socket连接

1. 基本概念

• Socket：套接字，就是对网络中不同主机上的应用进程之间进行双向通信的端点的抽象。
• TCP：传输控制协议(Transmission Control Protocol)。是一种面向连接的、可靠的、基于字节流的传输层通信协议。
• UDP：用户数据报协议(User Datagram Protocol)。是一个简单的面向消息的传输层，不需要连接。
• TLS：安全传输层协议(Transport Layer Security)。用于在两个通信应用程序之间提供保密性和数据完整性。

应用通过Socket进行数据传输，支持TCP/UDP/TLS协议。主要场景有：

• 应用通过TCP/UDP Socket进行数据传输
• 应用通过TLS Socket进行加密数据传输

2. 接口说明

Socket连接主要由socket模块提供。

接口名	功能描述
constructUDPSocketInstance()	创建一个UDPSocket对象。
constructTCPSocketInstance()	创建一个TCPSocket对象。
bind()	绑定IP地址和端口。
send()	发送数据。
close()	关闭连接。
getState()	获取Socket状态。
connect()	连接到指定的IP地址和端口（仅TCP支持）
getRemoteAddress()	获取对端Socket地址（仅TCP支持，需要先调用connect方法）
on(type: ‘message’)	订阅Socket连接的接收消息事件。
off(type: ‘message’)	取消订阅Socket连接的接收消息事件。
on(type: ‘close’)	订阅Socket连接的关闭事件。
off(type: ‘close’)	取消订阅Socket连接的关闭事件。
on(type: ‘error’)	订阅Socket连接的Error事件。
off(type: ‘error’)	取消订阅Socket连接的Error事件。
on(type: ‘listening’)	订阅UDPSocket连接的数据包消息事件（仅UDP支持）。
off(type: ‘listening’)	取消订阅UDPSocket连接的数据包消息事件（仅UDP支持）。
on(type: ‘connect’)	订阅TCPSocket的连接事件（仅TCP支持）。
off(type: ‘connect’)	取消订阅TCPSocket的连接事件（仅TCP支持）。

TLS Socket连接主要由tls_socket模块提供。

接口名	功能描述
constructTLSSocketInstance()	创建一个TLSSocket对象。
bind()	绑定IP地址和端口号。
close(type: ‘error’)	关闭连接。
connect()	连接到指定的IP地址和端口。
getCertificate()	返回表示本地证书的对象。
getCipherSuite()	返回包含协商的密码套件信息的列表。
getProtocol()	返回包含当前连接协商的SSL/TLS协议版本的字符串。
getRemoteAddress()	获取TLSSocket连接的对端地址。
getRemoteCertificate()	返回表示对等证书的对象。
getSignatureAlgorithms()	在服务器和客户端之间共享的签名算法列表，按优先级降序排列。
getState()	获取TLSSocket连接的状态。
off(type: ‘close’)	取消订阅TLSSocket连接的关闭事件。
off(type: ‘error’)	取消订阅TLSSocket连接的Error事件。
off(type: ‘message’)	取消订阅TLSSocket连接的接收消息事件。
on(type: ‘close’)	订阅TLSSocket连接的关闭事件。
on(type: ‘error’)	订阅TLSSocket连接的Error事件。
on(type: ‘message’)	订阅TLSSocket连接的接收消息事件。
send()	发送数据。
setExtraOptions()	设置TLSSocket连接的其他属性。

3. 应用TCP/UDP协议进行通信

1. import需要的socket模块。
2. 创建一个TCPSocket连接，返回一个TCPSocket对象。
3. （可选）订阅TCPSocket相关的订阅事件。
4. 绑定IP地址和端口，端口可以指定或由系统随机分配。
5. 连接到指定的IP地址和端口。
6. 发送数据。
7. Socket连接使用完毕后，主动关闭。

import socket from '@ohos.net.socket';

// 创建一个TCPSocket连接，返回一个TCPSocket对象。
let tcp = socket.constructTCPSocketInstance();

// 订阅TCPSocket相关的订阅事件
tcp.on('message', value => {
  console.log("on message")
  let buffer = value.message
  let dataView = new DataView(buffer)
  let str = ""
  for (let i = 0; i < dataView.byteLength; ++i) {
    str += String.fromCharCode(dataView.getUint8(i))
  }
  console.log("on connect received:" + str)
});
tcp.on('connect', () => {
  console.log("on connect")
});
tcp.on('close', () => {
  console.log("on close")
});

// 绑定IP地址和端口。
let bindAddress = {
  address: '192.168.xx.xx',
  port: 1234, // 绑定端口，如1234
  family: 1
};
tcp.bind(bindAddress, err => {
  if (err) {
    console.log('bind fail');
    return;
  }
  console.log('bind success');
  // 连接到指定的IP地址和端口。
  let connectAddress = {
    address: '192.168.xx.xx',
    port: 5678, // 连接端口，如5678
    family: 1
  };
  tcp.connect({
    address: connectAddress, timeout: 6000
  }, err => {
    if (err) {
      console.log('connect fail');
      return;
    }
    console.log('connect success');
    // 发送数据
    tcp.send({
      data: 'Hello, server!'
    }, err => {
      if (err) {
        console.log('send fail');
        return;
      }
      console.log('send success');
    })
  });
});
// 连接使用完毕后，主动关闭。取消相关事件的订阅。
setTimeout(() => {
  tcp.close((err) => {
    console.log('close socket.')
  });
  tcp.off('message');
  tcp.off('connect');
  tcp.off('close');
}, 30 * 1000);

4. 应用通过TLS Socket进行加密数据传输

1. import需要的socket模块。
2. 绑定服务器IP和端口号。
3. 双向认证上传客户端CA证书及数字证书；单向认证上传客户端CA证书。
4. 创建一个TLSSocket连接，返回一个TLSSocket对象。
5. （可选）订阅TLSSocket相关的订阅事件。
6. 发送数据。
7. TLSSocket连接使用完毕后，主动关闭。

   import socket from '@ohos.net.socket';

   // 创建一个（双向认证）TLS Socket连接，返回一个TLS Socket对象。
   let tlsTwoWay = socket.constructTLSSocketInstance();

   // 订阅TLS Socket相关的订阅事件
   tlsTwoWay.on('message', value => {
       console.log("on message")
       let buffer = value.message
       let dataView = new DataView(buffer)
       let str = ""
       for (let i = 0; i < dataView.byteLength; ++i) {
           str += String.fromCharCode(dataView.getUint8(i))
       }
       console.log("on connect received:" + str)
   });
   tlsTwoWay.on('connect', () => {
       console.log("on connect")
   });
   tlsTwoWay.on('close', () => {
       console.log("on close")
   });

   // 绑定本地IP地址和端口。
   tlsTwoWay.bind({ address: '192.168.xxx.xxx', port: xxxx, family: 1 }, err => {
       if (err) {
           console.log('bind fail');
           return;
       }
       console.log('bind success');
   });

   // 设置通信过程中使用参数
   let options = {
       ALPNProtocols: ["spdy/1", "http/1.1"],

       // 连接到指定的IP地址和端口。
       address: {
           address: "192.168.xx.xxx",
           port: xxxx, // 端口
           family: 1,
       },

       // 设置用于通信过程中完成校验的参数。
       secureOptions: {
           key: "xxxx",                            // 密钥
           cert: "xxxx",                           // 数字证书
           ca: ["xxxx"],                           // CA证书
           passwd: "xxxx",                         // 生成密钥时的密码
           protocols: [socket.Protocol.TLSv12],    // 通信协议
           useRemoteCipherPrefer: true,            // 是否优先使用对端密码套件
           signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",    // 签名算法
           cipherSuite: "AES256-SHA256",           // 密码套件
       },
   };

   // 建立连接
   tlsTwoWay.connect(options, (err, data) => {
       console.error(err);
       console.log(data);
   });

   // 连接使用完毕后，主动关闭。取消相关事件的订阅。
   tlsTwoWay.close((err) => {
       if (err) {
           console.log("close callback error = " + err);
       } else {
           console.log("close success");
       }
       tlsTwoWay.off('message');
       tlsTwoWay.off('connect');
       tlsTwoWay.off('close');
   });

   // 创建一个（单向认证）TLS Socket连接，返回一个TLS Socket对象。
   let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication

   // 订阅TLS Socket相关的订阅事件
   tlsTwoWay.on('message', value => {
       console.log("on message")
       let buffer = value.message
       let dataView = new DataView(buffer)
       let str = ""
       for (let i = 0;i < dataView.byteLength; ++i) {
           str += String.fromCharCode(dataView.getUint8(i))
       }
       console.log("on connect received:" + str)
   });
   tlsTwoWay.on('connect', () => {
       console.log("on connect")
   });
   tlsTwoWay.on('close', () => {
       console.log("on close")
   });

   // 绑定本地IP地址和端口。
   tlsOneWay.bind({ address: '192.168.xxx.xxx', port: xxxx, family: 1 }, err => {
       if (err) {
           console.log('bind fail');
           return;
       }
       console.log('bind success');
   });

   // 设置通信过程中使用参数
   let oneWayOptions = {
       address: {
           address: "192.168.xxx.xxx",
           port: xxxx,
           family: 1,
       },
       secureOptions: {
           ca: ["xxxx","xxxx"],            // CA证书
           cipherSuite: "AES256-SHA256",   // 密码套件
       },
   };

   // 建立连接
   tlsOneWay.connect(oneWayOptions, (err, data) => {
       console.error(err);
       console.log(data);
   });

   // 连接使用完毕后，主动关闭。取消相关事件的订阅。
   tlsTwoWay.close((err) => {
       if (err) {
           console.log("close callback error = " + err);
       } else {
           console.log("close success");
       }
       tlsTwoWay.off('message');
       tlsTwoWay.off('connect');
       tlsTwoWay.off('close');
   });