egg.js集成Socket.io实现推送和即时通信

什么是Socket.io

一个基于 Node.js 的实时应用程序框架，在即时通讯、通知与消息推送，实时分析等场景中有较为广泛的应用

什么是egg-socket.io

• 对socket.io的二次封装, 增加了一些开发规范
• 增加namespace(命名空间), 可以通过配置的方式定义
• 增加middleware, 对每一次socket连接的建立、断开、消息和数据传递进行预处理
• controller, 相应socket.io的event事件
• router, 同一了socket.io的event与框架路由的处理配置方式

把egg-socket.io整合到我们的egg项目中

不知道怎么搭建egg项目的翻下以前的文章

• 安装egg-socket.io

cnpm i egg-socket.io -S

• 开启插件
  {app_root}/config/plugin.js

exports.io = {
  enable: true,
  package: 'egg-socket.io',
};

• 配置egg-socket.io
  {app_root}/config/config.default.js

module.exports = appInfo => {
  const config = exports = {
    io: {
      # namespace命名空间配置为/
      namespace: {
        '/': {
          # 预处理器中间件, 我们这里配置了一个auth, 进行权限判断, 它对应的文件是/app/io/middleware/auth.js, 这里可以配置多个文件, 用逗号隔开
          connectionMiddleware: ['auth'], #这里我们可以做一些权限校验之类的操作
          packetMiddleware: [], # 通常用于对消息做预处理，又或者是对加密消息的解密等操作
        },
      },
      # 配置redis, 非必须, 不需要的可以不配置这块, egg-socket.io内置了socket-io-redis， 在cluster模式下, 使用redis可以较为简单的实现clients/rooms等信息共享
      redis: {
        host: 'ip地址',
        prot: 6379,
        auth_pass: 123456,
        db:0, 
      }
    }
  };
  省略 .....
}；

到这里egg-socket.io已经开启并配置完毕了, 接下来我们就要编写路由和控制器了

• 先来看下egg-socket.io的项目目录结构

your-project-name
├── app
│   ├── extend
│   │   └── helper.js
│   ├── io
│   │   ├── controller
│   │   │   └── chat.js
│   │   └── middleware #插件中间件, 基于 socket 模型设计，处理 socket.io 请求 
│   │       ├── auth.js #对应刚才配置的connectionMiddleware: ['auth']
│   └── router.js
├── config
└── package.json

• 先配置路由
  /app/router.js

module.exports = app => {
  const { router, controller, io } = app;
  //http 接口, 在对应的控制器中可以直接操作socket, 非常方便
  router.get('/', controller.home.index);
  router.get('/user', controller.user.index);
  
  // socket, 指向app/io/controller/chat.js的index方法
  io.route('chat', app.io.controller.chat.index);
};

• 然后创建auth.js
  app/io/middleware/auth.js

const room = "default_room";

module.exports = () => {
    return async(ctx, next) => {
        // 权限校验通过
        ctx.socket.emit('res', 'auth success');
        // 加入房间
        socket.join(room);
        // 放行
        await next();
        console.log('断开连接');
   }
};

• 最后创建聊天控制器
  app/io/controller/chat.js

'use strict';

const Controller = require('egg').Controller;
const room = 'default_room';

class ChatController extends Controller {
    async index(){
         const {app, socket, logger, helper} = this.ctx;
         const id = socket.id;
         // 根据id给指定连接发送消息
         nsp.sockets[id].emit('res', "hello ....");
         // 指定房间连接信息列表
         nsp.adapter.clients([room], (err, clients) => {
             console.log(JSON.stringify(clients));
         });
         //  给指定房间的每个人发送消息
         this.ctx.app.io.of('/').to(room).emit('online', this.ctx.socket.id+ "上线了");
         // 断开连接
         this.ctx.socket.disconnect();
    }
}
module.exports = ChatController;

• 通过调用http接口给客户端发送消息
  说白了就是在http接口的控制器中发送socket消息
  app/controller/home.js

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    const {app, query} = this.ctx;
    // 给谁发, socket连接的id
    const id = query.id;
    const nsp = app.io.of('/');
    if(nsp.sockets[id]){
     // 通过id给指定socket连接发送消息
      nsp.sockets[id].emit('res', 'hello http....');
    }
    this.ctx.body = "发送成功";
  }
}

module.exports = HomeController;

到这里服务端完成, 下面我们来写一个简单的socket.io客户端

const socket = require('socket.io-client')('http://127.0.0.1:7001');

// 连接服务端
socket.on('connect', () => {
  console.log('connect!');
  socket.emit('chat', 'hello world!');
});

//接收消息通知
socket.on('res', msg => {
  console.log('res from server: %s!', msg);
});

// 接收上线通知
socket.on('online', msg=>{
   console.log('online from server: %s!', msg);
});

到这就结束了, 有问题留言!!!