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

supercxx 8年前發布 | 8K 次閱讀 Node.js Socket Node.js 開發

模塊概覽

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('服務端：開始監聽來自客戶端的請求');
});</code></pre> 
  
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('你好，我是客戶端');</code></pre> 
  
運行服務端、客戶端代碼，控制臺分別輸出如下： 
  服務端： 
  服務端：開始監聽來自客戶端的請求
服務端：收到來自客戶端的請求
服務端：收到客戶端數據，內容為{你好，我是客戶端}
服務端：客戶端連接斷開 
  客戶端： 
  客戶端：已經與服務端建立連接
客戶端：收到服務端數據，內容為{你好，我是服務端}
客戶端：連接斷開 
  服務端 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 );
});</code></pre> 
  
輸出為： 
  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回調：服務端正常關閉' );
    }

});</code></pre> 
  
輸出為： 
  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);</code></pre> 
  
通過下面命令測試下效果 
  curl http://127.0.0.1:3000 
  輸出： 
  1. connection 觸發

connection 觸發</code></pre> 
客戶端 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('你好，我是客戶端');</code></pre> 
  
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：域名解析完成時觸發。 
   
    
  來自：http://www.cnblogs.com/chyingp/p/6072338.html


                    
                         本文由用戶 supercxx 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
                         轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
                         本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！
                         本文地址：http://www.baiduhome.net/lib/view/open1479369912171.html
                         Node.js Socket Node.js 開發

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

模塊概覽

簡單的 server+client 例子

服務端 net.Server

server.address()

server.close(callback])

server.ref()/server.unref()

事件 listening/connection/close/error

客戶端 net.Socket

API、屬性歸類

連接相關

數據讀、寫相關

數據屬性相關

事件循環相關

地址相關

事件簡介

相關經驗

相關資訊

相關文檔

目錄