使用 node express 生成器配置 socket.io

Posted 2023-04-18

【中文标题】使用 node express 生成器配置 socket.io

【英文标题】：Configure socket.io with node express generator

【发布时间】：2015-05-01 03:26:12

【问题描述】：

我正在开发我的第一个节点项目，我基本上是按照the thinkster post 开始的。我已经设法构建了一个简单的应用程序，现在我正在尝试配置 socket.io。

socket.io 初始化代码和事件处理程序并不难理解，真正让我困惑的是我应该如何在bin/www 和app.js 文件之间组织该代码。这两个文件都是由 express 自动生成的。 bin/www 依赖于app.js 模块，首先启动了启动socket 模块所需的server 变量，这意味着我应该把所有的'socket.io' 代码放在bin/www 文件中吗？

但我认为我不应该接触那个文件，我会更愿意将该代码放入app.js 甚至是专用文件中。我想我需要在模块之间传递 server 对象引用，但我不知道该怎么做。

这是bin/www文件的内容：

#!/usr/bin/env node

/**
 * Module dependencies.
 */

var app = require('../app');
var debug = require('debug')('oculus: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 mongoose = require('mongoose');

// Mongoose
require('./models/Aplicacoes');
mongoose.connect('mongodb://localhost/oculus');

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

/**
 * Some business code here
 */
....

module.exports = app;

【参考方案1】：

首先，让我告诉你，你正在尝试做的事情是正确的。不要乱用bin/www 就可以了。

但请记住，快递生成器就是这样。供您构建的生成器。您生成并应用您自己的修改。

我的选择是：

将bin/www复制到一个新的bin/wwwio， 更新bin/wwwio 脚本以将socket.io 附加到创建的http 服务器。 将bin/wwwio 更新为require() 一个新文件../io.js，用于处理我的所有socket.io 事件。 修改package.json 以在npm start 上运行node ./bin/wwwio 而不是bin/www

您还可以查看有关某个主题的其他问题的答案：

Using socket.io in Express 4 and express-generator's /bin/www

您会发现几种实现模块化的方法，而几乎不涉及 bin/www 脚本。

【参考方案2】：

尝试遵循这些简单的步骤

使用以下命令安装 Socket.io：

npm install --save socket.io

将以下内容添加到 app.js：

var sockIO = require('socket.io')(); app.sockIO = sockIO;

在bin/www，

after var server = http.createServer(app), add the following:

var sockIO = app.sockIO; sockIO.listen(server);

要测试功能，在 app.js 中，您可以添加以下行：

sockIO.on('connection', function(socket) console.log('A client connection occurred!'); );

现在在 layout.hbs 中，在正文结束标记之前添加以下 sn-p