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

模組概覽

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

從組成來看，net模組主要包含兩部分，了解socket程式設計的同學應該比較熟悉了：

net.Server：TCP server，內部透過socket來實現與客戶端的通訊。

net.Socket：tcp/本地 socket的node版實現，它實現了全雙工的stream介面。

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

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

簡單的server+client 範例

tcp服務端程式如下：

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('你好，我是客户端');

運作服務端、客戶端程式碼，控制台分別輸出如下：

服務：開始監聽來自客戶端的請求

服務端：收到來自客戶端的請求

服務端：收到客戶端數據，內容為{你好，我是客戶端}
服務端：客戶端連線斷開


客戶端：

客戶端：已經與服務端建立連線

客戶端：收到服務端數據，內容為{你好，我是服務端}

客戶端：連線中斷


服務端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()

server.ref()/server.unref()

。這兩個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 觸發

輸出：

🎜1. connection 觸發2. connection 觸發🎜輸出：🎜🎜1. connection.

在文章开头已经举过客户端的例子，这里再把例子贴一下。(备注：严格来说不应该把 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：域名解析完成时触发。