Express: как передать экземпляр приложения в маршруты из другого файла?

Я хочу разбить свои маршруты на разные файлы, где один файл содержит все маршруты, а другой - соответствующие действия. В настоящее время у меня есть решение для этого, однако мне нужно сделать экземпляр приложения глобальным, чтобы иметь к нему доступ в действиях. Моя текущая установка выглядит так:

app.js:

var express   = require('express');
var app       = express.createServer();
var routes    = require('./routes');

var controllers = require('./controllers');
routes.setup(app, controllers);

app.listen(3000, function() {
  console.log('Application is listening on port 3000');
});

routes.js:

exports.setup = function(app, controllers) {

  app.get('/', controllers.index);
  app.get('/posts', controllers.posts.index);
  app.get('/posts/:post', controllers.posts.show);
  // etc.

};

контроллеры / index.js:

exports.posts = require('./posts');

exports.index = function(req, res) {
  // code
};

контроллеры / posts.js:

exports.index = function(req, res) {
  // code
};

exports.show = function(req, res) {
  // code
};

Однако у этой настройки есть большая проблема: у меня есть база данных и экземпляр приложения, которые мне нужно передать действиям (controllers / *. Js). Единственный вариант, который я мог придумать, - это сделать обе переменные глобальными, что на самом деле не является решением. Я хочу отделить маршруты от действий, потому что у меня много маршрутов и я хочу, чтобы они находились в центре.

Как лучше всего передать переменные действиям, но отделить действия от маршрутов?

Использование req.app,req.app.get('somekey')

Переменная приложения, созданная при вызове express(), устанавливается для объектов запроса и ответа.

См. Https://github.com/visionmedia/express/blob/76147c78a15904d4e4e469095a29d1bec9775ab6/lib/express.js#L34-L35

Node.js поддерживает циклические зависимости.
Использование циклических зависимостей вместо require ('./ routes') (app) очищает большой объем кода и делает каждый модуль менее зависимым от своего файла загрузки:

var app = module.exports = express(); //now app.js can be required to bring app into any file

//some app/middleware setup, etc, including 
app.use(app.router);

require('./routes'); //module.exports must be defined before this line

var app = require('../app');

app.get('/', function(req, res, next) {
  res.render('index');
});

//require in some other route files...each of which requires app independently
require('./user');
require('./blog');

Пример из их нового генератора:
Написание маршрута:
https://github.com/expressjs/generator/blob/master/templates/js/routes/index.js
Добавление / размещение его в приложении: https://github.com /expressjs/generator/blob/master/templates/js/app.js#L24

Есть еще варианты использования для доступа к приложению из других ресурсов, поэтому циклические зависимости по-прежнему являются допустимым решением.

Как я уже сказал в комментариях, вы можете использовать функцию как module.exports. Функция также является объектом, поэтому вам не нужно менять синтаксис.

app.js

var controllers = require('./controllers')({app: app});

controllers.js

module.exports = function(params)
{
    return require('controllers/index')(params);
}

контроллеры / index.js

function controllers(params)
{
  var app = params.app;

  controllers.posts = require('./posts');

  controllers.index = function(req, res) {
    // code
  };
}

module.exports = controllers;

Или просто сделайте это:

var app = req.app

внутри промежуточного программного обеспечения, которое вы используете для этих маршрутов. Как это:

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

Допустим, у вас есть папка с именем «contollers».

В свой app.js вы можете поместить этот код:

console.log("Loading controllers....");
var controllers = {};

var controllers_path = process.cwd() + '/controllers'

fs.readdirSync(controllers_path).forEach(function (file) {
    if (file.indexOf('.js') != -1) {
        controllers[file.split('.')[0]] = require(controllers_path + '/' + file)
    }
});

console.log("Controllers loaded..............[ok]");

... и ...

router.get('/ping', controllers.ping.pinging);

в вашем контроллере forlder у вас будет файл "ping.js" с таким кодом:

exports.pinging = function(req, res, next){
    console.log("ping ...");
}

И вот оно ....

1. Чтобы сделать ваш объект db доступным для всех контроллеров, не передавая его повсюду: создайте промежуточное программное обеспечение уровня приложения, которое присоединяет объект db к каждому объекту req, после чего вы можете получить к нему доступ в каждом контроллере.

// app.js
let db = ...;  // your db object initialized
const contextMiddleware = (req, res, next) => {
  req.db=db;
  next();
};
app.use(contextMiddleware);

2. чтобы избежать передачи экземпляра приложения повсюду, вместо этого передавайте маршруты туда, где приложение

// routes.js  It's just a mapping.
exports.routes = [
  ['/', controllers.index],
  ['/posts', controllers.posts.index],
  ['/posts/:post', controllers.posts.show]
];

// app.js
var { routes }    = require('./routes');
routes.forEach(route => app.get(...route));
// You can customize this according to your own needs, like adding post request

Последний app.js:

// app.js
var express   = require('express');
var app       = express.createServer();

let db = ...;  // your db object initialized
const contextMiddleware = (req, res, next) => {
  req.db=db;
  next();
};
app.use(contextMiddleware);

var { routes }    = require('./routes');
routes.forEach(route => app.get(...route));

app.listen(3000, function() {
  console.log('Application is listening on port 3000');
});

Другая версия: вы можете настроить это в соответствии с вашими потребностями, например, добавить почтовый запрос

// routes.js  It's just a mapping.
let get = ({path, callback}) => ({app})=>{
  app.get(path, callback);
}
let post = ({path, callback}) => ({app})=>{
  app.post(path, callback);
}
let someFn = ({path, callback}) => ({app})=>{
  // ...custom logic
  app.get(path, callback);
}
exports.routes = [
  get({path: '/', callback: controllers.index}),
  post({path: '/posts', callback: controllers.posts.index}),
  someFn({path: '/posts/:post', callback: controllers.posts.show}),
];

// app.js
var { routes }    = require('./routes');
routes.forEach(route => route({app}));

Для базы данных выделите службу доступа к данным, которая будет выполнять всю работу с БД с помощью простого API и избегать общего состояния.

Разделение routes.setup похоже на накладные расходы. Я бы предпочел вместо этого использовать маршрутизацию на основе конфигурации. И настраивайте маршруты в .json или с аннотациями.