模塊概覽

net模塊是同樣是nodejs的核心模塊。在http模塊概覽里提到，http.Server繼承了net.Server，此外，http客戶端與http服務(wù)端的通信均依賴于socket（net.Socket）。也就是說(shuō)，做node服務(wù)端編程，net基本是繞不開(kāi)的一個(gè)模塊。

從組成來(lái)看，net模塊主要包含兩部分，了解socket編程的同學(xué)應(yīng)該比較熟悉了：

• net.Server：TCP server，內(nèi)部通過(guò)socket來(lái)實(shí)現(xiàn)與客戶端的通信。
• net.Socket：tcp/本地 socket的node版實(shí)現(xiàn)，它實(shí)現(xiàn)了全雙工的stream接口。
  

本文從一個(gè)簡(jiǎn)單的 tcp服務(wù)端/客戶端 的例子開(kāi)始講解，好讓讀者有個(gè)概要的認(rèn)識(shí)。接著再分別介紹 net.Server、net.Socket 比較重要的API、屬性、事件。

對(duì)于初學(xué)者，建議把文中的例子本地跑一遍加深理解。

簡(jiǎn)單的 server+client 例子

tcp服務(wù)端程序如下：

var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';// tcp服務(wù)端var server = net.createServer(function(socket){  console.log('服務(wù)端：收到來(lái)自客戶端的請(qǐng)求');  socket.on('data', function(data){    console.log('服務(wù)端：收到客戶端數(shù)據(jù)，內(nèi)容為{'+ data +'}');    // 給客戶端返回?cái)?shù)據(jù)    socket.write('你好，我是服務(wù)端');  });  socket.on('close', function(){     console.log('服務(wù)端：客戶端連接斷開(kāi)');  });});server.listen(PORT, HOST, function(){  console.log('服務(wù)端：開(kāi)始監(jiān)聽(tīng)來(lái)自客戶端的請(qǐng)求');});

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('客戶端：已經(jīng)與服務(wù)端建立連接');});client.on('data', function(data){  console.log('客戶端：收到服務(wù)端數(shù)據(jù)，內(nèi)容為{'+ data +'}');});client.on('close', function(data){  console.log('客戶端：連接斷開(kāi)');});client.end('你好，我是客戶端');

運(yùn)行服務(wù)端、客戶端代碼，控制臺(tái)分別輸出如下：

服務(wù)端：

服務(wù)端：開(kāi)始監(jiān)聽(tīng)來(lái)自客戶端的請(qǐng)求
服務(wù)端：收到來(lái)自客戶端的請(qǐng)求
服務(wù)端：收到客戶端數(shù)據(jù)，內(nèi)容為{你好，我是客戶端}
服務(wù)端：客戶端連接斷開(kāi)

客戶端：

客戶端：已經(jīng)與服務(wù)端建立連接
客戶端：收到服務(wù)端數(shù)據(jù)，內(nèi)容為{你好，我是服務(wù)端}
客戶端：連接斷開(kāi)

服務(wù)端 net.Server

server.address()
返回服務(wù)端的地址信息，比如綁定的ip地址、端口等。

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

server.close(callback])

關(guān)閉服務(wù)器，停止接收新的客戶端請(qǐng)求。有幾點(diǎn)注意事項(xiàng)：

• 對(duì)正在處理中的客戶端請(qǐng)求，服務(wù)器會(huì)等待它們處理完（或超時(shí)），然后再正式關(guān)閉。
• 正常關(guān)閉的同時(shí)，callback 會(huì)被執(zhí)行，同時(shí)會(huì)觸發(fā) close 事件。
• 異常關(guān)閉的同時(shí)，callback 也會(huì)執(zhí)行，同時(shí)將對(duì)應(yīng)的 error 作為參數(shù)傳入。（比如還沒(méi)調(diào)用 server.listen(port) 之前，就調(diào)用了server.close()）
  

下面會(huì)通過(guò)兩個(gè)具體的例子進(jìn)行對(duì)比，先把結(jié)論列出來(lái)

• 已調(diào)用server.listen()：正常關(guān)閉，close事件觸發(fā)，然后callback執(zhí)行，error參數(shù)為undefined
• 未調(diào)用server.listen()：異常關(guān)閉，close事件觸發(fā)，然后callback執(zhí)行，error為具體的錯(cuò)誤信息。（注意，error 事件沒(méi)有觸發(fā)）
  

例子1：服務(wù)端正常關(guān)閉

var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';var noop = function(){};// tcp服務(wù)端var server = net.createServer(noop);server.listen(PORT, HOST, function(){  server.close(function(error){    if(error){      console.log( 'close回調(diào)：服務(wù)端異常：' + error.message );    }else{      console.log( 'close回調(diào)：服務(wù)端正常關(guān)閉' );    }        }); });server.on('close', function(){  console.log( 'close事件：服務(wù)端關(guān)閉' );});server.on('error', function(error){  console.log( 'error事件：服務(wù)端異常：' + error.message );});

輸出為：

close事件：服務(wù)端關(guān)閉
close回調(diào)：服務(wù)端正常關(guān)閉

例子2：服務(wù)端異常關(guān)閉

代碼如下

var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';var noop = function(){};// tcp服務(wù)端var server = net.createServer(noop);// 沒(méi)有正式啟動(dòng)請(qǐng)求監(jiān)聽(tīng)// server.listen(PORT, HOST);server.on('close', function(){  console.log( 'close事件：服務(wù)端關(guān)閉' );});server.on('error', function(error){  console.log( 'error事件：服務(wù)端異常：' + error.message );});server.close(function(error){  if(error){    console.log( 'close回調(diào)：服務(wù)端異常：' + error.message );  }else{    console.log( 'close回調(diào)：服務(wù)端正常關(guān)閉' );  }      });

輸出為：

close事件：服務(wù)端關(guān)閉
close回調(diào)：服務(wù)端異常：Not running

server.ref()/server.unref()

了解node事件循環(huán)的同學(xué)對(duì)這兩個(gè)API應(yīng)該不陌生，主要用于將server 加入事件循環(huán)/從事件循環(huán)里面剔除，影響就在于會(huì)不會(huì)影響進(jìn)程的退出。

對(duì)出學(xué)習(xí)net的同學(xué)來(lái)說(shuō)，并不需要特別關(guān)注，感興趣的自己做下實(shí)驗(yàn)就好。

事件 listening/connection/close/error

• listening：調(diào)用 server.listen()，正式開(kāi)始監(jiān)聽(tīng)請(qǐng)求的時(shí)候觸發(fā)。
• connection：當(dāng)有新的請(qǐng)求進(jìn)來(lái)時(shí)觸發(fā)，參數(shù)為請(qǐng)求相關(guān)的 socket。
• close：服務(wù)端關(guān)閉的時(shí)候觸發(fā)。
• error：服務(wù)出錯(cuò)的時(shí)候觸發(fā)，比如監(jiān)聽(tīng)了已經(jīng)被占用的端口。
  

幾個(gè)事件都比較簡(jiǎn)單，這里僅舉個(gè) connection 的例子。

從測(cè)試結(jié)果可以看出，有新的客戶端連接產(chǎn)生時(shí)，net.createServer(callback) 中的callback回調(diào) 會(huì)被調(diào)用，同時(shí) connection 事件注冊(cè)的回調(diào)函數(shù)也會(huì)被調(diào)用。

事實(shí)上，net.createServer(callback) 中的 callback 在node內(nèi)部實(shí)現(xiàn)中 也是加入了做為 connection事件 的監(jiān)聽(tīng)函數(shù)。感興趣的可以看下node的源碼。

var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';var noop = function(){};// tcp服務(wù)端var server = net.createServer(function(socket){  socket.write('1. connection 觸發(fā)/n');});server.on('connection', function(socket){  socket.end('2. connection 觸發(fā)/n');});server.listen(PORT, HOST);

通過(guò)下面命令測(cè)試下效果

curl http://127.0.0.1:3000

輸出：

1. connection 觸發(fā)
2. connection 觸發(fā)

客戶端 net.Socket

在文章開(kāi)頭已經(jīng)舉過(guò)客戶端的例子，這里再把例子貼一下。(備注：嚴(yán)格來(lái)說(shuō)不應(yīng)該把 net.Socket 叫做客戶端，這里方便講解而已)

單從node官方文檔來(lái)看的話，感覺(jué) net.Socket 比 net.Server 要復(fù)雜很多，有更多的API、事件、屬性。但實(shí)際上，把 net.Socket 相關(guān)的API、事件、屬性 進(jìn)行歸類(lèi)下，會(huì)發(fā)現(xiàn)，其實(shí)也不是特別復(fù)雜。

具體請(qǐng)看下一小節(jié)內(nèi)容。

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('客戶端：已經(jīng)與服務(wù)端建立連接');});client.on('data', function(data){  console.log('客戶端：收到服務(wù)端數(shù)據(jù)，內(nèi)容為{'+ data +'}');});client.on('close', function(data){  console.log('客戶端：連接斷開(kāi)');});client.end('你好，我是客戶端');

API、屬性歸類(lèi)

以下對(duì)net.Socket的API跟屬性，按照用途進(jìn)行了大致的分類(lèi)，方便讀者更好的理解。大部分API跟屬性都比較簡(jiǎn)單，看下文檔就知道做什么的，這里就先不展開(kāi)。

連接相關(guān)

• socket.connect()：有3種不同的參數(shù)，用于不同的場(chǎng)景；
• socket.setTimeout()：用來(lái)進(jìn)行連接超時(shí)設(shè)置。
• socket.setKeepAlive()：用來(lái)設(shè)置長(zhǎng)連接。
• socket.destroy(）、socket.destroyed：當(dāng)錯(cuò)誤發(fā)生時(shí)，用來(lái)銷(xiāo)毀socket，確保這個(gè)socket上不會(huì)再有其他的IO操作。

數(shù)據(jù)讀、寫(xiě)相關(guān)

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

數(shù)據(jù)屬性相關(guān)

socket.bufferSize、socket.bytesRead、socket.bytesWritten

事件循環(huán)相關(guān)

socket.ref()、socket.unref()

地址相關(guān)

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

事件簡(jiǎn)介

• data：當(dāng)收到另一側(cè)傳來(lái)的數(shù)據(jù)時(shí)觸發(fā)。
• connect：當(dāng)連接建立時(shí)觸發(fā)。
• close：連接斷開(kāi)時(shí)觸發(fā)。如果是因?yàn)閭鬏斿e(cuò)誤導(dǎo)致的連接斷開(kāi)，則參數(shù)為error。
• end：當(dāng)連接另一側(cè)發(fā)送了 FIN 包的時(shí)候觸發(fā)（讀者可以回顧下HTTP如何斷開(kāi)連接的）。默認(rèn)情況下（allowHalfOpen == false），socket會(huì)完成自我銷(xiāo)毀操作。但你也可以把 allowHalfOpen 設(shè)置為 true，這樣就可以繼續(xù)往socket里寫(xiě)數(shù)據(jù)。當(dāng)然，最后你需要手動(dòng)調(diào)用 socket.end()
• error：當(dāng)有錯(cuò)誤發(fā)生時(shí)，就會(huì)觸發(fā)，參數(shù)為error。（官方文檔基本一句話帶過(guò)，不過(guò)考慮到出錯(cuò)的可能太多，也可以理解）
• timeout：提示用戶，socket 已經(jīng)超時(shí)，需要手動(dòng)關(guān)閉連接。
• drain：當(dāng)寫(xiě)緩存空了的時(shí)候觸發(fā)。（不是很好描述，具體可以看下stream的介紹）
• lookup：域名解析完成時(shí)觸發(fā)。
  

相關(guān)鏈接

官方文檔：https://nodejs.org/api/net.html#net_socket_destroy_exception

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持武林網(wǎng)。