神刀安全网

Node.js(Express4.x)搭建聊天室1——基本框架

0.目标

不得不说,用Node.js搭建一个即时的聊天室是一件很cool的事情。今天就使用socket.io来搭建一个简易的聊天室。

我把搭建聊天室的步骤分成了几个部分,请按顺序阅读:

获取代码
Node.js(Express4.x)搭建聊天室1——基本框架
Node.js(Express4.x)搭建聊天室2——消息发送与监听
Node.js(Express4.x)搭建聊天室3——完善网页


1.部署

1.1 部署Express

如果不知道如何部署,可参照: 部署Express


1.2 服务端安装socket.io

npm install socket.io –save


2.服务端

2.1 创建一个socket.io模块

我不打算按照socket.io官网的介绍那样,把socket.io写在app.js(Express3.x)或者bin/www(Express4.x)里面。因为如果这样做了,总感觉修改一点代码就得把整个应用的入口文件给改了;在我看来,入口文件就应该加载各个模块等,而不是处理某些具体的事务;并且这样做也不利于代码的模块化。

因此,参考了Mike Cantlon, Marc Harter, T.J.Holowaychuk, Nathan Rajlich所著的《Node.js实战》一书,我把这部分代码分离出来,仅在app.js(Express3.x)或者bin/www(Express4.x)文件中加载这个模块。

在根目录下创建一个文件夹model,并在文件夹中新建一个文件:chatroom.js。代码如下:

/**  * @Name    :  chatroom.js  * @Module  :  Socket.io Module  * @Author  :  Linxiaozhou  * @Date    :  2016.09.20  * @Ref1    :  Node.js in Action (Mike Cantlon, Marc Harter, T.J.Holowaychuk, Nathan Rajlich)  * @Ref2    :  http://socket.io/docs/  * @Ref3    :  https://github.com/socketio/socket.io/blob/master/examples/chat/index.js  * @Brief   :  Process chatroom through socket.io  */  var socketio = require('socket.io'); var io; var guest_num = 0;  // 外部接口 exports.listen = function(server) {      io = socketio(server);      io.on('connection', function (socket) {       var addedUser = false;         /* *************** 用户emit消息"join"时,响应 *************** */       socket.on('join', function (username) {         if (addedUser) return;          // 用户信息存储在socket会话中         socket.username = username;         ++guest_num;         addedUser = true;          // 告知用户登录成功         socket.emit('login', {             username: socket.username,             numUsers: guest_num         });          // 广播告知所有用户         socket.broadcast.emit('user_joined', {             username: socket.username,             msg: "欢迎 "+socket.username + " 进入聊天室",             type: "BROADCAST",             numUsers: guest_num         });       });         /* *************** 用户离开 *************** */       socket.on('disconnect', function () {         if (addedUser) {           --guest_num;            // 告知所有用户           socket.broadcast.emit('user_left', {             username: socket.username,             msg: socket.username + "离开了聊天室!",             type: "BROADCAST",             numUsers: guest_num           });         }       });         /* *************** 更多 *************** */       // 在这里添加更多监听的消息       // ...       });  };

这部分代码可供外部调用,需要传入http模块的server信息。这部分代码实现了这些功能:

  • 当客户端发送(emit)出“join”消息时,服务器会把随此消息发来的username存入socket会话中,并增加当前聊天室的总人数guest_num,然后发送消息“login”告知该用户登录成功,并广播消息“user_joined”告知所有用户。
  • 当用户离开聊天室,服务器会向所有的用户发出广播消息“user_left”。

更多功能会在后续添加。


2.2 在入口文件引入chatroom模块

前面说过,为了分离chatroom模块,我们在model文件夹下新建了一个chatroom.js文件来存放相关模型代码。然后需要在app.js(Express3.x)或者bin/www(Express4.x)文件中加载这个模块。我使用的是Express4.x,所以要在bin/www文件中添加如下代码:

// 在var server = http.createServer(app);代码后面添加!  /**  * Socket.io for chatroom  */ var chatroom = require('../model/chatroom'); chatroom.listen(server);

3.客户端

打开views/index.jade,替换成下面的代码:

doctype html html     head         title= title         link(rel='stylesheet', href='/stylesheets/style.css')     body         h1 socket.io聊天室         p#status      // 加载socket.io模块     script(src='https://cdn.socket.io/socket.io-1.4.5.js')      script.         //启动         var socket = io.connect('http://127.0.0.1:3000');          //发送消息         socket.emit('join', "Mike", function (data) {             console.log(data);         });          //监听         socket.on('login', function (data) {             console.log(data);         });          socket.on('user_joined', function (data) {             console.log(data);         });          socket.on('user_left', function (data) {             console.log(data);         });          // 更多         // 添加更多的消息发送或监听         // ...

注意到我们在发射消息的时候(socket.emit('join', "Mike", function (data) {});),除了“join”消息,还传入了一个参数“Mike”;查看服务端代码可知,这个会被当作用户的昵称(socket.on('join', function (username) {});)。

由此可以延展一下:在调用io.connect('http://127.0.0.1:3000');创建连接之前是不是可以先让用户输入昵称,然后再发送加入的消息socket.emit('join', "<用户输入的昵称>", function (data) {});?这也是为什么我们看到很多Demo都会要我们先输入nickname的原因吧。


4.测试

4.1 加入

至此,我们完成了服务端的部署以及客户端的提供,可以开始测试了。

开启服务,打开一个浏览器A,访问http://127.0.0.1:3000, 打开另一个浏览器B,也访问http://127.0.0.1:3000, 按F12查看打印即可。

Node.js(Express4.x)搭建聊天室1——基本框架
测试

浏览器A是先打开的,可以看到有两个消息,第一个是告知该用户登录成功的消息,第二个是浏览器B加入后广播的消息,告知浏览器A的用户有新用户加入了。


4.2 离开

我们关闭浏览器B,此时浏览器A打开消息”Mike离开了聊天室!”。

Node.js(Express4.x)搭建聊天室1——基本框架
浏览器B用户离开


5.更多

聊天室功能自然是要发消息的,所以接下来,还要允许用户发消息、接收消息。这些内容我不准备在这一节来说明,因为聊天室的框架已经搭好了!要更进一步,请看下面几节:

Node.js(Express4.x)搭建聊天室2——消息发送与监听
Node.js(Express4.x)搭建聊天室3——完善网页


原创文章,未经许可,请勿转载
作者:Mike的读书季
日期:2016.09.20
QQ:1139904786
Blog:http://blog.csdn.net/kkdestiny

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » Node.js(Express4.x)搭建聊天室1——基本框架

分享到:更多 ()

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址