Express.js 4 和带有 Express 路由器的套接字

Question

我正在尝试使用express.js 4创建一个非常简单的节点API，但我需要一些“实时”事件，我为其添加了socket.io。我对两者都很陌生，所以我可能会错过一些基本的东西，但我找不到关于这方面的好的文档/图。

在 Express 应用程序(使用 Express 生成器创建)中，我有类似的内容，基于我阅读的简单示例和项目文档。这工作正常，从客户端应用程序，我可以发送/接收套接字事件:

var express = require('express');
var path = require('path');
var logger = require('morgan');
var api = require('./routes/api');
var app = express();
var io = require('socket.io').listen(app.listen(3000));

app.use(logger('dev'));
app.use(express.static(path.join(__dirname, 'public')));
app.use('/api', api);

io.sockets.on('connection', function (socket) {
    console.log('client connect');
    socket.on('echo', function (data) {
        io.sockets.emit('message', data);
    });
});


// error handlers omitted

module.exports = app;

但我想使用 API 路由中的套接字(在上面我“需要”的 ./routes/api.js 文件中)。例如，有人可能使用 API 来 PUT/POST 资源，而我希望将该广播广播到连接的 socket.io 客户端。

我看不到如何使用“io”变量或组织io.sockets.on('connection' ...中当前的代码。快速路线内的功能。这是./routes/api.js文件:

var express = require('express');
var router = express.Router();
var io = ???;

router.put('/foo', function(req, res) {
    /* 
      do stuff to update the foo resource 
      ...
     */

    // now broadcast the updated foo..
    io.sockets.emit('update', foo); // how?
});

module.exports = router;

Answer 1

一种选择是将其传递给 req 对象。

app.js:

var express = require('express');
var path = require('path');
var logger = require('morgan');
var api = require('./routes/api');
var app = express();
var io = require('socket.io').listen(app.listen(3000));

app.use(logger('dev'));
app.use(express.static(path.join(__dirname, 'public')));

io.sockets.on('connection', function (socket) {
    console.log('client connect');
    socket.on('echo', function (data) {
        io.sockets.emit('message', data);
    });
});

// Make io accessible to our router
app.use(function(req,res,next){
    req.io = io;
    next();
});

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

// error handlers omitted

module.exports = app;

./routes/api.js:

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

router.put('/foo', function(req, res) {
    /* 
      do stuff to update the foo resource 
      ...
     */

    // now broadcast the updated foo..
    req.io.sockets.emit('update', foo); 
});

module.exports = router;