Latest web development tutorials

Node.js Net 模塊

Node.js Net 模塊

Node.js 工具模塊 Node.js工具模塊

Node.js Net 模塊提供了一些用於底層的網絡通信的小工具，包含了創建服務器/客戶端的方法，我們可以通過以下方式引入該模塊： 

var net = require("net")

方法

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

net.Server

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

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

事件

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

net.Socket

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

事件

net.Socket 事件有：

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

屬性

net.Socket 提供了很多有用的屬性，便於控制socket 交互：

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

方法

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

實例

創建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');
});

執行以上服務端代碼： 

$ node server.js
server is listening   # 服务已创建并监听 8080 端口

新開一個窗口，創建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('断开与服务器的连接');
});

執行以上客戶端的代碼： 

连接到服务器！
Hello World!

断开与服务器的连接

Gif 實例演示

Node.js 工具模塊 Node.js工具模塊