这篇文章将通过开发一个简单聊天室的方式,介绍node.js的net模块。
一、第一版,只向客户端发送信息
我们先实现一个简单的版本,代码如下:
var net=require('net'); var chatServer=net.createServer(); chatServer.on('connection',function(client){ client.write('hi!\n'); client.write('bye!\n'); client.end(); }) chatServer.listen(9001);
代码讲解:
1.因为我们要使用tcp作为通信协议,node中tcp相关的类是放在net模块中的,所以我需要先引用net。
2.通过net.createServer()就为我们创建了一个tcp的服务器。
3.接下来使用on方法实现对connection事件的监听。每当有一个新的客户端连接到我们的tcp服务器的时候,都会触发connection对应的方法,向客户端输出‘hi!bye!’的文字 信息。然后通过client.end()关闭连接。
4.程序最后通过chatServer.listen(9001);实现对9001端口的监听。
运行服务器:
使用webstorm的调试工具运行我们的服务器。
运行客户端:
打开window的命令行工具,
输入如下命令:
telnet 127.0.0.1 9001
回车,输出如下结果:
note:
自己实践上面例子的时候遇到了点小状况,我最开始使用的是9000端口,运行的时候程序要报错。
events.js:66 throw arguments[1]; // Unhandled 'error' event ^ Error: listen EADDRINUSE at errnoException (net.js:769:11) at Server._listen2 (net.js:909:14) at listen (net.js:936:10) at Server.listen (net.js:985:5) at Object.<anonymous> (D:\workspace\nodejs\chatroom\chatServer.js:8:12) at Module._compile (module.js:449:26) at Object.Module._extensions..js (module.js:467:10) at Module.load (module.js:356:32) at Function.Module._load (module.js:312:12) at Module.runMain (module.js:492:10)
‘EADDRINUSE’这个东西让人很费解,完全不知道是什么意思,借助有道的翻译,意思是:错误地址使用。‘EADDRINUSE’应该是‘error address in use’的缩写。后来借助google找到了合理的解释,说是你监听的端口已经被使用了,我把端口换成了9001,一切正常。
当遇到异常的时候,不知道node有没有提供帮助的地方,光靠他提供的异常信息提示真是解决不了问题啊。或许最好的帮手就是google。
二、第二版,可以接收客户端信息:
代码如下:
var net=require('net'); var chatServer=net.createServer(); var clientList=[]; chatServer.on('connection',function(client){ client.write('hi!\n'); clientList.push(client); client.on('data',function(data){ for(var i= 0,len=clientList.length;i<len;i++){ if(client!=clientList[i]){ clientList[i].write(data); } } console.log(data); }); }) chatServer.listen(9001);
这版比第一版有两个变化点,一是增加了client的on方法,二是移出了client.end();方法。client的on方法添加data事件,这样客户端每次发送数据,服务器都可以接收到。移出client.end()是因为,如果我们关闭了链接,客户端再发送新数据,服务器就无法接收了。
我们来看运行结果,其中‘hello’是客户端输入信息,红线框住的是服务器端接收到的信息,注意它是二进制数据,需要我们做相应的处理才能转换成字符串,后面的课程会有介绍。
三、第三版,实现客户端和服务器端的相互通信:
在这里我们需要把每个客户端都放到一个数组变量里面缓存起来,遍历数组,使用client.write()方法对每个客户端做出反应。我们来看代码:
var net=require('net'); var chatServer=net.createServer(); var clientList=[]; chatServer.on('connection',function(client){ client.write('hi!\n'); clientList.push(client); client.on('data',function(data){ for(var i= 0,len=clientList.length;i<len;i++){ if(client!=clientList[i]){ clientList[i].write(data); } } console.log(data); }); }) chatServer.listen(9001);
我们创建了clientList来存放客户端连接,每当有新连接进来的时候,把client对象保存入数组。接下来,判断遍历到的client是否是当前client,不是的话输出data。
note:
这里大家注意‘len=clientList.length’部分,我们把clientList.length存入变量len,这样可以提高程序的性能。在 i<len 运算的时候,就不用每次再去取clientList.length了,大家可以在自己的程序里也使用这样的方式,特别是数组比较大的时候。
我们来看运行结果,要打开多个telnet链接,红色为输入信息,蓝色为输出信息:
四、最终版
我们增加了客户断开链接的 end 事件,在end事件和发送消息的过程中会清理不存在的客户端。
var net=require('net'); var chatServer=net.createServer(); var clientList=[]; chatServer.on('connection',function(client){ client.name=client.remoteAddress+':'+client.remotePort; broadcast('hi,'+ client.name +' join!\r\n',client); client.write('hi,'+ client.name +'!\r\n'); clientList.push(client); client.on('data',function(data){ broadcast(client.name+' say:'+ data+'\r\n',client); }); client.on('end',function(){ broadcast('hi,'+ client.name +' quit!\r\n',client); clientList.splice(clientList.indexOf(client),1); }); }) function broadcast(message, client) { var cleanup=[]; for(var i= 0,len=clientList.length;i<len;i++){ if(client!==clientList[i]){ if(clientList[i].writable){ clientList[i].write(message); }else{ cleanup.push(clientList[i]); clientList[i].destroy(); } } } for(var i= 0,len=cleanup.length;i<len;i++){ clientList.splice(clientList.indexOf(cleanup[i]),1); } } chatServer.listen(9001);
运行效果:
三个客户链接到服务器,其中一个向另外两个说‘hello’。
其中一个客户关闭链接:
今天的例子到此为止。