Node.js Net 模塊 · W3School Node.js 教程

# Node.js Net 模塊 Node.js Net 模塊提供了一些用于底層的網絡通信的小工具，包含了創建服務器/客戶端的方法，我們可以通過以下方式引入該模塊： ``` var net = require("net") ``` ### 方法 | 方法 | 描述 | | --- | --- | | **net.createServer([options][, connectionListener])** | 創建一個 TCP 服務器。參數 connectionListener 自動給 'connection' 事件創建監聽器。 | | **net.connect(options[, connectionListener])** | 返回一個新的 'net.Socket'，并連接到指定的地址和端口。當 socket 建立的時候，將會觸發 'connect' 事件。 | | **net.createConnection(options[, connectionListener])** | 創建一個到端口 port 和主機 host的 TCP 連接。 host 默認為 'localhost'。 | | **net.connect(port[, host][, connectListener])** | 創建一個端口為 port 和主機為 host的 TCP 連接。host 默認為 'localhost'。參數 connectListener 將會作為監聽器添加到 'connect' 事件。返回 'net.Socket'。 | | **net.createConnection(port[, host][, connectListener])** | 創建一個端口為 port 和主機為 host的 TCP 連接。host 默認為 'localhost'。參數 connectListener 將會作為監聽器添加到 'connect' 事件。返回 'net.Socket'。 | | **net.connect(path[, connectListener])** | 創建連接到 path 的 unix socket 。參數 connectListener 將會作為監聽器添加到 'connect' 事件上。返回 'net.Socket'。 | | **net.createConnection(path[, connectListener])** | 創建連接到 path 的 unix socket 。參數 connectListener 將會作為監聽器添加到 'connect' 事件。返回 'net.Socket'。 | | **net.isIP(input)** | 檢測輸入的是否為 IP 地址。 IPV4 返回 4， IPV6 返回 6，其他情況返回 0。 | | **net.isIPv4(input)** | 如果輸入的地址為 IPV4，返回 true，否則返回 false。 | | **net.isIPv6(input)** | 如果輸入的地址為 IPV6，返回 true，否則返回 false。 | ## net.Server net.Server通常用于創建一個 TCP 或本地服務器。 | 方法 | 描述 | | --- | --- | | **server.listen(port[, host][, backlog][, callback])** | 監聽指定端口 port 和主機 host ac連接。默認情況下 host 接受任何 IPv4 地址(INADDR_ANY)的直接連接。端口 port 為 0 時，則會分配一個隨機端口。 | | **server.listen(path[, callback])** | 通過指定 path 的連接，啟動一個本地 socket 服務器。 | | **server.listen(handle[, callback])** | 通過指定句柄連接。 | | **server.listen(options[, callback])** | options 的屬性：端口 port, 主機 host, 和 backlog, 以及可選參數 callback 函數, 他們在一起調用server.listen(port, [host], [backlog], [callback])。還有，參數 path 可以用來指定 UNIX socket。 | | **server.close([callback])** | 服務器停止接收新的連接，保持現有連接。這是異步函數，當所有連接結束的時候服務器會關閉，并會觸發 'close' 事件。 | | **server.address()** | 操作系統返回綁定的地址，協議族名和服務器端口。 | | **server.unref()** | 如果這是事件系統中唯一一個活動的服務器，調用 unref 將允許程序退出。 | | **server.ref()** | 與 unref 相反，如果這是唯一的服務器，在之前被 unref 了的服務器上調用 ref 將不會讓程序退出（默認行為）。如果服務器已經被 ref，則再次調用 ref 并不會產生影響。 | | **server.getConnections(callback)** | 異步獲取服務器當前活躍連接的數量。當 socket 發送給子進程后才有效；回調函數有 2 個參數 err 和 count。 | ### 事件 | 事件 | 描述 | | --- | --- | | **listening** | 當服務器調用 server.listen 綁定后會觸發。 | | **connection** | 當新連接創建后會被觸發。socket 是 net.Socket實例。 | | **close** | 服務器關閉時會觸發。注意，如果存在連接，這個事件不會被觸發直到所有的連接關閉。 | | **error** | 發生錯誤時觸發。'close' 事件將被下列事件直接調用。 | ## net.Socket net.Socket 對象是 TCP 或 UNIX Socket 的抽象。net.Socket 實例實現了一個雙工流接口。他們可以在用戶創建客戶端(使用 connect())時使用, 或者由 Node 創建它們，并通過 connection 服務器事件傳遞給用戶。 ### 事件 net.Socket 事件有： | 事件 | 描述 | | --- | --- | | **lookup** | 在解析域名后，但在連接前，觸發這個事件。對 UNIX sokcet 不適用。 | | **connect** | 成功建立 socket 連接時觸發。 | | **data** | 當接收到數據時觸發。 | | **end** | 當 socket 另一端發送 FIN 包時，觸發該事件。 | | **timeout** | 當 socket 空閑超時時觸發，僅是表明 socket 已經空閑。用戶必須手動關閉連接。 | | **drain** | 當寫緩存為空得時候觸發。可用來控制上傳。 | | **error** | 錯誤發生時觸發。 | | **close** | 當 socket 完全關閉時觸發。參數 had_error 是布爾值，它表示是否因為傳輸錯誤導致 socket 關閉。 | ### 屬性 net.Socket 提供了很多有用的屬性，便于控制 socket 交互： | 屬性 | 描述 | | --- | --- | | **socket.bufferSize** | 該屬性顯示了要寫入緩沖區的字節數。 | | **socket.remoteAddress** | 遠程的 IP 地址字符串，例如：'74.125.127.100' or '2001:4860:a005::68'。 | | **socket.remoteFamily** | 遠程IP協議族字符串，比如 'IPv4' or 'IPv6'。 | | **socket.remotePort** | 遠程端口，數字表示，例如：80 or 21。 | | **socket.localAddress** | 網絡連接綁定的本地接口遠程客戶端正在連接的本地 IP 地址，字符串表示。例如，如果你在監聽'0.0.0.0'而客戶端連接在'192.168.1.1'，這個值就會是 '192.168.1.1'。 | | **socket.localPort** | 本地端口地址，數字表示。例如：80 or 21。 | | **socket.bytesRead** | 接收到得字節數。 | | **socket.bytesWritten** | 發送的字節數。 | ### 方法 | 方法 | 描述 | | --- | --- | | **new net.Socket([options])** | 構造一個新的 socket 對象。 | | **socket.connect(port[, host][, connectListener])** | 指定端口 port 和主機 host，創建 socket 連接。參數 host 默認為 localhost。通常情況不需要使用 net.createConnection 打開 socket。只有你實現了自己的 socket 時才會用到。 | | **socket.connect(path[, connectListener])** | 打開指定路徑的 unix socket。通常情況不需要使用 net.createConnection 打開 socket。只有你實現了自己的 socket 時才會用到。 | | **socket.setEncoding([encoding])** | 設置編碼 | | **socket.write(data[, encoding][, callback])** | 在 socket 上發送數據。第二個參數指定了字符串的編碼，默認是 UTF8 編碼。 | | **socket.end([data][, encoding])** | 半關閉 socket。例如，它發送一個 FIN 包。可能服務器仍在發送數據。 | | **socket.destroy()** | 確保沒有 I/O 活動在這個套接字上。只有在錯誤發生情況下才需要。（處理錯誤等等）。 | | **socket.pause()** | 暫停讀取數據。就是說，不會再觸發 data 事件。對于控制上傳非常有用。 | | **socket.resume()** | 調用 pause() 后想恢復讀取數據。 | | **socket.setTimeout(timeout[, callback])** | socket 閑置時間超過 timeout 毫秒后，將 socket 設置為超時。 | | **socket.setNoDelay([noDelay])** | 禁用納格（Nagle）算法。默認情況下 TCP 連接使用納格算法，在發送前他們會緩沖數據。將 noDelay 設置為 true 將會在調用 socket.write() 時立即發送數據。noDelay 默認值為 true。 | | **socket.setKeepAlive([enable][, initialDelay])** | 禁用/啟用長連接功能，并在發送第一個在閑置 socket 上的長連接 probe 之前，可選地設定初始延時。默認為 false。設定 initialDelay （毫秒），來設定收到的最后一個數據包和第一個長連接probe之間的延時。將 initialDelay 設為0，將會保留默認（或者之前）的值。默認值為0. | | **socket.address()** | 操作系統返回綁定的地址，協議族名和服務器端口。返回的對象有 3 個屬性，比如{ port: 12346, family: 'IPv4', address: '127.0.0.1' }。 | | **socket.unref()** | 如果這是事件系統中唯一一個活動的服務器，調用 unref 將允許程序退出。如果服務器已被 unref，則再次調用 unref 并不會產生影響。 | | **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 實例演示 ![](https://box.kancloud.cn/2015-12-16_56711ea32f3ec.gif)