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:域名解析完成时触发。
摘自: