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

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

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

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

2. 使用app.set("io", io)，然后可以let io = app.get("io")在可以访问该app对象的任何文件中使用。

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);