在 expressjs 路由中使用 socket.io 而不是在主 server.js 文件中

Question

我有 express/nodejs api。我正在向它添加 socket.io 功能。目前我的所有路由都在单独的文件夹中，我将它们包含在 server.js 文件中并将它们用作 app.use() 函数。

在 server.js 文件中，我还通过监听特定端口（例如 3000）来启动 express 服务器，如下所示。

let server = app.listen(3000);

根据所有谷歌搜索，我发现我需要传递服务器变量来初始化 socket.io，如下所示。

let io = require('socket.io')(server);

现在的问题是，既然它需要这个变量，那么我如何在不同文件夹中的路由文件中使用 socket.io 来发送和接收来自客户端的事件？

更新

在 server.js 文件中

let route = require('./routes/route');

let app = express();

let server = app.listen(3000);

console.log('Listening to port');

let io = require('socket.io')(server);

app.use('/api/1.0/events', route(io));

在 route.js 文件中

let express = require('express');

module.exports = (io) => {
    console.log('IO: ', io);
};

更新 2

server.js 文件

let express = require('express');
let events = require('./routes/events');
let app = express();
let server = app.listen(3000);

let io = require('socket.io')(server);


app.use(function(request, response, next) {
    request.io = io;
    next();
});

app.use('/events', events);

events.js 文件

let express = require('express');

let Events = require('../models/events');

apiRoutes.post('/new', function(request, response) {
    let newEvent = new Events(request.body);

    newEvent.save((error, result) => {
        if (error) {
            response.json(error);
        } else {
            // console.log('ELSE');
            // request.io.on('connect', socket => {
                // console.log('LISTENING TO SOCKET...');

                request.io.on('EventCreated', data => {
                    console.log('DATA ON Server: ', data);
                });
            // });

            response.json({
                success: true,
                message: 'New event created'
            });
        }
    });
});

Answer 1

在 server.js 中：

module.exports.getIO = function(){
     return io;
}

在您的路线文件中：

var theServer = require('<path to server.js>');
var iovar = theServer.getIO(); //your io var

Answer 2

有多种方法可以将io 变量与路由文件共享。

1. 当您在路由文件中require() 时，将io 变量作为构造函数参数传递给它。

2. 使用app.set("io", io)，这样您就可以在任何有权访问app 对象的文件中使用let io = app.get("io")。

3. 创建一个中间件，将 io 对象放在每个 req 对象上，以便您可以随时从那里访问它。

---

这是一个将其作为构造函数参数传递给路由器文件的示例：

let server = app.listen(3000);
let io = require('socket.io')(server);

// load other routers
app.use(require("./someRouterFile.js")(io));

// in someRouterFile.js
const express = require('express');

module.exports = function(io) {
    let router = express.Router()

    // define routes
    // io is available in this scope
    router.get(...)

    return router;
}

---

这是app.set() 方案的示例：

let server = app.listen(3000);
let io = require('socket.io')(server);
app.set("io", io);

然后，在您可以访问app 对象的路径中的任何位置，您都可以通过以下方式获取它：

let io = app.get("io");

---

这是一个使用中间件将 io 对象设置到每个 req 对象上的示例，以便所有路由都可以使用它。

let server = app.listen(3000);
let io = require('socket.io')(server);

// place this middleware before any other route definitions
// makes io available as req.io in all request handlers
app.use(function(req, res, next) {
    req.io = io;
    next();
});

// then in any express route handler, you can use req.io.emit(...)

---

这是一个在没有中间件的情况下使用模块构造函数参数的示例：

// in mysocket.js
module.exports = (io) => {
    console.log('IO: ', io);
    io.on('connect', socket => {
       // handle various socket connections here
    });

    // put any other code that wants to use the io variable
    // in here


};

然后，在你的主文件中：

let server = app.listen(3000);
let io = require('socket.io')(server);

// initialize my socketio module and pass it the io instance
require('./mysocket.js')(io);

Answer 3

分享我用过的解决方案

这个问题的另一个解决方案（我实际使用过的）是我们可以使我们的io（socket.io object）对象成为全局对象。

只需将io 分配给global.io。

io 对象在index.js 中，在创建和设置io 对象之后只需执行global（即global.io = io;），现在这个io 对象可以在我们所在的任何路径中访问在我们的项目中工作。