Nodejs進階：核心模塊net入門與實例講解

時間 2019-11-06

標籤 nodejs 進階核心模塊入門實例講解简体版

原文原文鏈接

本文摘錄自《Nodejs學習筆記》，更多章節及更新，請訪問 github主頁地址。歡迎加羣交流，羣號 197339705。html

模塊概覽

net模塊是一樣是nodejs的核心模塊。在http模塊概覽裏提到，http.Server繼承了net.Server，此外，http客戶端與http服務端的通訊均依賴於socket（net.Socket）。也就是說，作node服務端編程，net基本是繞不開的一個模塊。node

從組成來看，net模塊主要包含兩部分，瞭解socket編程的同窗應該比較熟悉了：git

net.Server：TCP server，內部經過socket來實現與客戶端的通訊。github
net.Socket：tcp/本地 socket的node版實現，它實現了全雙工的stream接口。編程

本文從一個簡單的 tcp服務端/客戶端的例子開始講解，好讓讀者有個概要的認識。接着再分別介紹 net.Server、net.Socket 比較重要的API、屬性、事件。api

對於初學者，建議把文中的例子本地跑一遍加深理解。緩存

簡單的 server+client 例子

tcp服務端程序以下：bash

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp服務端
var server = net.createServer(function(socket){
    console.log('服務端：收到來自客戶端的請求');

    socket.on('data', function(data){
        console.log('服務端：收到客戶端數據，內容爲{'+ data +'}');

        // 給客戶端返回數據
        socket.write('你好，我是服務端');
    });

    socket.on('close', function(){
         console.log('服務端：客戶端鏈接斷開');
    });
});
server.listen(PORT, HOST, function(){
    console.log('服務端：開始監聽來自客戶端的請求');
});

tcp客戶端以下：服務器

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp客戶端
var client = net.createConnection(PORT, HOST);

client.on('connect', function(){
    console.log('客戶端：已經與服務端創建鏈接');
});

client.on('data', function(data){
    console.log('客戶端：收到服務端數據，內容爲{'+ data +'}');
});

client.on('close', function(data){
    console.log('客戶端：鏈接斷開');
});

client.end('你好，我是客戶端');

運行服務端、客戶端代碼，控制檯分別輸出以下：curl

服務端：

服務端：開始監聽來自客戶端的請求
服務端：收到來自客戶端的請求
服務端：收到客戶端數據，內容爲{你好，我是客戶端}
服務端：客戶端鏈接斷開

客戶端：

客戶端：已經與服務端創建鏈接
客戶端：收到服務端數據，內容爲{你好，我是服務端}
客戶端：鏈接斷開

服務端 net.Server

server.address()

返回服務端的地址信息，好比綁定的ip地址、端口等。

console.log( server.address() );
// 輸出以下 { port: 3000, family: 'IPv4', address: '127.0.0.1' }

server.close(callback])

關閉服務器，中止接收新的客戶端請求。有幾點注意事項：

對正在處理中的客戶端請求，服務器會等待它們處理完（或超時），而後再正式關閉。
正常關閉的同時，callback 會被執行，同時會觸發 close 事件。
異常關閉的同時，callback 也會執行，同時將對應的 error 做爲參數傳入。（好比還沒調用 server.listen(port) 以前，就調用了server.close()）

下面會經過兩個具體的例子進行對比，先把結論列出來

已調用server.listen()：正常關閉，close事件觸發，而後callback執行，error參數爲undefined
未調用server.listen()：異常關閉，close事件觸發，而後callback執行，error爲具體的錯誤信息。（注意，error 事件沒有觸發）

例子1：服務端正常關閉

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服務端
var server = net.createServer(noop);

server.listen(PORT, HOST, function(){

    server.close(function(error){
        if(error){
            console.log( 'close回調：服務端異常：' + error.message );
        }else{
            console.log( 'close回調：服務端正常關閉' );
        }            
    }); 
});

server.on('close', function(){
    console.log( 'close事件：服務端關閉' );
});

server.on('error', function(error){
    console.log( 'error事件：服務端異常：' + error.message );
});

輸出爲：

close事件：服務端關閉
close回調：服務端正常關閉

例子2：服務端異常關閉

代碼以下

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服務端
var server = net.createServer(noop);

// 沒有正式啓動請求監聽
// server.listen(PORT, HOST);

server.on('close', function(){
    console.log( 'close事件：服務端關閉' );
});

server.on('error', function(error){
    console.log( 'error事件：服務端異常：' + error.message );
});

server.close(function(error){
    if(error){
        console.log( 'close回調：服務端異常：' + error.message );
    }else{
        console.log( 'close回調：服務端正常關閉' );
    }            
});

輸出爲：

close事件：服務端關閉
close回調：服務端異常：Not running

server.ref()/server.unref()

瞭解node事件循環的同窗對這兩個API應該不陌生，主要用於將server 加入事件循環/從事件循環裏面剔除，影響就在於會不會影響進程的退出。

對出學習net的同窗來講，並不須要特別關注，感興趣的本身作下實驗就好。

事件 listening/connection/close/error

listening：調用 server.listen()，正式開始監聽請求的時候觸發。
connection：當有新的請求進來時觸發，參數爲請求相關的 socket。
close：服務端關閉的時候觸發。
error：服務出錯的時候觸發，好比監聽了已經被佔用的端口。

幾個事件都比較簡單，這裏僅舉個 connection 的例子。

從測試結果能夠看出，有新的客戶端鏈接產生時，net.createServer(callback) 中的callback回調會被調用，同時 connection 事件註冊的回調函數也會被調用。

事實上，net.createServer(callback) 中的 callback 在node內部實現中也是加入了作爲 connection事件的監聽函數。感興趣的能夠看下node的源碼。

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服務端
var server = net.createServer(function(socket){
    socket.write('1. connection 觸發\n');
});

server.on('connection', function(socket){
    socket.end('2. connection 觸發\n');
});

server.listen(PORT, HOST);

經過下面命令測試下效果

curl http://127.0.0.1:3000

輸出：

1. connection 觸發
2. connection 觸發

客戶端 net.Socket

在文章開頭已經舉過客戶端的例子，這裏再把例子貼一下。(備註：嚴格來講不該該把 net.Socket 叫作客戶端，這裏方便講解而已)

單從node官方文檔來看的話，感受 net.Socket 比 net.Server 要複雜不少，有更多的API、事件、屬性。但實際上，把 net.Socket 相關的API、事件、屬性進行歸類下，會發現，其實也不是特別複雜。

具體請看下一小節內容。

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp客戶端
var client = net.createConnection(PORT, HOST);

client.on('connect', function(){
    console.log('客戶端：已經與服務端創建鏈接');
});

client.on('data', function(data){
    console.log('客戶端：收到服務端數據，內容爲{'+ data +'}');
});

client.on('close', function(data){
    console.log('客戶端：鏈接斷開');
});

client.end('你好，我是客戶端');

API、屬性歸類

如下對net.Socket的API跟屬性，按照用途進行了大體的分類，方便讀者更好的理解。大部分API跟屬性都比較簡單，看下文檔就知道作什麼的，這裏就先不展開。

鏈接相關

socket.connect()：有3種不一樣的參數，用於不一樣的場景；
socket.setTimeout()：用來進行鏈接超時設置。
socket.setKeepAlive()：用來設置長鏈接。
socket.destroy(）、socket.destroyed：當錯誤發生時，用來銷燬socket，確保這個socket上不會再有其餘的IO操做。

數據讀、寫相關

socket.write()、socket.end()、socket.pause()、socket.resume()、socket.setEncoding()、socket.setNoDelay()

數據屬性相關

socket.bufferSize、socket.bytesRead、socket.bytesWritten

事件循環相關

socket.ref()、socket.unref()

地址相關

socket.address()
socket.remoteAddress、socket.remoteFamily、socket.remotePort
socket.localAddress/socket.localPort

事件簡介

data：當收到另外一側傳來的數據時觸發。
connect：當鏈接創建時觸發。
close：鏈接斷開時觸發。若是是由於傳輸錯誤致使的鏈接斷開，則參數爲error。
end：當鏈接另外一側發送了 FIN 包的時候觸發（讀者能夠回顧下HTTP如何斷開鏈接的）。默認狀況下（allowHalfOpen == false），socket會完成自我銷燬操做。但你也能夠把 allowHalfOpen 設置爲 true，這樣就能夠繼續往socket裏寫數據。固然，最後你須要手動調用 socket.end()
error：當有錯誤發生時，就會觸發，參數爲error。（官方文檔基本一句話帶過，不過考慮到出錯的可能太多，也能夠理解）
timeout：提示用戶，socket 已經超時，須要手動關閉鏈接。
drain：當寫緩存空了的時候觸發。（不是很好描述，具體能夠看下stream的介紹）
lookup：域名解析完成時觸發。