HarmonyOS 網(wǎng)絡(luò)管理開發(fā) —Socket 連接

簡(jiǎn)介

Socket 連接主要是通過(guò) Socket 進(jìn)行數(shù)據(jù)傳輸，支持 TCP/UDP/TLS 協(xié)議。

基本概念

? ● Socket：套接字，就是對(duì)網(wǎng)絡(luò)中不同主機(jī)上的應(yīng)用進(jìn)程之間進(jìn)行雙向通信的端點(diǎn)的抽象。

? ● TCP：傳輸控制協(xié)議 (Transmission Control Protocol)。是一種面向連接的、可靠的、基于字節(jié)流的傳輸層通信協(xié)議。

? ● UDP：用戶數(shù)據(jù)報(bào)協(xié)議協(xié)議 (User Datagram Protocol)。是一個(gè)簡(jiǎn)單的面向消息的傳輸層，不需要連接。

? ● TLS：安全傳輸層協(xié)議 (Transport Layer Security)。用于在兩個(gè)通信應(yīng)用程序之間提供保密性和數(shù)據(jù)完整性。

場(chǎng)景介紹

應(yīng)用通過(guò) Socket 進(jìn)行數(shù)據(jù)傳輸，支持 TCP/UDP/TLS 協(xié)議。主要場(chǎng)景有：

? ● 應(yīng)用通過(guò) TCP/UDP Socket 進(jìn)行數(shù)據(jù)傳輸

? ● 應(yīng)用通過(guò) TLS Socket 進(jìn)行加密數(shù)據(jù)傳輸

接口說(shuō)明

完整的 JS API 說(shuō)明以及實(shí)例代碼請(qǐng)參考：Socket 連接。

Socket 連接主要由 socket 模塊提供。具體接口說(shuō)明如下表。

TLS Socket 連接主要由 tls_socket 模塊提供。具體接口說(shuō)明如下表。

應(yīng)用 TCP/UDP 協(xié)議進(jìn)行通信

UDP 與 TCP 流程大體類似，下面以 TCP 為例：

? 1. import 需要的 socket 模塊。

? 2. 創(chuàng)建一個(gè) TCPSocket 連接，返回一個(gè) TCPSocket 對(duì)象。

? 3. （可選）訂閱 TCPSocket 相關(guān)的訂閱事件。

? 4. 綁定 IP 地址和端口，端口可以指定或由系統(tǒng)隨機(jī)分配。

? 5. 連接到指定的 IP 地址和端口。

? 6. 發(fā)送數(shù)據(jù)。

? 7. Socket 連接使用完畢后，主動(dòng)關(guān)閉。

import socket from '@ohos.net.socket'

// 創(chuàng)建一個(gè)TCPSocket連接，返回一個(gè)TCPSocket對(duì)象。
let tcp = socket.constructTCPSocketInstance();

// 訂閱TCPSocket相關(guān)的訂閱事件
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');
    // 發(fā)送數(shù)據(jù)
    tcp.send({
      data: 'Hello, server!'
    }, err => {
      if (err) {
        console.log('send fail');
        return;
      }
      console.log('send success');
    })
  });
});
// 連接使用完畢后，主動(dòng)關(guān)閉。取消相關(guān)事件的訂閱。
setTimeout(() => {
  tcp.close((err) => {
    console.log('close socket.')
  });
  tcp.off('message');
  tcp.off('connect');
  tcp.off('close');
}, 30 * 1000);

應(yīng)用通過(guò) TLS Socket 進(jìn)行加密數(shù)據(jù)傳輸

開發(fā)步驟

客戶端 TLS Socket 流程：

? 1. import 需要的 socket 模塊。

? 2. 綁定服務(wù)器 IP 和端口號(hào)。

? 3. 雙向認(rèn)證上傳客戶端 CA 證書及數(shù)字證書；單向認(rèn)證上傳客戶端 CA 證書。

? 4. 創(chuàng)建一個(gè) TLSSocket 連接，返回一個(gè) TLSSocket 對(duì)象。

? 5. （可選）訂閱 TLSSocket 相關(guān)的訂閱事件。

? 6. 發(fā)送數(shù)據(jù)。

? 7. TLSSocket 連接使用完畢后，主動(dòng)關(guān)閉。

 import socket from '@ohos.net.socket'

   // 創(chuàng)建一個(gè)（雙向認(rèn)證）TLS Socket連接，返回一個(gè)TLS Socket對(duì)象。
   let tlsTwoWay = socket.constructTLSSocketInstance();

   // 訂閱TLS Socket相關(guān)的訂閱事件
   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');
   });

   // 設(shè)置通信過(guò)程中使用參數(shù)
   let options = {
       ALPNProtocols: ["spdy/1", "http/1.1"],

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

       // 設(shè)置用于通信過(guò)程中完成校驗(yàn)的參數(shù)。
       secureOptions: {
           key: "xxxx",                            // 密鑰
           cert: "xxxx",                           // 數(shù)字證書
           ca: ["xxxx"],                           // CA證書
           passwd: "xxxx",                         // 生成密鑰時(shí)的密碼
           protocols: [socket.Protocol.TLSv12],    // 通信協(xié)議
           useRemoteCipherPrefer: true,            // 是否優(yōu)先使用對(duì)端密碼套件
           signatureAlgorithms: "rsa_pss_rsae_sha256:ECDSA+SHA256",    // 簽名算法
           cipherSuite: "AES256-SHA256",           // 密碼套件
       },
   };

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

   // 連接使用完畢后，主動(dòng)關(guān)閉。取消相關(guān)事件的訂閱。
   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');
   });

   // 創(chuàng)建一個(gè)（單向認(rèn)證）TLS Socket連接，返回一個(gè)TLS Socket對(duì)象。
   let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication

   // 訂閱TLS Socket相關(guān)的訂閱事件
   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');
   });

   // 設(shè)置通信過(guò)程中使用參數(shù)
   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);
   });

   // 連接使用完畢后，主動(dòng)關(guān)閉。取消相關(guān)事件的訂閱。
   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');
   });

審核編輯 黃宇