如何在Node.js的Express路由中使用Socket.io（解决跨文件调用问题）

嘿，我知道你现在卡在怎么在Express路由里调用Socket.io的问题上了——毕竟默认在app.js里创建的io实例，路由文件确实拿不到。我给你分享几种实战里常用的解决办法，都是靠谱的：

方案1：把io挂载到Express的app对象上 #

这是最直接的方法，利用Express自带的app.set()和app.get()来共享io实例：

首先在你的app.js里，创建完io之后把它挂载到app上：

let http = require('http').Server(app);
let io = require('socket.io')(http);

// 把io实例存入app的全局设置中
app.set('io', io);

// 你的Socket.io连接逻辑保持不变
io.on('connection', (socket) => {
  console.log('user connected');
  socket.on('disconnect', function(){
    console.log('user disconnected');
  });
  socket.on('message', (message) => {
    console.log("Message Received: " + message);
    io.emit('message', {type:'new-message', text: message});
  });
});

然后在你的路由文件（比如routes/chat.js）里，就可以通过req.app.get('io')拿到io实例了：

const express = require('express');
const router = express.Router();

router.post('/send-message', (req, res) => {
  // 从app对象中获取io实例
  const io = req.app.get('io');
  // 用io发送消息
  io.emit('message', {type:'new-message', text: req.body.message});
  res.status(200).json({status: 'success'});
});

module.exports = router;

方案2：模块化封装io实例 #

如果你的项目比较大，想要更清晰的代码结构，推荐把io封装成一个独立模块，这样任何文件都可以直接导入使用：

首先新建一个socket.js文件：

// 用来存储io实例的变量
let io;

module.exports = {
  // 初始化io的方法
  init: (httpServer) => {
    io = require('socket.io')(httpServer);
    return io;
  },
  // 获取io实例的方法
  getIO: () => {
    if (!io) {
      throw new Error('Socket.io还没初始化！请先调用init方法');
    }
    return io;
  }
};

然后回到app.js里，用这个模块来初始化io：

let http = require('http').Server(app);
const socketModule = require('./socket');
// 初始化io并拿到实例
const io = socketModule.init(http);

// 你的Socket.io连接逻辑照旧
io.on('connection', (socket) => {
  console.log('user connected');
  socket.on('disconnect', function(){
    console.log('user disconnected');
  });
});

现在在路由文件里，直接导入这个模块就能拿到io了：

const express = require('express');
const router = express.Router();
const socketModule = require('../socket');

router.post('/broadcast', (req, res) => {
  const io = socketModule.getIO();
  io.emit('message', {type:'new-message', text: req.body.content});
  res.send('消息已广播');
});

module.exports = router;

方案3：用中间件把io挂载到req对象上 #

这种方法适合需要在很多路由里频繁使用io的场景，通过中间件把io直接放到请求对象里：

在app.js里添加中间件：

let http = require('http').Server(app);
let io = require('socket.io')(http);

// 中间件：把io挂载到req.io上
app.use((req, res, next) => {
  req.io = io;
  next();
});

// Socket.io连接逻辑不变
io.on('connection', (socket) => {
  console.log('user connected');
});

然后在路由里直接用req.io就行：

const express = require('express');
const router = express.Router();

router.post('/notify', (req, res) => {
  req.io.emit('notification', {text: req.body.notice});
  res.status(200).send('通知已发送');
});

module.exports = router;

注意事项 #

• 不管用哪种方法，绝对不要在路由文件里重新require socket.io并创建新实例，那样会生成一个独立的Socket.io服务，和你app.js里的不是同一个，根本没法通信。
• 确保在初始化io之后再加载路由，不然可能会出现io未定义的错误。

内容的提问来源于stack exchange，提问作者Andy Torres