【nodejs原理&源码赏析(5)】net模块与通讯的实现
示例代码托管在:http://www.github.com/dashnowords/blogs
博客园地址:
华为云社区地址:
一. net模块简介
net
模块是nodejs
通讯功能实现的基础,nodejs
中最常用的功能就是作为webserver使用,建立服务器时使用的http.createserver
就是在net.createserver
方法的基础上建立的。前端最熟悉的http
协议属于应用层协议,应用层的内容想要发送出去,还需要将消息逐层下发,通过传输层(tcp
,udp
),网际层(ip
)和更底层的网络接口后才能被传输出去。net
模块就是对分层通讯模型的实现。
net
模块中有两大主要抽象概念——net.server
和net.socket
。《deep-into-node》一书中对socket
概念进行了解释:
socket 是对 tcp/ip 协议族的一种封装,是应用层与tcp/ip协议族通信的中间软件抽象层。它把复杂的tcp/ip协议族隐藏在socket接口后面,对用户来说,一组简单的接口就是全部,让socket去组织数据,以符合指定的协议。
socket 还可以认为是一种网络间不同计算机上的进程通信的一种方法,利用三元组(ip地址,协议,端口)就可以唯一标识网络中的进程,网络中的进程通信可以利用这个标志与其它进程进行交互。
简单地说,net.server
实例可以监听一个端口(用于实现客户端tcp
连接通讯)或者地址(用于实现ipc
跨进程通讯),net.socket
实例可以建立一个套接字实例,它可以用来和server
建立连接,连接建立后,就可以实现通讯了。你可以将socket
想象成手机,把server
想象成基站,虽然不是很贴切,但可以降低理解难度。net
相关api可以直接查看中文文档。
二. client-server的通讯
2.1 server的建立
server
类的定义非常精简,也很容易看懂:
可以看到构造函数基本上只是初始化了一些属性,然后添加了对connection
事件的响应。服务器是net.server
类的实例,通过net.createserver([options][,onconnection] )
方法建立,如果传入一个函数,则这个函数会作为connection
事件的回调函数,当一个socket
实例连接到server
时,connection
事件就会触发,回调函数中的形参就指向了发起连接的socket
实例。server
实例并不能独立工作,作为网络服务器使用时需要需要调用listen
方法来监听一个地址,示例如下:
const net = require('net'); const { stringdecoder } = require('string_decoder'); let decoder = new stringdecoder('utf8'); let server = net.createserver(socket=>{ console.log('接收连接'); socket.on('data',data=>{ console.log('收到来自客户端的消息:',decoder.write(data)); }); socket.on('end',function(){ console.log('socket从客户端被关闭了'); }); }); server.listen(12315);
socket上以流的形式发送数据,所以需要调用string_decoder
模块进行解码才能够看到内容,否则看到的就是原始的字节信息。上面的实例监听了12315端口。
2.2 socket的建立
前文已经提及socket
是对tcp/ip
协议族的一种封装。客户端通讯套接字是net.socket
的实例,通过调用实例方法socket.connect(args)
来和服务器建立连接,作为客户端通讯套接字时需要监听端口号,建立连接后,客户端server
通过connection
事件的回调函数就可以拿到发起连接的socket
实例,这样客户端和服务器就可以通讯了,其中一方通过socket.write()
方法写入数据,另一方注册的监听器socket.on('data',ondata)
回调函数就会收到信息。socket
实例化示例如下:
const net = require('net'); let socket = new net.socket(); socket.connect(12315); //连接服务器 socket.on('connect',c=>{ console.log('成功建立和12315的连接') settimeout(()=>{ console.log('建立连接1s后发送消息'); socket.write('sn:1231512315','utf8',function(){ console.log('消息已发送'); }); },1000); }); socket.on('data',function(resp){ console.log('收到服务器返回消息:',resp); }); socket.on('end',function(){ console.log('socket从客户端被关闭了'); })
客户端connect
连接服务器的动作,就好比打电话前要先拨号一样,等接通以后,你说的话(也就是socket.write( )
写入的data)才能被发送过去。【代码仓的示例demo】中提供了相对完整的示例,分别放在server.js
和client.js
中,你可以通过控制台打印的信息来观察每条语句执行的先后顺序,熟悉从通信建立到消息收到再到服务器关闭的整个过程,记得要先起服务器,后起客户端。
tips:你可以使用postman向这个server发一个get请求,看看是什么样子,对理解
http
和tcp/ip
的关系有很大帮助,它非常直观,反正我是第一次见。
三. ipc通讯
ipc
通讯是指inter process communication,也就是跨进程通讯,上一节在提到cluster
时已经介绍过进程之间是资源隔离的,所以跨进程通讯也需要通过net
模块来建立消息管道。它的用法比较简单,只需要将server.listen( )
和socket.connect( )
的参数从端口号换成地址字符串就可以了。示例代码如下:
const net = require('net'); const cluster = require('cluster'); const path = require('path'); const { stringdecoder } = require('string_decoder'); let serverforipc;//作为子进程的server if (cluster.ismaster) { //主进程执行逻辑 setupmaster(); cluster.fork();//生成子进程 cluster.fork();//生成另一个子进程 } else { //子进程执行逻辑 setupworker(); } //主进程逻辑 function setupmaster() { //作为server监听子进程消息 let decoder = new stringdecoder('utf8'); //windows系统中要求的ipc通讯命名规则 let ipcpath = path.join('\\\\?\\pipe', process.cwd(), 'dashipc'); serverforipc = net.createserver(socket=>{ console.log(`[master]:子进程通过ipcserver连接到主进程`); socket.on('data',data=>{ console.log('[master]:收到来自子进程的消息:',decoder.write(data)); }); }); //ipc-server端监听指定地址 serverforipc.listen(ipcpath); } //子进程逻辑 function setupworker() { let ipcpath = path.join('\\\\?\\pipe', process.cwd(), 'dashipc'); let socket = new net.socket(); //子进程的socket连接主进程中监听的地址 socket.connect(ipcpath,c=>{ console.log(`[child-${process.pid}]:pid为${process.pid}的子进程已经连接到主进程`); //过一秒后发个消息测试一下 settimeout(()=>{ socket.write(`${process.pid}的消息:sn1231512315`,'utf8',function(){ console.log(`[child-${process.pid}]:消息已发送`); }); },1000); }); }
需要注意尽管主进程和子进程运行的是同样的脚本,但执行的具体逻辑由cluster.ismaster
进行了区分。当主进程的脚本运行时会建立一个ipc
通讯管道的server
端并监听指定地址,然后通过cluster.fork
生成子进程,子进程会执行setupworker( )
方法的逻辑,新建一个socket
实例并连接主进程监听的地址,这样跨进程通讯就建立了。示例代码放置在代码仓中的ipc.js
中,运行结果如下:
四. 撸一个简易的cluster通讯模型
既然客户端通讯和跨进程通讯都实现了,那么把它们连起来协调好,其实就可以复现cluster
集群模块的功能了,虽然它不能等同于cluster
的源码,cluster中跨进程通讯是直接可以使用的,不需要自己手动建立,但“造*”对于理解集群通讯机制非常有帮助。简易模型的基本方案如下,逻辑的顺序已经标记出来了,在前文的基础上实际上增加的只是调度相关的功能(也就是橙色背景的部分):
首先主线程和子线程之间建立ipc通讯,连接建立后,由子进程将自己的pid通过socket发给主进程,这样主进程就知道连接到ipcserver的socket是哪个子进程连过来的了,demo在内部构建了一个type
属性为internal_init
的消息来完成这个登记动作,然后启动一个接收客户端连接的server,监听指定的端口。接下来到了第6步,客户端新建了socket连接到了主线程client server监听的端口,clientserver把它发过来的socket
传给调度中心,调度中心根据一定规则(demo中直接就简单粗暴地轮换使用各个线程)决定将这个socket与哪个worker socket相匹配(所谓匹配就是指client socket发来的消息应该调用哪个worker socket的write
方法来分发给对应的子进程),然后将这个客户端socket登记到匹配记录表中某条记录的client socket上,这样通讯通道就建立好了。
当客户端调用socket.write
来写入数据时,主线程就会收到这个数据,然后根据已经建立好的socket关系把这条消息write到子进程,子进程处理完后在消息体中增加一个pid
属性标明这个消息是哪个进程处理的(这个标记也可以在主进程中添加,因为主进程中维护的有pid
,client socket
和worker socket
的对应关系),然后调用socket.write
发回给主进程,主进程根据消息的pid
属性在记录表中找到这个消息应该由哪个client socket来返回,找到后调用它的end
方法将数据返回给客户端,这样就完成了一次请求分发。
demo中提供了示例,ipc_http.js
是简易集群模型的服务端,ipc_http_client.js
是客户端,前后一共发送了3次请求,结果如下:
服务端的日志:
客户端的请求:
上面的示例仅仅是为了帮助理解网络通信和跨进程通信协作的原理,并不代表cluster
的源码,但通信层面的原理是类似的,实际开发中跨进程通讯时不需要自己再构建ipc消息通道,因为子进程返回的process
上就已经集成了跨进程通讯能力,理解这个简化的模型对阅读cluster
模块的通讯原理能够提供很好的过渡。