egg-socket 配置和使用

nodejs

Socket.IO

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

WebSocket 的产生源于 Web 开发中日益增长的实时通信需求，对比基于 http 的轮询方式，它大大节省了网络带宽，同时也降低了服务器的性能消耗；socket.io 支持 websocket、polling 两种数据传输方式以兼容浏览器不支持 WebSocket 场景下的通信需求。

框架提供了 egg-socket.io插件，增加了以下开发规约：

• namespace: 通过配置的方式定义 namespace（命名空间）
• middleware: 对每一次 socket 连接的建立/断开、每一次消息/数据传递进行预处理
• controller: 响应 socket.io 的 event 事件
• router: 统一了 socket.io 的 event 与 框架路由的处理配置方式

安装

$ npm i egg-socket.io --save

开启插件

// {app_root}/config/plugin.js
exports.io = {
   
  enable: true,
  package: 'egg-socket.io',
}; 

配置

// {app_root}/config/config.${env}.js
exports.io = {
   
  init: {
    }, // passed to engine.io
  namespace: {
   
    '/': {
   
      connectionMiddleware: [],
      packetMiddleware: [],   // 针对消息的处理暂时不实现
    },
  },
};

开启 egg-socket.io 的项目目录结构

chat
├── app
│   ├── extend
│   │   └── helper.js
│   ├── io
│   │   ├── controller
│   │   │   └── default.js
│   │   └── middleware
│   │       ├── connection.js
│   │       └── packet.js
│   └── router.js
├── config
└── package.json

注意：对应的文件都在 app/io 目录下

Router 配置 （路由负责将 socket 连接的不同 events 分发到对应的 controller），不用controller方法可以暂时不用配置

// {app_root}/app/router.js

module.exports = app => {
   
  const {
    router, controller, io } = app;

  // default
  router.get('/', controller.home.index);

  // socket.io
  io.of('/').route('server', io.controller.home.server