首頁 > web前端 > js教程 > 主體

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

高洛峰
發布: 2016-12-06 11:49:33
原創
1086 人瀏覽過

模組概覽

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回呼:服務端正常關閉



程式碼如下

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()

同學對這兩個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 觸發已經舉過客戶端的例子,這裡再把例子貼一下。 (備註:嚴格來說不應該把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.ref()、socket.unref()

socket.ref()、socket.unref()

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:網域解析完成時觸發。


🎜
相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板
關於我們 免責聲明 Sitemap
PHP中文網:公益線上PHP培訓,幫助PHP學習者快速成長!