原文地址:关于socket.io的使用

这段时间学习了socket.io,用它写了小项目,在此总结下它的基本使用方式和一些要点。

socket.io是基于Node.jsWebSocket协议的实时通信开源框架,它包括客户端的JavaScript和服务器端的Node.js。

服务端

这里后端使用的框架是koa2socket.io将自身绑定到koa的进程中去,其中最重要的事件就是 connectiondisconnect。它们是框架本身定义的系统事件,也就意味着它是自然就存在的不需要我们自定义,当然还有其它系统事件,但很少会用得到。

const koa = require('koa')
const app = new koa()
const server = require('http').createServer(app.callback())
const io = require('socket.io')(server) //监听connect事件
io.on('connection', socket => {
socket.emit('open');//通知客户端已连接
console.log('connected'); //监听disconnect事件
socket.on('disconnect', () => {
console.log('disconnect')
}
});
server.listen(3001);

客户端

web端直接传入url地址即可,其中这里监听的 open 事件是用户自定义的,对应服务端的则是发送open事件。

import io from 'socket.io-client';

//建立websocket连接
const socket = io('http://127.0.0.1:3001'); //收到server的连接确认
socket.on('open', () => {
showTip('socket io is open !');
init();
});

emit 和 on

emiton 是最重要的两个api,分别对应 发送监听 事件。

  • socket.emit(eventName[, ...args]):发射(触发)一个事件
  • socket.on(eventName, callback):监听一个 emit 发射的事件

我们可以非常自由的在服务端定义并发送一个事件emit,然后在客户端监听 on,反过来也一样。

发送的内容格式也非常自由,既可以是基本数据类型 NumberStringBoolean 等,也可以是 ObjectArray 类型,甚至还可以是函数。而用回调函数的方式则可以进行更便携的交互。

/*** 服务端 **/
socket.on('message',data =>{
console.log(data)
}); socket.emit('send','hello everybody'); /*** 客户端 **/
socket.emit('message',{id:'1',txt:'hello'}); socket.on('send',data =>{
console.log(data);
}); //回调函数
/*** 服务端 **/
socket.on('sayit', (word, callback)=> {
callback('say ' + word);
}); /*** 客户端 **/
socket.emit('sayit', 'wow', data => {
console.log(data); // say wow
});

broadcast 广播

broadcast 默认是向所有的socket连接进行广播,但是不包括发送者自身,如果自己也打算接收消息的话,需要给自己单独发送。

/*** 服务端 **/
io.on('connection', socket => {
const data= {
txt:'new user login',
time:new Date()
}
//广播向所有socket连接
socket.broadcast.emit('userin',data);
//给自己也发一份
socket.emit('userin',data);
});

namespace 命名空间

如果你想隔离作用域,或者划分业务模块,namespace 是个有效的法子。namespace 相当于建立新的频道,你可以在一个 socket.io 服务上面隔离不同的连接,事件和中间件。

默认的连接也是有namespace的,那就是 /

使用命名空间的方式一:直接在链接后面加子域名,这种其实用的还是同一个 sokcet 服务进程,可以看成是软隔离吧。

/*** 客户端 **/
import io from 'socket.io-client'; //默认的namespace
const socket = io('http://127.0.0.1:3001');
// mypath
const socket = io('http://127.0.0.1:3001/mypath', { forceNew: true }); /*** 服务端 **/
//默认的namespace
io.on('connection', socket => {
});
// mypath
io.of('/mypath').on('connection', socket => {
});

使用命名空间的方式二: path 参数,这种就是实打实的重新起了一个 socket 服务了。

/*** 客户端 **/
const socket = io('http://localhost', {
path: '/mypath'
}); /*** 服务端 **/
// 另外重新起socket服务
const io = require('socket.io')({
path: '/mypath'
});

middleware 中间件

socket.io 的中间件 和 kao2 的非常相似,这意味着我们可以在变动很小的情况下,将koa2的中间件改造为 socket.io 所用。

const mypath = io.of('/mypath').on('connection', socket => {
socket.on('message', data => {
});
}); //中间件
const auth = (socket, next) => {
const data = socket.request;
if(!verify(data)){
throw new Error('not verify');
}
next();
}
// mypath 这个 namespace 注册中间件
mypath.use(auth);

rooms

每一个socket连接都会有一个独一无二的标志,那就是 socket.id,我们就是通过id来区分不同连接的。除此之外,socket.id 本身也是房间 room 的标志,通俗讲,每个socket 连接自身都拥有一间房 room。那么我们就可以给这个 room 发送消息,还有如果你加入了房间,就能接受到房间里的广播信息。当然你可以自定义 room ,让socket连接加入或离开。还有如果 socket 断开连接,也就是 disconnect 后,它会被自动移出room。

而这就是实现 单独聊天群组聊天 的基础,来看一下对应的api。

  • socket.join(rooms[, callback]):加入房间
  • socket.leave(room[, callback]) :离开房间
  • socket.to(room): 给房间发送消息
// 自定义room
io.on('connection', socket =>{
socket.join('some room')); // 加入房间
socket.leave('some room'); // 离开房间
}); // 向房间里的所有客户端发送消息
io.to('some room').emit('some event'); // 默认房间(每一个id一个room)
socket.on('say to someone', (id, msg) => {
socket.broadcast.to(id).emit('my message', msg);
});

总结

相信有了以上介绍的基础知识,再加上官网对应的文档,要开发聊天室或者其他 实时通信 的项目,是一件易如反掌的事情

socket.io官网 里面有对 api 非常详细的讲解和用例。

关于socket.io的使用的更多相关文章

  1. 在web浏览器上显示室内温度(nodeJs+arduino+socket.io)

    上次的nodejs操作arduino入门篇中实现了如何连接arduino.这次我们来实现通过arduino测量室内温度并在浏览器上显示出来. [所需材料] 硬件:LM35温度传感器,arduino u ...

  2. Node学习笔记(三):基于socket.io web版你画我猜(二)

    上一篇基础实现的功能是客户端canvas作图,导出dataURL从而实现图片信息推送,下面具体讲下服务端的配置及客户端的配置同步 首先先画一个流程图,讲下大概思路 <canvas id=&quo ...

  3. node.js+socket.io配置详解

    由于我是在win7的环境下,在这里就以win7系统为例进行讲解了. 首先需要在nodejs官网下载最新版的node.js,下载完毕直接安装即可,安装成功后在cmd命令行中执行node指令,如下结果就说 ...

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

    Web领域的实时推送技术,也被称作Realtime技术.这种技术要达到的目的是让用户不需要刷新浏览器就可以获得实时更新.它有着广泛的应用场景,比如在线聊天室.在线客服系统.评论系统.WebIM等. W ...

  5. socket.io简单入门(一.实现简单的图表推送)

    引子:随着nodejs蓬勃发展,虽然主要业务系统因为架构健壮性不会选择nodejs座位应用服务器.但是大量的内部系统却可以使用nodejs试水,大量的前端开发人员转入全堆开发也是一个因素. 研究本例主 ...

  6. websocket与socket.io

    什么是Websocket? Websocket是一个独立于http的实时通信协议,最初是在HTML5中被引用进来的,在HTML5规范中作为浏览器与服务器的核心通信技术被嵌入到浏览器中.WebSocke ...

  7. socket.io安装部署

    需要node.js环境 创建package.json npm init 下载相关依赖 npm install --save express@4.10.2npm会在当前目录下载所需要的依赖到node_m ...

  8. Node.js、Express、Socket.io 入门

    前言 周末断断续续的写了第一个socket.io Demo.初次接触socket.io是从其官网看到的,看着get started做了一遍,根据官网的Demo能提供简单的服务端和客户端通讯. 这个De ...

  9. socket.io,io=Manager(source, opts)

    原文:http://www.cnblogs.com/xiezhengcai/p/3968067.html 当我们在使用 var socket = io("ws://103.31.201.15 ...

  10. socket.io,命名空间

    原文:http://www.cnblogs.com/xiezhengcai/p/3966263.html 命名空间 在api部分我们说io.connect('ws://103.31.201.154:5 ...

随机推荐

  1. vs2015 key

    vs2015 企业版 专业版 密钥   亲测可用 专业版:HMGNV-WCYXV-X7G9W-YCX63-B98R2企业版:HM6NR-QXX7C-DFW2Y-8B82K-WTYJV

  2. 14.Ubuntu基本命令

    vi编辑器 {  :上一段diamante } :下一段代码 dw: 删除一个单词 权限 前面的分三组 第一: 文件拥有者的权限 第二:同组者拥有的权限 第三:其他人拥有的权限 前面“-”表示是文件 ...

  3. Flask入门之SQLAlchemy数据库连接操作(第15讲)

    一.库安装 Flask-SQLAlchemy 2 SQLAlchemy 1.0.8 二.进入venv 三.切换到项目Sample\ 文件夹,进入manager.py 的shell python man ...

  4. 基于.net的爬虫应用-DotnetSpider

    最近应朋友的邀请,帮忙做了个简单的爬虫程序,要求不高,主要是方便对不同网站的爬取进行扩展,获取到想要的数据信息即可.当然,基于数据的后期分析功能是后话,以后的随笔我会逐步的介绍. 开源的爬虫框架比较多 ...

  5. python_重写数组

    class MyArray: '''All the elements in this array must be numbers''' def __IsNumber(self,n): if not i ...

  6. AtomicInteger类的使用

    AtomicInteger介绍 AtomicInteger是一个提供原子操作的Integer类,通过线程安全的方式操作加减. AtomicInteger使用场景 AtomicInteger提供原子操作 ...

  7. SSM-SpringMVC-15:SpringMVC中小论注解式开发之通配符篇

     ------------吾亦无他,唯手熟尔,谦卑若愚,好学若饥------------- 此处改了下标题,小论,为什么不说大话了呢?哎,质量不够啊,通配符篇提取不出更多可以讲的滔滔不绝的套路 通配符 ...

  8. python 基础语法学习

    .注释 python单行注释以#开头 如:#!/usr/bin/env python3 #查找运行环境 多行注释有' ' '和" " " .python最具有特色的是使用 ...

  9. JavaScript设计模式 Item 4 --继承

    1.继承 在javascript中继承是一个非常复杂的话题,比其他任何面向对象语言的中的继承都复杂得多.在大多数其他面向对象语言中,继承一个类只需要使用一个关键字即可.与它们不同,在javascrip ...

  10. 你不知道的JavaScript--Item25 创建对象(类)的8种方法总结

    1. 使用Object构造函数来创建一个对象 下面代码创建了一个person对象,并用两种方式打印出了Name的属性值. var person = new Object(); person.name= ...