如何使用 Socket.IO 最好地构建 Express V4.11+ 项目？

Posted 2023-03-07

【中文标题】如何使用 Socket.IO 最好地构建 Express V4.11+ 项目？

【英文标题】：How to best structure an Express V4.11+ project with Socket.IO?

【发布时间】：2015-04-08 14:07:21

【问题描述】：

我使用了最新版本的 express-generator (link) 来生成样板 Express 4.11.2 项目。

我正在尝试找出设置 Socket.IO 1.3.3 的最佳方法，这些更改已在 Express 框架中的几个主要版本中进行，其中 http 服务器已移至其自己的 bin/www 文件中。

我很困惑，因为在导出到 bin/www 之前，我似乎需要 app.js 中的快速服务器。

我已经尝试谷歌搜索了几个小时，但没有任何结果，似乎 Express 框架发展得如此之快，以至于之前的所有文章都已过时。

任何帮助将不胜感激！

我在下面包含了有问题的两个文件，因此您可以在生成样板 express 项目后查看我正在使用的内容。

bin/www

#!/usr/bin/env node

/**
 * Module dependencies.
 */

var app = require('../app');
var debug = require('debug')('Express-Socket:server');
var http = require('http');

/**
 * Get port from environment and store in Express.
 */

var port = normalizePort(process.env.PORT || '3000');
app.set('port', port);

/**
 * Create HTTP server.
 */

var server = http.createServer(app);

/**
 * Listen on provided port, on all network interfaces.
 */

server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

/**
 * Normalize a port into a number, string, or false.
 */

function normalizePort(val) 
  var port = parseInt(val, 10);

  if (isNaN(port)) 
    // named pipe
    return val;
  

  if (port >= 0) 
    // port number
    return port;
  

  return false;


/**
 * Event listener for HTTP server "error" event.
 */

function onError(error) 
  if (error.syscall !== 'listen') 
    throw error;
  

  var bind = typeof port === 'string'
    ? 'Pipe ' + port
    : 'Port ' + port

  // handle specific listen errors with friendly messages
  switch (error.code) 
    case 'EACCES':
      console.error(bind + ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind + ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  


/**
 * Event listener for HTTP server "listening" event.
 */

function onListening() 
  var addr = server.address();
  var bind = typeof addr === 'string'
    ? 'pipe ' + addr
    : 'port ' + addr.port;
  debug('Listening on ' + bind);

app.js

var express = require('express');
var path = require('path');
var favicon = require('serve-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', 'ejs');

// uncomment after placing your favicon in /public
//app.use(favicon(__dirname + '/public/favicon.ico'));
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded( extended: false ));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

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

// catch 404 and forward 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;

【参考方案1】：

很多关于 socket.io 和 express 的信息都已经过时了，因为它们很受欢迎并且变化很快。

这是我最终做的，绝不是最好的。

我会创建一个与app.js同级的sockets.js，这样你就可以分离所有socket.io的初始化逻辑。

var sockets = ;

sockets.init = function (server) 
    // socket.io setup
    var io = require('socket.io').listen(server);
    io.sockets.on('connection', function (socket) 
        console.log('socket connected');
        // other logic
    );



module.exports = sockets;

在你的 bin/www 文件中，你可以像这样初始化 socket.io：

#!/usr/bin/env node
var debug = require('debug')('yourProject');
var app = require('../app');
var sockets = require('../sockets')

app.set('port', process.env.PORT || 3000);

var server = app.listen(app.get('port'), function() 
    debug('Express server listening on port ' + server.address().port);
);

sockets.init(server);