采用Node.js+Socket.IO搭建WebSocket实时应用

Web领域的实时推送技术,也被称作Realtime技术。这种技术要达成的目标是让用户不需要刷新浏览器就可以收获实时更新。它兼具广泛的拔取场景,比如在线聊天室、在线客服系统、评论系统、WebIM等。

WebSocket简介

谈到Web实时推送,就不得不说WebSocket。在WebSocket现身此前,很多网站为了促成实时推送技术,通常接纳的方案是轮询(Polling)和Comet技术,Comet又可划分为三种实现格局,一种是长轮询机制,一种叫做流技术,这两种方法实际是对轮询技术的改革,这多少个方案带来很显然的缺点,需要由浏览器对服务器发出HTTP
request,大量消耗服务器带宽和资源。面对这种情形,HTML5定义了WebSocket协议,能更好的节约服务器资源和带宽并贯彻真正含义上的实时推送。

WebSocket商谈本质上是一个基于TCP的协商,它由通信协议和编程API组成,WebSocket可以在浏览器和服务器之间建立双向连接,以基于事件的主意,赋予浏览器实时通信能力。既然是双向通信,就代表服务器端和客户端可以同时发送并响应请求,而不再像HTTP的呼吁和响应。

为了建立一个WebSocket连接,客户端浏览器首先要向服务器发起一个HTTP请求,那一个请求和一般性的HTTP请求例外,包含了一些附加头信息,其中附加头信息”Upgrade:
WebSocket”阐明这是一个申请协议升级的HTTP请求,服务器端解析那一个附加的头音信然后发生应答信息重临给客户端,客户端和劳动器端的WebSocket连接就创建起来了,双方就可以透过这几个连续通道自由的传递信息,并且这些连续会随地存在直到客户端如故服务器端的某一方主动的闭馆连接。

一个名列三甲WebSocket客户端请求头:

图片 1

面前讲到WebSocket是HTML5中新增的一种通信协议,这意味部分老版本浏览器(重假设IE10以下版本)并不抱有这一个职能,
经过百度总结的掌握数量体现,IE8目前仍以33%的市场份额占据第一名,好在chrome浏览器市场份额逐年上升,现在以超越26%的市场份额位居第二,同时微软多年来发布截止对IE6的技术协理并指示用户更新到新本子浏览器,这多少个早已让广大前端工程师为之胸闷的浏览器有望退出历史舞台,再添加几乎所有的智能手机浏览器都襄助HTML5,所以使得WebSocket的实战意义大增,然而无论咋样,我们其实的品类中,如故要考虑低版本浏览器的匹配方案:在补助WebSocket的浏览器中选取新技巧,而在不帮忙WebSocket的浏览器里启用Comet来收取发送音讯。

WebSocket实战

正文将以多少人在线聊天应用作为实例场景,我们先来规定那么些聊天应用的着力要求。

需要分析

1、兼容不匡助WebSocket的低版本浏览器。
2、允许客户端有同一的用户名。
3、进入聊天室后可以观察眼前在线的用户和在线人数。
4、用户上线或剥离,所有在线的客户端应该实时更新。
5、用户发送消息,所有客户端实时吸收。

在其实的支付过程中,为了采取WebSocket接口构建Web应用,我们先是需要构建一个实现了
WebSocket规范的服务端,服务端的兑现不受平台和支付语言的限量,只需要听从WebSocket规范即可,近日早已面世了有的相比成熟的WebSocket服务端实现,比如本文使用的Node.js+Socket.IO。为何采纳这多少个方案吧?先来大概介绍下他们两。

Node.js

Node.js接纳C++语言编写而成,它不是Javascript应用,而是一个Javascript的运转环境,据Node.js创办者RyanDahl记念,他最初梦想拔取Ruby来写Node.js,但是后来发现Ruby虚拟机的属性不可以满意他的渴求,后来他尝试采纳V8引擎,所以拔取了C++语言。

Node.js辅助的体系包括*nux、Windows,这表示程序员可以编制系统级或者服务器端的Javascript代码,交给Node.js来解释施行。Node.js的Web开发框架Express,能够扶持程序员连忙建立web站点,从二零零六年出生至今,Node.js的成材的快慢显然,其发展前景得到了技能社区的充裕肯定。

Socket.IO

Socket.IO是一个开源的WebSocket库,它经过Node.js实现WebSocket服务端,同时也提供客户端JS库。Socket.IO援助以事件为根基的实时双向通讯,它可以干活在其它平台、浏览器或挪动设备。

Socket.IO补助4种协议:WebSocket、htmlfile、xhr-polling、jsonp-polling,它会活动按照浏览器采取切合的报导情势,从而让开发者可以聚焦到效能的兑现而不是平台的兼容性,同时Socket.IO具有正确的安定团结和特性。

编码实现

先上演示效果图:

图片 2

可以点击这里翻看在线演示。整个开发过程非凡简单,下边简单记录了付出步骤:

安装Node.js

基于自己的操作系统,去Node.js官网下载安装即可。假设成功安装。在命令行输入node -vnpm -v应当能见到相应的版本号。

<pre>
node -v
v0.10.26
npm -v
1.4.6
</pre>

搭建WebSocket服务端

其一环节大家尽量的考虑实际生产环境,把WebSocket后端服务搭建成一个线上得以用域名访问的服务,即便您是在地点开发环境,可以换资金地ip地址,或者使用一个虚拟域名指向当地ip。

先进入到您的工作目录,比如
/workspace/wwwroot/plhwin/realtime.plhwin.com,新建一个名为
package.json的文本,内容如下:
<pre>
{
“name”: “realtime-server”,
“version”: “0.0.1”,
“description”: “my first realtime server”,
“dependencies”: {}
}
</pre>

接下去使用npm一声令下安装expresssocket.io
<pre>
npm install –save express
npm install –save socket.io
</pre>
安装成功后,应该可以见到工作目录下生成了一个名为node_modules的文书夹,里面分别是expresssocket.io,接下去可以开首编制伏务端的代码了,新建一个文件:index.js

<pre>
var app = require(‘express’)();
var http = require(‘http’).Server(app);
var io = require(‘socket.io’)(http);

app.get(‘/’, function(req, res){
res.send(‘<h1>Welcome Realtime Server</h1>’);
});

http.listen(3000, function(){
console.log(‘listening on *:3000’);
});
</pre>

命令行运行node index.js,假如一切顺利,你应有会面到重临的listening on *:3000字样,这阐明服务一度打响搭建了。此时浏览器中打开http://localhost:3000有道是可以见见正常的欢迎页面。

若果你想要让服务运作在线上服务器,并且可以由此域名访问的话,可以运用Nginx做代办,再nginx.conf中添加如下配置,然后将域名(比如:realtime.plhwin.com)解析到服务器IP即可。
<pre>
server
{
listen 80;
server_name realtime.plhwin.com;
location / {
proxy_pass http://127.0.0.1:3000;
}
}
</pre>

完了以上步骤,http://realtime.plhwin.com:3000的后端服务就不乏先例搭建了。

图片 3

服务端代码实现

面前讲到的index.js运行在服务端,往日的代码只是一个简易的WebServer欢迎内容,让我们把WebSocket服务端完整的实现代码参预进来,整个服务端就足以处理客户端的请求了。完整的index.js代码如下:

<pre>
var app = require(‘express’)();
var http = require(‘http’).Server(app);
var io = require(‘socket.io’)(http);

app.get(‘/’, function(req, res){
res.send(‘<h1>Welcome Realtime Server</h1>’);
});

//在线用户
var onlineUsers = {};
//当前在线人数
var onlineCount = 0;

io.on(‘connection’, function(socket){
console.log(‘a user connected’);

//监听新用户加入
socket.on('login', function(obj){
    //将新加入用户的唯一标识当作socket的名称,后面退出的时候会用到
    socket.name = obj.userid;

    //检查在线列表,如果不在里面就加入
    if(!onlineUsers.hasOwnProperty(obj.userid)) {
        onlineUsers[obj.userid] = obj.username;
        //在线人数+1
        onlineCount++;
    }

    //向所有客户端广播用户加入
    io.emit('login', {onlineUsers:onlineUsers, onlineCount:onlineCount, user:obj});
    console.log(obj.username+'加入了聊天室');
});

//监听用户退出
socket.on('disconnect', function(){
    //将退出的用户从在线列表中删除
    if(onlineUsers.hasOwnProperty(socket.name)) {
        //退出用户的信息
        var obj = {userid:socket.name, username:onlineUsers[socket.name]};

        //删除
        delete onlineUsers[socket.name];
        //在线人数-1
        onlineCount--;

        //向所有客户端广播用户退出
        io.emit('logout', {onlineUsers:onlineUsers, onlineCount:onlineCount, user:obj});
        console.log(obj.username+'退出了聊天室');
    }
});

//监听用户发布聊天内容
socket.on('message', function(obj){
    //向所有客户端广播发布的消息
    io.emit('message', obj);
    console.log(obj.username+'说:'+obj.content);
});

});

http.listen(3000, function(){
console.log(‘listening on *:3000’);
});
</pre>

客户端代码实现

进入客户端工作目录/workspace/wwwroot/plhwin/demo.plhwin.com/chat,新建一个index.html:

<!DOCTYPE html>
<html>
<head>
<meta charset=”utf-8″>
<meta name=”format-detection” content=”telephone=no”/>
<meta name=”format-detection” content=”email=no”/>
<meta content=”width=device-width, initial-scale=1.0,
maximum-scale=1.0, minimum-scale=1.0, user-scalable=0″
name=”viewport”>
<title>六个人聊天室</title>
<link rel="stylesheet" type="text/css" href="./style.css" />

<script src="http://realtime.plhwin.com:3000/socket.io/socket.io.js"></script>
</head>
<body>

请先输入你在聊天室的昵称


<script type="text/javascript" src="./client.js"></script>

</html>

地点的html内容我没有怎么好说的,大家重要看看其中的4个文本请求:

1、realtime.plhwin.com:3000/socket.io/socket.io.js
2、style.css
3、json3.min.js
4、client.js

第1个JS是Socket.IO提供的客户端JS文件,在头里安装服务端的步调中,当npm安装完socket.io并搭建起WebServer后,这多少个JS文件就可以正常访问了。

第2个style.css文件没什么好说的,就是体制文件而已。

第3个JS只在IE8以下版本的IE浏览器中加载,目标是让这个低版本的IE浏览器也能处理json,这是一个开源的JS,详见:http://bestiejs.github.io/json3/

第4个client.js是完好的客户端的业务逻辑实现代码,它的始末如下:

<pre>
(function () {
var d = document,
w = window,
p = parseInt,
dd = d.documentElement,
db = d.body,
dc = d.compatMode == ‘CSS1Compat’,
dx = dc ? dd: db,
ec = encodeURIComponent;

w.CHAT = {
    msgObj:d.getElementById("message"),
    screenheight:w.innerHeight ? w.innerHeight : dx.clientHeight,
    username:null,
    userid:null,
    socket:null,
    //让浏览器滚动条保持在最低部
    scrollToBottom:function(){
        w.scrollTo(0, this.msgObj.clientHeight);
    },
    //退出,本例只是一个简单的刷新
    logout:function(){
        //this.socket.disconnect();
        location.reload();
    },
    //提交聊天消息内容
    submit:function(){
        var content = d.getElementById("content").value;
        if(content != ''){
            var obj = {
                userid: this.userid,
                username: this.username,
                content: content
            };
            this.socket.emit('message', obj);
            d.getElementById("content").value = '';
        }
        return false;
    },
    genUid:function(){
        return new Date().getTime()+""+Math.floor(Math.random()*899+100);
    },
    //更新系统消息,本例中在用户加入、退出的时候调用
    updateSysMsg:function(o, action){
        //当前在线用户列表
        var onlineUsers = o.onlineUsers;
        //当前在线人数
        var onlineCount = o.onlineCount;
        //新加入用户的信息
        var user = o.user;

        //更新在线人数
        var userhtml = '';
        var separator = '';
        for(key in onlineUsers) {
            if(onlineUsers.hasOwnProperty(key)){
                userhtml += separator+onlineUsers[key];
                separator = '、';
            }
        }
        d.getElementById("onlinecount").innerHTML = '当前共有 '+onlineCount+' 人在线,在线列表:'+userhtml;

        //添加系统消息
        var html = '';
        html += '<div class="msg-system">';
        html += user.username;
        html += (action == 'login') ? ' 加入了聊天室' : ' 退出了聊天室';
        html += '</div>';
        var section = d.createElement('section');
        section.className = 'system J-mjrlinkWrap J-cutMsg';
        section.innerHTML = html;
        this.msgObj.appendChild(section);   
        this.scrollToBottom();
    },
    //第一个界面用户提交用户名
    usernameSubmit:function(){
        var username = d.getElementById("username").value;
        if(username != ""){
            d.getElementById("username").value = '';
            d.getElementById("loginbox").style.display = 'none';
            d.getElementById("chatbox").style.display = 'block';
            this.init(username);
        }
        return false;
    },
    init:function(username){
        //客户端根据时间和随机数生成uid,这样使得聊天室用户名称可以重复。实际项目中,如果是需要用户登录,那么直接采用用户的uid来做标识就可以
        this.userid = this.genUid();
        this.username = username;

        d.getElementById("showusername").innerHTML = this.username;
        this.msgObj.style.minHeight = (this.screenheight - db.clientHeight + this.msgObj.clientHeight) + "px";
        this.scrollToBottom();

        //连接websocket后端服务器
        this.socket = io.connect('ws://realtime.plhwin.com:3000');

        //告诉服务器端有用户登录
        this.socket.emit('login', {userid:this.userid, username:this.username});

        //监听新用户登录
        this.socket.on('login', function(o){
            CHAT.updateSysMsg(o, 'login');  
        });

        //监听用户退出
        this.socket.on('logout', function(o){
            CHAT.updateSysMsg(o, 'logout');
        });

        //监听消息发送
        this.socket.on('message', function(obj){
            var isme = (obj.userid == CHAT.userid) ? true : false;
            var contentDiv = '<div>'+obj.content+'</div>';
            var usernameDiv = ''+obj.username+'';

            var section = d.createElement('section');
            if(isme){
                section.className = 'user';
                section.innerHTML = contentDiv + usernameDiv;
            } else {
                section.className = 'service';
                section.innerHTML = usernameDiv + contentDiv;
            }
            CHAT.msgObj.appendChild(section);
            CHAT.scrollToBottom();  
        });

    }
};
//通过“回车”提交用户名
d.getElementById("username").onkeydown = function(e) {
    e = e || event;
    if (e.keyCode === 13) {
        CHAT.usernameSubmit();
    }
};
//通过“回车”提交信息
d.getElementById("content").onkeydown = function(e) {
    e = e || event;
    if (e.keyCode === 13) {
        CHAT.submit();
    }
};

})();
</pre>

时至前几日所有的编码开发工作方方面面形成了,在浏览器中打开http://demo.plhwin.com/chat/就足以见到效果了,后续我会把演示代码提交到Github上。

本例只是一个简约的Demo,留下2个有关项目扩充的思索:

1、假诺是一个在线客服系统,里面有成千上万的小卖部采取你的服务,每个商家温馨的用户可以通过一个隶属URL地址进入该铺面的聊天室,聊天是十分的,每个公司可以新建六个客服人员,每个客服人员可以同时和客户端的两个用户聊天。

2、又假如是一个在线WebIM系统,实现类似微信,qq的意义,客户端能够阅览好友在线状态,在线列表,添加好友,删除好友,新建群组等,新闻的出殡除了补助要旨的文字外,还可以帮忙表情、图片和文书。

有趣味的同学可以继续深远钻研。