快捷導(dǎo)航

Node.js net模塊詳解(含類、方法、事件)

更新時(shí)間：2025年04月15日 09:21:51 作者：Sean2077

Node.js 的 net 模塊提供了基于 TCP 或 IPC 的網(wǎng)絡(luò)通信能力,用于創(chuàng)建服務(wù)器和客戶端,本文給大家介紹Node.js net模塊詳解包含類、方法、事件及示例,感興趣的朋友一起看看吧

1. 模塊引入

const net = require('net');

2. 核心類與方法

2.1 net.Server 類

用于創(chuàng)建 TCP 或 IPC 服務(wù)器。

方法

server.listen(port[, host][, backlog][, callback])
監(jiān)聽(tīng)指定端口和主機(jī)。

port: 端口號(hào)（若為 IPC 服務(wù)器則忽略）。
host: 主機(jī)地址（默認(rèn) 'localhost'）。
backlog: 最大等待連接隊(duì)列長(zhǎng)度（默認(rèn)由系統(tǒng)決定）。
callback: 監(jiān)聽(tīng)成功后的回調(diào)（等效于監(jiān)聽(tīng) 'listening' 事件）。

const server = net.createServer();
server.listen(3000, '127.0.0.1', () => {
  console.log('Server listening on port 3000');
});

server.listen(path[, callback])
監(jiān)聽(tīng) IPC 路徑（僅 Unix 系統(tǒng)支持）。

path: IPC 文件路徑（如 '/tmp/echo.sock'）。

server.close([callback])
停止服務(wù)器接受新連接，關(guān)閉現(xiàn)有連接后觸發(fā)回調(diào)。

server.address()
返回服務(wù)器綁定的地址信息（{ port, address, family }），未監(jiān)聽(tīng)時(shí)返回 null。

事件

'connection'
當(dāng)有新客戶端連接時(shí)觸發(fā)，回調(diào)參數(shù)為 socket 對(duì)象。

server.on('connection', (socket) => {
  console.log('New client connected');
});

'listening'
服務(wù)器開(kāi)始監(jiān)聽(tīng)時(shí)觸發(fā)。

'close'
服務(wù)器關(guān)閉后觸發(fā)。

'error'
發(fā)生錯(cuò)誤時(shí)觸發(fā)（如端口被占用）。

2.2 net.Socket 類

表示 TCP 或 IPC 的客戶端或服務(wù)器端連接。

方法

socket.connect(port[, host][, connectListener])
連接到指定端口和主機(jī)。

port: 目標(biāo)端口。
host: 目標(biāo)主機(jī)（默認(rèn) 'localhost'）。
connectListener: 連接成功后的回調(diào)（等效于監(jiān)聽(tīng) 'connect' 事件）。

const client = new net.Socket();
client.connect(3000, '127.0.0.1', () => {
  console.log('Connected to server');
});

socket.write(data[, encoding][, callback])
發(fā)送數(shù)據(jù)到另一端。

data: 要發(fā)送的數(shù)據(jù)（Buffer 或 String）。
encoding: 字符串編碼（默認(rèn) 'utf8'）。
callback: 數(shù)據(jù)寫(xiě)入完成后的回調(diào)。

socket.end([data][, encoding])
半關(guān)閉連接（發(fā)送 FIN 包），可選發(fā)送最后一段數(shù)據(jù)。

socket.destroy()
強(qiáng)制銷毀連接，觸發(fā) 'close' 事件。

socket.pause() / socket.resume()
暫停/恢復(fù)接收數(shù)據(jù)（控制 'data' 事件觸發(fā)）。

socket.setTimeout(timeout[, callback])
設(shè)置連接超時(shí)時(shí)間（毫秒），超時(shí)后觸發(fā)回調(diào)并自動(dòng)銷毀連接。

socket.setTimeout(3000, () => {
  console.log('Socket timed out');
  socket.destroy();
});

socket.setNoDelay([noDelay])
禁用 Nagle 算法（noDelay=true），降低延遲，適用于高頻小數(shù)據(jù)包場(chǎng)景。

屬性

socket.localAddress / socket.localPort: 本地地址和端口。
socket.remoteAddress / socket.remotePort: 遠(yuǎn)程地址和端口。
socket.bytesRead / socket.bytesWritten: 讀取/寫(xiě)入的字節(jié)數(shù)。

事件

'data'
接收到數(shù)據(jù)時(shí)觸發(fā)，回調(diào)參數(shù)為 Buffer 或 String。

socket.on('data', (data) => {
  console.log('Received:', data.toString());
});

'connect'
連接成功建立時(shí)觸發(fā)。

'end'
另一端發(fā)送 FIN 包（結(jié)束連接）時(shí)觸發(fā)。

'close'
連接完全關(guān)閉后觸發(fā)。

'timeout'
連接超時(shí)時(shí)觸發(fā)（需配合 setTimeout 使用）。

'error'
發(fā)生錯(cuò)誤時(shí)觸發(fā)（如連接被重置）。

2.3 工具函數(shù)

net.createServer([options][, connectionListener])
快速創(chuàng)建服務(wù)器，等同于 new net.Server() + server.on('connection')。

const server = net.createServer((socket) => {
  socket.write('Welcome to the server!');
});

net.connect(port[, host][, connectListener])
創(chuàng)建客戶端并連接到服務(wù)器，返回 net.Socket 對(duì)象。

const client = net.connect(3000, 'localhost', () => {
  client.write('Hello from client!');
});

net.isIP(input)
判斷輸入是否為 IP 地址，返回 4（IPv4）、6（IPv6）或 0（無(wú)效）。

net.isIP('192.168.1.1'); // 4
net.isIP('::1');         // 6
net.isIP('hello');       // 0

net.isIPv4(input) / net.isIPv6(input)
判斷輸入是否為 IPv4 或 IPv6 地址，返回布爾值。

3. 完整示例 TCP 服務(wù)器

const net = require('net');
const server = net.createServer((socket) => {
  console.log('Client connected');
  socket.on('data', (data) => {
    console.log('Received:', data.toString());
    socket.write('Echo: ' + data);
  });
  socket.on('end', () => {
    console.log('Client disconnected');
  });
});
server.listen(3000, '127.0.0.1', () => {
  console.log('Server listening on port 3000');
});

TCP 客戶端

const net = require('net');
const client = net.connect(3000, '127.0.0.1', () => {
  client.write('Hello Server!');
});
client.on('data', (data) => {
  console.log('Server response:', data.toString());
  client.end();
});
client.on('end', () => {
  console.log('Disconnected from server');
});