使用socket.io配置Express 4.0路由

13

我创建了一个新的Express应用程序。它为我生成了app.js,然后我创建了以下index.js,引入socket.io:

var app = require('./app');
server=app.listen(3000);

var io = require('socket.io');
var socket = io.listen(server, { log: false });

socket.on('connection', function (client){
    console.log('socket connected!');
});

请问如何在路由文件中访问socket.io?

默认生成的app.js参考如下:

var express = require('express');
var path = require('path');
var favicon = require('static-favicon');
var logger = require('morgan');
var cookieParser = require('cookie-parser');
var bodyParser = require('body-parser');

var routes = require('./routes/index');
var users = require('./routes/users');

var app = express();

// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');

app.use(favicon());
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded());
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', routes);
app.use('/users', users);

/// catch 404 and forwarding to error handler
app.use(function(req, res, next) {
    var err = new Error('Not Found');
    err.status = 404;
    next(err);
});

/// error handlers

// development error handler
// will print stacktrace
if (app.get('env') === 'development') {
    app.use(function(err, req, res, next) {
        res.status(err.status || 500);
        res.render('error', {
            message: err.message,
            error: err
        });
    });
}

// production error handler
// no stacktraces leaked to user
app.use(function(err, req, res, next) {
    res.status(err.status || 500);
    res.render('error', {
        message: err.message,
        error: {}
    });
});


module.exports = app;

最佳解决方案在这里: https://dev59.com/UVoU5IYBdhLWcg3wV1-8#37560779 - mdv
3个回答

35

SocketIO无法与路由配合使用,它只能与套接字(socket)一起工作。

话虽如此,您可能希望改用express-io,因为它专门为此而设计,或者如果您正在构建实时Web应用程序,则尝试使用sailsjs,它已经将socketIO集成到其中。

请在主要的app.js文件中进行以下操作:

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

app.listen(7076)
然后在你的路由上做类似下面这样的事情:
app.get('/', function(req, res) {
    // Do normal req and res here
    // Forward to realtime route
    req.io.route('hello')
})

// This realtime route will handle the realtime request
app.io.route('hello', function(req) {
    req.io.broadcast('hello visitor');
})

请查看这里的express-io文档。

或者,如果你真的想坚持使用express和socketio,可以这样做:

在你的app.js中进行操作。

server = http.createServer(app)
io = require('socket.io').listen(server)
require('.sockets')(io);

然后创建一个名为sockets.js的文件。

module.exports = function(io) {

    io.sockets.on('connection', function (socket) {
        socket.on('captain', function(data) {
            console.log(data);
            socket.emit('Hello');
        });
    });
};
你可以将其调用到你的路由/控制器中。

1
谢谢,非常有帮助! - Ben
4
由于 express.io 使用较旧的版本,我建议您也看一下以下方式:https://dev59.com/rIDba4cB1Zd3GeqPG6Qj#24222869。虽然我不太清楚作者在答案中试图解释什么,但我希望更多的人可以探讨和帮助解决这个问题,以使它变得更好。 - Chetan Bhasin
15
这句话的意思是“然后你可以将它调用到你的路由/控制器中。” - Markus Pint
14
Express.io 似乎已经停止维护。 - Dirk
请提供包含路由和控制器的完整示例。 - Stephan Kristyn
显示剩余2条评论

7
路由:
const Router = require('express').Router

const router = new Router();

router.get('/my-route', (req, res, next) => {
    console.log(req.app.locals.io) //io object
    const io = req.app.locals.io
    io.emit('my event', { my: 'data' }) //emit to everyone
    res.send("OK")
});

module.exports = router

主文件:
const app = require('express')()
const server = require('http').Server(app);
const io = require('socket.io')(server)
const myroute = require("./route") //route file dir

app.use(myroute);

server.listen(3000, () => {
    console.log('¡Usando el puerto 3000!');
});

app.locals.io = io

1
https://expressjs.com/es/api.html 中的 app.locals 是一个空对象,您可以在其中存储变量。我只是简单地将 io 分配给了 socket.io 依赖项。 - Armando Rueda
如果客户端在不同的位置,您如何连接? - Chukwuemeka Maduekwe
2
在您的客户端实现中,只需使用ws://localhost:3000。 - Armando Rueda

0

我认为更好的做法是在第一个中间件中将Io服务器附加到响应对象上。根据express的设计,Io服务器将可用于您的后续路由。

查看此链接


最好您能够发布一个示例而不是链接。该网址带我们进入了一个假设我们正在使用Express应用程序生成器的东西,当然我们可以只提取重要内容并将其用于我们的项目中;在我看来,更好的方法是发布一个通用的工作示例。 - Herii

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接