node.js中的Socket.IO使用实例


Posted in Javascript onNovember 04, 2014

1. 简介

首先是Socket.IO的官方网站:http://socket.io

官网非常简洁,甚至没有API文档,只有一个简单的“How to use”可以参考。因为Socket.IO就跟官网一样简洁好用易上手。

那么Socket.IO到底是什么呢?Socket.IO是一个WebSocket库,包括了客户端的js和服务器端的nodejs,它的目标是构建可以在不同浏览器和移动设备上使用的实时应用。它会自动根据浏览器从WebSocket、AJAX长轮询、Iframe流等等各种方式中选择最佳的方式来实现网络实时应用,非常方便和人性化,而且支持的浏览器最低达IE5.5,应该可以满足绝大部分需求了。

2. 安装部署

2.1 安装

首先安装非常简单,在node.js环境下只要一句:

npm install socket.io

2.2 结合express来构建服务器

express是一个小巧的Node.js的Web应用框架,在构建HTTP服务器时经常使用到,所以直接以Socket.IO和express为例子来讲解。

var express = require('express')

    , app = express()

    , server = require('http').createServer(app)

    , io = require('socket.io').listen(server);

server.listen(3001);

若不使用express,请参考socket.io/#how-to-use

3. 基本使用方法

主要分为服务器端和客户端两段代码,都非常简单。

Server(app.js):

//接上面的代码

app.get('/', function (req, res) {

    res.sendfile(__dirname + '/index.html');});
io.sockets.on('connection', function (socket) {

    socket.emit('news', { hello: 'world' });

    socket.on('other event', function (data) {

        console.log(data);

    });

});

首先io.sockets.on函数接受字符串"connection"作为客户端发起连接的事件,当连接成功后,调用带有socket参数的回调函数。我们在使用socket.IO的时候,基本上都在这个回调函数里面处理用户的请求。

socket最关键的是emit和on两个函数,前者提交(发出)一个事件(事件名称用字符串表示),事件名称可以自定义,也有一些默认的事件名称,紧接着是一个对象,表示向该socket发送的内容;后者接收一个事件(事件名称用字符串表示),紧接着是收到事件调用的回调函数,其中data是收到的数据。

在上面的例子中,我们发送了news事件和收到了other event事件,那么客户端应该会有对应的接收和发送事件。没错,客户端代码和服务器正好相反,而且非常相似。

Client(client.js)

<script src="/socket.io/socket.io.js"></script>

<script>

    var socket = io.connect('http://localhost');

    socket.on('news', function (data) {

        console.log(data);

        socket.emit('other event', { my: 'data' });

    });

</script>

有两点要注意的:socket.io.js路径要写对,这个js文件实际放在了服务器端的node_modules文件夹中,在请求这个文件时会重定向,因此不要诧异服务器端不存在这个文件但为什么还能正常工作。当然,你可以把服务器端的socket.io.js这个文件拷贝到本地,使它成为客户端的js文件,这样就不用每次都向Node服务器请求这个js文件,增强稳定性。第二点是要用var socket = io.connect('网站地址或ip');来获取socket对象,接着就可以使用socket来收发事件。关于事件处理,上面的代码表示收到“news”事件后,打印收到的数据,并向服务器发送“other event”事件。

注:内置默认的事件名例如“disconnect”表示客户端连接断开,“message”表示收到消息等等。自定义的事件名称,尽量不要跟Socket.IO中内置的默认事件名重名,以免造成不必要的麻烦。

4. 其他常用API

1).向所有客户端广播:socket.broadcast.emit('broadcast message');

2).进入一个房间(非常好用!相当于一个命名空间,可以对一个特定的房间广播而不影响在其他房间或不在房间的客户端):socket.join('your room name');

3).向一个房间广播消息(发送者收不到消息):socket.broadcast.to('your room name').emit('broadcast room message');

4).向一个房间广播消息(包括发送者都能收到消息)(这个API属于io.sockets):io.sockets.in('another room name').emit('broadcast room message');

5).强制使用WebSocket通信:(客户端)socket.send('hi'),(服务器)用socket.on('message', function(data){})来接收。

5. 使用Socket.IO构建一个聊天室

最后,我们通过一个简单的实例来结束本篇。用Socket.IO构建一个聊天室就是50行左右的代码的事情,实时聊天效果也非常好。以下贴出关键代码:

Server(socketChat.js)

//一个客户端连接的字典,当一个客户端连接到服务器时,

//会产生一个唯一的socketId,该字典保存socketId到用户信息(昵称等)的映射

var connectionList = {};
exports.startChat = function (io) {

    io.sockets.on('connection', function (socket) {

        //客户端连接时,保存socketId和用户名

        var socketId = socket.id;

        connectionList[socketId] = {

            socket: socket

        };
        //用户进入聊天室事件,向其他在线用户广播其用户名

        socket.on('join', function (data) {

            socket.broadcast.emit('broadcast_join', data);

            connectionList[socketId].username = data.username;

        });
        //用户离开聊天室事件,向其他在线用户广播其离开

        socket.on('disconnect', function () {

            if (connectionList[socketId].username) {

                socket.broadcast.emit('broadcast_quit', {

                    username: connectionList[socketId].username

                });

            }

            delete connectionList[socketId];

        });
        //用户发言事件,向其他在线用户广播其发言内容

        socket.on('say', function (data) {

            socket.broadcast.emit('broadcast_say',{

                username: connectionList[socketId].username,

                text: data.text

            });

        });

    })

};

Client(socketChatClient.js)

var socket = io.connect('http://localhost');

//连接服务器完毕后,马上提交一个“加入”事件,把自己的用户名告诉别人

socket.emit('join', {

    username: 'Username hehe'

});
//收到加入聊天室广播后,显示消息

socket.on('broadcast_join', function (data) {

    console.log(data.username + '加入了聊天室');

});
//收到离开聊天室广播后,显示消息

socket.on('broadcast_quit', function(data) {

    console.log(data.username + '离开了聊天室');

});
//收到别人发送的消息后,显示消息

socket.on('broadcast_say', function(data) {

    console.log(data.username + '说: ' + data.text);

});
//这里我们假设有一个文本框textarea和一个发送按钮.btn-send

//使用jQuery绑定事件

$('.btn-send').click(function(e) {

    //获取文本框的文本

    var text = $('textarea').val();

    //提交一个say事件,服务器收到就会广播

    socket.emit('say', {

        username: 'Username hehe'

        text: text

    });

});

这就是一个简单的聊天室DEMO,你可以根据你的需要随意扩展。Socket.IO基本上就是各种事件的提交和接收处理,思想非常简单。

Javascript 相关文章推荐
JavaScript 异步方法队列链实现代码分析
Jun 05 Javascript
关于图片的预加载过程中隐藏未知的
Dec 19 Javascript
js完美实现@提到好友特效(兼容各大浏览器)
Mar 16 Javascript
利用JS生成博文目录及CSS定制博客
Feb 10 Javascript
input 禁止输入特殊字符的四种实现方式
Aug 24 Javascript
jQuery手指滑动轮播效果
Dec 22 Javascript
Angular.js项目中使用gulp实现自动化构建以及压缩打包详解
Jul 19 Javascript
vue.js图片转Base64上传图片并预览的实现方法
Aug 02 Javascript
如何从头实现一个node.js的koa框架
Jun 17 Javascript
js实现文章目录索引导航(table of content)
May 10 Javascript
JS实现放大镜效果
Sep 21 Javascript
Vue时间轴 vue-light-timeline的用法说明
Oct 29 Javascript
Node.js的特点和应用场景介绍
Nov 04 #Javascript
Node.js中的模块机制学习笔记
Nov 04 #Javascript
Node.js异步I/O学习笔记
Nov 04 #Javascript
JavaScript中的ubound函数使用实例
Nov 04 #Javascript
JavaScript实现检查页面上的广告是否被AdBlock屏蔽了的方法
Nov 03 #Javascript
网页中表单按回车就自动提交的问题的解决方案
Nov 03 #Javascript
详解jquery中$.ajax方法提交表单
Nov 03 #Javascript
You might like
mysq GBKl乱码
2006/11/28 PHP
linux iconv方法的使用
2011/10/01 PHP
Apache服务器下防止图片盗链的办法
2015/07/06 PHP
PHP基于单例模式实现的mysql类
2016/01/09 PHP
制作特殊字的脚本
2006/06/26 Javascript
ExtJS Ext.MessageBox.alert()弹出对话框详解
2010/04/02 Javascript
nodejs实现bigpipe异步加载页面方案
2016/01/26 NodeJs
Angular 路由route实例代码
2016/07/12 Javascript
javascript表单正则应用
2017/02/04 Javascript
解决Mac node版本升级失败的问题
2018/05/16 Javascript
JS闭包经典实例详解
2018/12/20 Javascript
小程序input数据双向绑定实现方法
2019/10/17 Javascript
jquery实现直播弹幕效果
2019/11/28 jQuery
解决vue页面刷新,数据丢失的问题
2020/11/24 Vue.js
[01:00:30]完美世界DOTA2联赛循环赛 Inki vs Matador BO2第二场 10.31
2020/11/02 DOTA
教你用python3根据关键词爬取百度百科的内容
2016/08/18 Python
Python编程使用NLTK进行自然语言处理详解
2017/11/16 Python
用pycharm开发django项目示例代码
2018/10/24 Python
使用python进行波形及频谱绘制的方法
2019/06/17 Python
Python中IP地址处理IPy模块的方法
2019/08/16 Python
pygame实现五子棋游戏
2019/10/29 Python
使用Django搭建一个基金模拟交易系统教程
2019/11/18 Python
Flask项目中实现短信验证码和邮箱验证码功能
2019/12/05 Python
python安装sklearn模块的方法详解
2020/11/28 Python
高性能钓鱼服装:Huk Gear
2019/02/20 全球购物
文职个人求职信范文
2013/09/23 职场文书
北大自主招生自荐信
2013/10/19 职场文书
制药工程专业个人求职自荐信
2014/01/25 职场文书
市场营销管理毕业生自荐信
2014/03/03 职场文书
开门红主持词
2014/04/02 职场文书
地球一小时倡议书
2014/04/15 职场文书
代办委托书怎么写
2014/08/01 职场文书
小学生国庆演讲稿
2014/09/05 职场文书
事业单位年度考核评语
2014/12/31 职场文书
2016年社区中秋节活动总结
2016/04/05 职场文书
python实现的人脸识别打卡系统
2021/05/08 Python