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('你好,我是客戶端');
服務端:
服務端:開始監聽來自客戶端的請求
服務端:收到來自客戶端的請求
服務端:收到客戶端數據,內容為{你好,我是客戶端}
服務端:客戶端連接斷開
客戶端:
客戶端:已經與服務端建立連接 客戶端:收到服務端數據,內容為{你好,我是服務端} 客戶端:連接斷開
事件 listening/connection/close/error
-
listening:調用 server.listen(),正式開始監聽請求的時候觸發。
-
connection:當有新的請求進來時觸發,參數為請求相關的 socket。
-
close:服務端關閉的時候觸發。
-
error:服務出錯的時候觸發,比如監聽了已經被占用的端口。
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:域名解析完成時觸發。
摘自:
Nodejs進階:核心模塊net入門與實例講解
Nodejs進階:核心模塊https 之 如何優雅的訪問12306