如何在独立路由、MVC 风格的 Express.js 应用程序中包含 MongoDB 客户端、通用中间件和其他“零碎”？

Question

我正在将一个大的（约 8,000 行）单文件代码库重构为“独立路由”、“MVC 风格”的应用程序。

我想将“最佳实践”应用于app.js入口文件的结构（文件夹、文件和路由）和内容。

我试图让事情变得简单、直观和最小化。

我参考了几个视频教程、文章、帖子和 github 回购，并抓住了每个似乎最明智的部分（参见帖子末尾的链接）。

这些学习资源让我完成了 90% 的工作，但是它们的示例和我的实现中存在细微差别，它们并不完全匹配。

他们似乎也没有涵盖如何处理这些要求：

• MongoDB客户端配置
• Socket.io实现
• 所有请求中使用的app.use()中间件
• JWT令牌验证
• 简单的模板引擎实现

这些是相当常见的功能，所以我希望有标准的方法来处理这些要求，并且这个问题对同一条船上的其他人也很有价值。

这就是我到目前为止所拥有的——一切似乎都很好，直到我到达app.js ：

结构体

app.js <---- entry file  
routes
- index.js
- resource01Route.js
- resource02Route.js
- resource03Route.js
// etc
middleware
- middleware_01.js
- middleware_02.js
- middleware_03.js
// etc  
views
- index.ntl  

routes/index.js看起来像这样：

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

const resource01Route = require('./resource01Route');
const resource02Route = require('./resource02Route');
const resource03Route = require('./resource03Route');

router.use('/api/:api_version/resource01', resource01Route);
router.use('/api/:api_version/resource02', resource02Route);
router.use('/api/:api_version/resource03', resource03Route);

module.exports = router;

而且routes/resource01Route.js看起来像：

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

const middleware_01 = require('../middleware/middleware_01');
const middleware_02 = require('../middleware/middleware_02');
const middleware_03 = require('../middleware/middleware_03');

router
    .route('/')
    .get(middleware_01)
    .post(middleware_02)
    .delete(middleware_03);

// etc  

module.exports = router;

中间件/中间件_01.js看起来像：

const middleware_01 = async (req, res) => {
/*
  
do stuff here

make calls to database and other middleware

*/
  res.json({ response: response });
  return;
};

module.exports = middleware_01;

我的下一步是创建一个干净且最小的app.js ，例如：

const express = require('express');
const app = express();
const routes = require('./routes');

app.use('/', routes); // <---- call in the routes/index.js file   
  
app.listen(PORT, () => {
    console.log(`the app is listening`); 
});

这就是我卡住的地方。

在大多数情况下，我已经从app.js中获得了route和middleware管理。

但是，我仍然在app.js中留下了大量的“位”。

我不知道如何引用/包含它们（在app.js中或在其他地方保持app.js干净）。

这包括：

1)在多个中间件函数中使用的对mongo_client的引用，即：

MongoClient.connect(connection_string, (err, client) => {
  if (err) {
    throw err;
  } else {
    mongo_client = client;
  }
});

2） socket.io逻辑，即：

io.on('connection', async (socket) => {

/*

define LOTS of socket.io logic

needs access to mongo_client

*/

});

3) app.use()用于所有请求的中间件，即：

app.use(
  helmet({
    contentSecurityPolicy: {
      useDefaults: true,
      directives: {
        defaultSrc: ["'self'"],
        scriptSrc: ["'self'", 'https://static.codepen.io'],
        styleSrc: ["'self'", 'fonts.googleapis.com', "'unsafe-inline'"],
        fontSrc: ["'self'", 'fonts.gstatic.com'],
        frameSrc: ["'self'", 'https://codepen.io'],
      },
    },
  })
);

app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
app.use(express.static('dist'));

4） JWT验证逻辑，即：

app.use((req, res, next) => {

/*

define all JWT verification logic  

needs access to mongo_client

*/

next();

});

5） 简单的模板引擎定义和res.render ，即：

app.engine('ntl', (filePath, options, callback) => {
  fs.readFile(filePath, (err, content) => {
    if (err) return callback(err);
    var rendered = content
      .toString()
      .replace('#page_html#', options.page_html)
      .replace(/#site_title#/g, site_title)
      .replace(/#site_description#/g, site_description)
      .replace(/#og_image#/g, og_image)
      .replace(/#og_url#/g, og_url);
    return callback(null, rendered);
  });
});

app.set('views', './views');
app.set('view engine', 'ntl');

对于完整的上下文，下面是我试图重构的剩余app.js文件，在它的所有荣耀中（请忽略组合 ES6/通用模块处理）：

import express from 'express';
import cors from 'cors';
import bodyParser from 'body-parser';
import bcrypt from 'bcrypt';
import jwt from 'jsonwebtoken';
import online_status from './src/js/my_modules/environment_checker';
if (online_status === 'offline') {
  var local_settings = require('./src/js/my_modules/local_settings');
}

// needed for mongodb 
import { MongoClient } from 'mongodb';
const ObjectID = require('mongodb').ObjectID;
var mongo_client;  // value modified later   

// needed for template engine
const fs = require('fs');

// needed for security
const helmet = require('helmet');

// needed for socket.io 
const app = express();
const http = require('http');
const server = http.createServer(app);
const io = require('socket.io')(server);
app.set('socketio', io);

// can't remember what this is for  
const path = require('path');

// if online/production
if (online_status === 'online') {
  var PORT = 8080;

  /*
  
define lots of environment variables to use in online/production environment, including mongodb connection string values, makes use of process.env

   */
}
// else if local/development
else if (online_status === 'offline') {
  var PORT = 3000;

  /*
  
define lots of environment variables to use in online/production environment, including mongodb connection string values, makes use of a local settings file

   */

}

//  connect to mongodb and return instance of mongoclient
MongoClient.connect(connection_string, (err, client) => {
  if (err) {
    throw err;
  } else {
    mongo_client = client;
  }
});



io.on('connection', async (socket) => {

/*

define LOTS of socket.io logic

needs access to mongo_client

 */

});

app.use(
  helmet({
    contentSecurityPolicy: {
      useDefaults: true,
      directives: {
        defaultSrc: ["'self'"],
        scriptSrc: ["'self'", 'https://static.codepen.io'],
        styleSrc: ["'self'", 'fonts.googleapis.com', "'unsafe-inline'"],
        fontSrc: ["'self'", 'fonts.gstatic.com'],
        frameSrc: ["'self'", 'https://codepen.io'],
      },
    },
  })
);


app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
app.use(express.static('dist'));

app.use((req, res, next) => {


/*

define all JWT verification logic  

needs access to mongo_client

 */

next();

});

// BEGIN simple templating engine
// see:  https://expressjs.com/en/advanced/developing-template-engines.html

app.engine('ntl', (filePath, options, callback) => {
  fs.readFile(filePath, (err, content) => {
    if (err) return callback(err);
    var rendered = content
      .toString()
      .replace('#page_html#', options.page_html)
      .replace(/#site_title#/g, site_title)
      .replace(/#site_description#/g, site_description)
      .replace(/#og_image#/g, og_image)
      .replace(/#og_url#/g, og_url);
    return callback(null, rendered);
  });
});

app.set('views', './views');
app.set('view engine', 'ntl');

// END simple templating engine

server.listen(PORT, () => {
  console.log(`running on port ${PORT}`);
});

研究

视频： Hey Node如何在 Node.js 中向 Express 服务器添加路由

视频： Programming with Basar在 Express 中的项目文件夹结构

视频：NodeJS REST：如何使用路由器将代码重构为多个文件， Lets Build That App

通过Caffeine Coding为 NodeJS 提供更好的快速路由和架构

Express.js - 文档 - 路由

Express.js - GitHub 回购 - 路由分离示例

如何在 Node.js 和 Express 4 上分离路由？

如何在 Express 的多个文件中包含路由处理程序？

Express js：将多个路由文件合并为单个文件