ExpressJS - 具有路由分离的Socket.IO

时间:2012-09-24 14:06:43

标签: javascript node.js socket.io express

我正试图了解ExpressJS和Socket.IO。我已将我的路由放在一个单独的文件中,我从app.js中包含这个文件:

var express = require('express')    
  , db = require('./db')
  , mongoose = require('mongoose')
  , models = require('./models/device')
  , http = require('http')
  , path = require('path')
  , app = express()
  , server = http.createServer(app)
  , io = require('socket.io').listen(server)
  , routes = require('./routes/myRoutes');

但是当我尝试从我的一个路由发出一个事件时,我没有引用socket.io。

exports.update = function(req, res){
    return Item.findById(req.params.id, function(err, item) {
       // Do some checks and save.
       socket.emit('updated');
    }
}

我理解为什么这可能不可用。相反,我不明白获取socket.io句柄的最佳方法是从app.js以外的其他文件。我在看this question(见里卡多的回答),但我还不清楚。理想情况下,我想避免这样做:

routes = requires(“routes / myRoutes”)(io);

5 个答案:

答案 0 :(得分:9)

嗯,你真的不需要express.io。最简单的解决方案是导出一个新模块并将其传递给socket.io实例。 所以在你的app.js中你有:

var express = require('express'),
  ...
  , server = http.createServer(app)
  , io = require('socket.io').listen(server)
  , routes = require('./routes/myRoutes');

现在需要一个新模块并将其传递给socketio参考。添加这一新行(在app.js中):

require('./app/path/to/your/socketio/controller/socketio')(io);

然后在path/to/your/socketio/controller中创建一个名为socketio.js

的新文件

最后在socketio.js文件中,导出新模块:

module.exports = function(io) {

    io.sockets.on('connection', function (socket) {

        socket.on('captain', function(data) {

            console.log(data);

            socket.emit('america');
        });
    });
};

你去了!

答案 1 :(得分:5)

查看express.io

它具有实时请求的路由,以及许多其他有用的功能。

app = require('express.io')()
app.http().io()

app.io.route('example', function(req) {
    // do something interesting
}))

app.listen(7076)

至于必须绕过io对象。您有几个选择,根据您的要求,可能会或可能不会“最佳”。

  • ioapp设为全局。 (有些人对全局变得惊慌失措)
  • 在另一个文件中使用module.exportsrequire对象。 (如果做得不好,可能导致循环依赖问题)

传递io对象可能是最简单的方法,但你确实有选择。

答案 2 :(得分:2)

socket.io不适用于路由,它适用于套接字。

您可以将此代码添加到app.js或您在app.js中包含的单独文件:

io.sockets.on('connection', function (socket) {
  socket.on('update', function (your_id) {
    Item.findById(your_id, function(err, item) {
      socket.emit('send_update', item);
    }
  });
});

您的更新路线仅使用javascript呈现html文档,其中包含:

<script src="/socket.io/socket.io.js"></script>
<script>
  var socket = io.connect('http://localhost');
  socket.emit('update', { your_id: '1' });
  socket.on('send_update', function (data) {
    console.log(data);
  });
</script>

因此,一旦页面呈现并完成,client-javascript将打开一个到服务器的套接字并接收其他数据。

请参阅more examples here.

免责声明:代码从头开始编写,未经过测试。

答案 3 :(得分:2)

最好的方法是使用闭包。例如:

exports.update = function(socket){
  return function(req, res) {
    //In here now you can have the reference to the socket io
    Item.findById(req.params.id, function(err, item) {
       // Do some checks and save.
       socket.emit('updated');
    }
  }
}

app.post('/your_path', update(io));

答案 4 :(得分:0)

我使用了Expressjs的中间件路由器(我使用的是4.x)。

在外部路径文件中,我放了“下一个”对象:

module.exports = function(app, settings){
    app.post('/something', function(req, res, next) {
    ...
    next();
    }
};

在主文件中,我在io.on('connection')中写下最后一个路径:

io.on('connection', function (socket) {

    // Final route for middlewares who need to interact with socket.io
    app.post('/something', function (req, res, next) {
        socket.emit('event', { result: 'ok' });
    });

});