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 相关文章推荐
jquery设置元素的readonly和disabled的写法
Sep 22 Javascript
分享五个有用的jquery小技巧
Oct 08 Javascript
详解JavaScript对象类型
Jun 16 Javascript
Vue 过渡实现轮播图效果
Mar 27 Javascript
Bootstrap Table使用整理(四)之工具栏
Jun 09 Javascript
JS自定义函数实现时间戳转换成date的方法示例
Aug 27 Javascript
react-native fetch的具体使用方法
Nov 01 Javascript
JS实现在文本指定位置插入内容的简单示例
Dec 22 Javascript
JS简单实现动态添加HTML标记的方法示例
Apr 08 Javascript
node前端开发模板引擎Jade的入门
May 11 Javascript
ES6中定义类和对象的方法示例
Jul 31 Javascript
jQuery实现放大镜案例
Oct 19 jQuery
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
php设计模式 Command(命令模式)
2011/06/26 PHP
Laravel 5.5基于内置的Auth模块实现前后台登陆详解
2017/12/21 PHP
php防止表单重复提交实例讲解
2019/02/11 PHP
如何实现iframe(嵌入式帧)的自适应高度
2006/07/26 Javascript
Javascript异步编程的4种方法让你写出更出色的程序
2013/01/17 Javascript
可简单避免的三个JS发布错误的详细介绍
2013/08/02 Javascript
jquery按回车提交数据的代码示例
2013/11/05 Javascript
JS返回iframe中frameBorder属性值的方法
2015/04/01 Javascript
JS实现新建文件夹功能
2017/06/17 Javascript
解决vue中修改export default中脚本报一大堆错的问题
2018/08/27 Javascript
angularjs的单选框+ng-repeat的实现方法
2018/09/12 Javascript
微信小程序使用template标签实现五星评分功能
2018/11/03 Javascript
微信小程序云开发 生成带参小程序码流程
2019/05/18 Javascript
ES6 Map结构的应用实例分析
2019/06/26 Javascript
js利用递归与promise 按顺序请求数据的方法
2019/08/30 Javascript
Vue form表单动态添加组件实战案例
2019/09/02 Javascript
python绘制简单折线图代码示例
2017/12/19 Python
使用requests库制作Python爬虫
2018/03/25 Python
Python中将dataframe转换为字典的实例
2018/04/13 Python
Linux下python与C++使用dlib实现人脸检测
2018/06/29 Python
python opencv实现图片旋转矩形分割
2018/07/26 Python
pycharm 安装JPype的教程
2019/08/08 Python
Python彻底删除文件夹及其子文件方式
2019/12/23 Python
Django url 路由匹配过程详解
2021/01/22 Python
荷兰包包购物网站:The Little Green Bag
2018/03/17 全球购物
什么是WEB控件?使用WEB控件有哪些优势?
2012/01/21 面试题
乡镇爱国卫生月活动总结
2014/06/25 职场文书
党性锻炼的心得体会
2014/09/03 职场文书
副乡长民主生活会个人对照检查材料思想汇报
2014/10/01 职场文书
员工工作及收入证明
2014/10/28 职场文书
群众路线教育实践活动学习笔记
2014/11/05 职场文书
2014年幼儿园小班工作总结
2014/12/04 职场文书
军训个人总结
2015/03/03 职场文书
违反纪律检讨书范文
2015/05/07 职场文书
新闻通讯稿范文
2015/07/22 职场文书
使用 CSS 轻松实现一些高频出现的奇形怪状按钮
2021/12/06 HTML / CSS