Like Share Discussion Bookmark Smile

J.J. Huang   2020-02-04   Node.js   瀏覽次數:

Node.js | 常用工具模組(Net模組)

簡介

Node.js Net模組提供了一些用於底層的網路通信的小工具,包含了建立伺服器/客戶端的方法。

1
var net = require("net")

方法

序號 方法 & 描述 Doc
1 net.createServer([options][, connectionListener])
建立一個 TCP 伺服器。
參數 connectionListener 自動給 ‘connection’ 事件建立監聽器。
Link
2 net.connect(options[, connectionListener])
返回一個新的 ‘net.Socket’,並連接到指定的地址和端口。
當 socket 建立的時候,將會觸發 ‘connect’ 事件。
Link
3 net.createConnection(options[, connectionListener])
建立一個到端口 port 和 主機 host的 TCP 連接。 host 默認為 ‘localhost’。
Link
4 net.connect(port[, host][, connectListener])
建立一個端口為 port 和主機為 host的 TCP 連接 。 host 默認為 ‘localhost’。
參數 connectListener 將會作為監聽器添加到 ‘connect’ 事件。返回 ‘​​net.Socket’。
Link
5 net.createConnection(port[, host][, connectListener])
建立一個端口為 port 和主機為 host的 TCP 連接 。 host 默認為 ‘localhost’。
參數 connectListener 將會作為監聽器添加到 ‘connect’ 事件。返回 ‘​​net.Socket’。
Link
6 net.connect(path[, connectListener])
建立連接到 path 的 unix socket 。
參數 connectListener 將會作為監聽器添加到 ‘connect’ 事件上。返回 ‘​​net.Socket’。
Link
7 net.createConnection(path[, connectListener])
建立連接到 path 的 unix socket 。
參數 connectListener 將會作為監聽器添加到 ‘connect’ 事件。返回 ‘​​net.Socket’。
Link
8 net.isIP(input)
檢測輸入的是否為 IP 地址。 IPV4 返回 4, IPV6 返回 6,其他情況返回 0。
Link
9 net.isIPv4(input)
如果輸入的地址為 IPV4, 返回 true,否則返回 false。
Link
10 net.isIPv6(input)
如果輸入的地址為 IPV6, 返回 true,否則返回 false。
Link

net.Server

net.Server通常用於建立一個TCP或本地伺服器。

方法

序號 方法 & 描述 Doc
1 server.listen(port[, host][, backlog][, callback])
監聽指定端口 port 和 主機 host ac連接。默認情況下 host 接受任何 IPv4 地址(INADDR_ANY)的直接連接。端口 port 為 0 時,則會分配一個隨機端口。
Link
2 server.listen(path[, callback])
通過指定 path 的連接,啟動一個本地 socket 伺服器。
Link
3 server.listen(handle[, callback])
通過指定句柄連接。
Link
4 server.listen(options[, callback])
options 的屬性:端口 port, 主機 host, 和 backlog, 以及可選參數 callback 函數, 他們在一起調用server.listen(port, [host], [backlog], [callback])。還有,參數 path 可以用來指定 UNIX socket。
Link
5 server.close([callback])
伺服器停止接收新的連接,保持現有連接。這是異步函數,當所有連接結束的時候伺服器會關閉,並會觸發 ‘close’ 事件。
Link
6 server.address()
操作系統返回綁定的地址,協議族名和伺服器端口。
Link
7 server.unref()
如果這是事件系統中唯一一個活動的伺服器,調用 unref 將允許程序退出。
Link
8 server.ref()
與 unref 相反,如果這是唯一的伺服器,在之前被 unref 了的伺服器上調用 ref 將不會讓程序退出(默認行為)。如果伺服器已經被 ref,則再次調用 ref 並不會產生影響。
Link
9 server.getConnections(callback)
異步獲取伺服器當前活躍連接的數量。當 socket 發送給子進程後才有效;回調函數有 2 個參數 err 和 count。
Link

事件

序號 事件 & 描述 Doc
1 listening
當伺服器調用 server.listen 綁定後會觸發。
Link
2 connection
當新連接建立後會被觸發。 socket 是 net.Socket實例。
Link
3 close
伺服器關閉時會觸發。注意,如果存在連接,這個事件不會被觸發直到所有的連接關閉。
Link
4 error
發生錯誤時觸發。 ‘close’ 事件將被下列事件直接調用。
Link

net.Socket

net.Socket對像是TCPUNIX Socket的抽象。
net.Socket實例實現了一個雙工流接口。
他們可以在用戶建立客戶端(使用 connect())時使用, 或者由Node建立它們,並通過connection伺服器事件傳遞給用戶。

事件

序號 事件 & 描述 Doc
1 lookup
在解析域名後,但在連接前,觸發這個事件。對 UNIX sokcet 不適用。
Link
2 connect
成功建立 socket 連接時觸發。
Link
3 data
當接收到資料時觸發。
Link
4 end
當 socket 另一端發送 FIN 包時,觸發該事件。
Link
5 timeout
當 socket 空閒超時時觸發,僅是表明 socket 已經空閒。用戶必須手動關閉連接。
Link
6 drain
當寫緩存為空得時候觸發。可用來控制上傳。
Link
7 error
錯誤發生時觸發。
Link
8 close
當 socket 完全關閉時觸發。參數 had_error 是布爾值,它表示是否因為傳輸錯誤導致 socket 關閉。
Link

屬性

序號 屬性 & 描述 Doc
1 socket.bufferSize
該屬性顯示了要寫入緩衝區的字節數。
Link
2 socket.remoteAddress
遠程的 IP 地址字符串,例如:’74.125.127.100’ or ‘2001:4860:a005::68’。
Link
3 socket.remoteFamily
遠程IP協議族字符串,比如 ‘IPv4’ or ‘IPv6’。
Link
4 socket.remotePort
遠程端口,數字表示,例如:80 or 21。
Link
5 socket.localAddress
網路連接綁定的本地接口 遠程客戶端正在連接的本地 IP 地址,字符串表示。例如,如果你在監聽’0.0.0.0’而客戶端連接在’192.168.1.1’,這個值就會是 ‘192.168.1.1’。
Link
6 socket.localPort
本地端口地址,數字表示。例如:80 or 21。
Link
7 socket.bytesRead
接收到得字節數。
Link
8 socket.bytesWritten
發送的字節數。
Link

方法

序號 方法 & 描述 Doc
1 new net.Socket([options])
構造一個新的 socket 對象。
Link
2 socket.connect(port[, host][, connectListener])
指定端口 port 和 主機 host,建立 socket 連接 。參數 host 默認為 localhost。通常情況不需要使用 net.createConnection 打開 socket。只有你實現了自己的 socket 時才會用到。
Link
3 socket.connect(path[, connectListener])
打開指定路徑的 unix socket。通常情況不需要使用 net.createConnection 打開 socket。只有你實現了自己的 socket 時才會用到。
Link
4 socket.setEncoding([encoding])
設置編碼。
Link
5 socket.write(data[, encoding][, callback])
在 socket 上發送資料。第二個參數指定了字符串的編碼,默認是 UTF8 編碼。
Link
6 socket.end([data][, encoding])
半關閉 socket。例如,它發送一個 FIN 包。可能伺服器仍在發送資料。
Link
7 socket.destroy()
確保沒有 I/O 活動在這個套接字上。只有在錯誤發生情況下才需要。 (處理錯誤等等)。
Link
8 socket.pause()
暫停讀取資料。就是說,不會再觸發 data 事件。對於控制上傳非常有用。
Link
9 socket.resume()
調用 pause() 後想恢復讀取資料。
Link
10 socket.setTimeout(timeout[, callback])
socket 閒置時間超過 timeout 毫秒後 ,將 socket 設置為超時。
Link
11 socket.setNoDelay([noDelay])
禁用納格(Nagle)算法。默認情況下 TCP 連接使用納格算法,在發送前他們會緩衝資料。將 noDelay 設置為 true 將會在調用 socket.write() 時立即發送資料。 noDelay 默認值為 true。
Link
12 socket.setKeepAlive([enable][, initialDelay])
禁用/啟用長連接功能,並在發送第一個在閒置 socket 上的長連接 probe 之前,可選地設定初始延時。默認為 false。設定 initialDelay (毫秒),來設定收到的最後一個資料包和第一個長連接probe之間的延時。將 initialDelay 設為0,將會保留默認(或者之前)的值。默認值為0。
Link
13 socket.address()
操作系統返回綁定的地址,協議族名和伺服器端口。返回的對像有 3 個屬性,比如{ port: 12346, family: ‘IPv4’, address: ‘127.0.0.1’ }。
Link
14 socket.unref()
如果這是事件系統中唯一一個活動的伺服器,調用 unref 將允許程序退出。如果伺服器已被 unref,則再次調用 unref 並不會產生影響。
Link
15 socket.ref()
與 unref 相反,如果這是唯一的伺服器,在之前被 unref 了的伺服器上調用 ref 將不會讓程序退出(默認行為)。如果伺服器已經被 ref,則再次調用 ref 並不會產生影響。
Link

實例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// server.js

var net = require('net');
var server = net.createServer(function(connection) {
   console.log('client connected');
   connection.on('end', function() {
      console.log('客戶端關閉連接');
   });
   connection.write('Hello World!\r\n');
   connection.pipe(connection);
});
server.listen(8080, function() {
  console.log('server is listening');
});
1
2
3
4
5
6
7
8
9
10
11
12
13
// client.js

var net = require('net');
var client = net.connect({port: 8080}, function() {
   console.log('連接到伺服器!');
});
client.on('data', function(data) {
   console.log(data.toString());
   client.end();
});
client.on('end', function() {
   console.log('斷開與伺服器的連接');
});

執行結果如下:

1
2
3
// 啟動
$ node server.js
server is listening
1
2
3
4
5
6
// 連接
$ node client.js
連接到伺服器!
Hello World!

斷開與伺服器的連接
1
2
3
4
5
// 連接後
$ node server.js
server is listening
client connected
客戶端關閉連接

方法參考手冊

請直接至Node.js官方提供的Net Documentation查看。


註:以上參考了
Node.js Net 模块