Как структурировать приложение на ExpressJS? [закрыто]

Вместо экспорта функции или других модулей, мне больше нравится использовать глобальный объект "app". Это позволяет централизованно управлять состоянием и конфигурацией приложения, а также облегчает доступ к другим компонентам. Однако стоит учитывать, что использование глобальных переменных может привести к различным проблемам, например, трудностям с тестированием и поддержкой кода. Если вы все же решите использовать глобальный "app", постарайтесь минимизировать его использование, чтобы избежать потенциальных конфликтов и сделать код более чистым и понятным.

Мой вопрос был задан в апреле 2011 года, и он довольно старый. За это время я смог улучшить свои навыки работы с Express.js и понять, как архитектурировать приложение, написанное с использованием этой библиотеки. Поэтому я делюсь здесь своим опытом.

Вот структура директорий моего приложения:

├── app.js   // основной файл
├── config   // Конфигурация моего приложения (логгер, глобальные настройки и т.д.)
├── models   // Модели данных (например, модель Mongoose)
├── public   // Публичный каталог (код на стороне клиента)
├── routes   // Определения и реализации маршрутов
├── services // Отдельные сервисы (сервис базы данных, сервис электронной почты и т.д.)
└── views    // Шаблоны, которые рендерит сервер для клиента (например, Jade, EJS и т.д.)

App.js

Цель файла app.js — инициализация приложения на основе Express.js. Он загружает модуль конфигурации, модуль логгирования, ожидает подключения к базе данных и запускает сервер.

'use strict';
require('./config');
var database = require('./services/database');
var express = require('express');
var app = express();
module.exports = app;

function main() {
  var http = require('http');

  // Конфигурируем приложение.
  app.configure(function () {
    // ... ... ...
  });
  app.configure('production', function () {
    // ... ... ...
  });
  app.configure('development', function () {
    // ... ... ...
  });

  var server = http.createServer(app);

  // Загружаем все маршруты.
  require('./routes')(app);

  // Слушаем на http порту.
  server.listen(3000);
}

database.connect(function (err) {
  if (err) { 
    // ...
  }
  main();
});

routes/

В директории маршрутов есть файл index.js. Его задача — динамически загружать все остальные файлы, находящиеся в директории routes/. Вот его реализация:

/**
 * Этот модуль динамически загружает все модули маршрутов, расположенные в каталоге routes/
 */
'use strict';
var fs = require('fs');
var path = require('path');

module.exports = function (app) {
  fs.readdirSync('./routes').forEach(function (file) {
    // Избегаем чтения текущего файла.
    if (file === path.basename(__filename)) { return; }

    // Загружаем файл маршрута.
    require('./' + file)(app);
  });
};

С помощью этого модуля создание нового определения и реализации маршрута становится очень простым. Например, hello.js:

function hello(req, res) {
  res.send('Hello world');
}

module.exports = function (app) {
  app.get('/api/hello_world', hello);
};

Каждый модуль маршрута является независимым.

Я считаю, что это отличный способ реализации. Это не ограничивается только Express, но я замечал довольно много проектов на Node.js на GitHub, которые делают то же самое. Они выносят параметры конфигурации и разбивают меньшие модули (в некоторых случаях каждую URI) на отдельные файлы.

Я бы рекомендовал просмотреть проекты, специфичные для Express, на GitHub, чтобы получить представление. На мой взгляд, тот подход, который вы используете, совершенно верен.

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

 myapp   
|
|
|____app
|      |____controllers
|      |    |____home.js
|      |
|      |____models
|      |     |___home.js
|      |
|      |____views
|           |___404.ejs
|           |___error.ejs
|           |___index.ejs
|           |___login.ejs
|           |___signup.ejs
|   
|
|_____config
|     |___auth.js
|     |___constants.js
|     |___database.js
|     |___passport.js
|     |___routes.js
|
|
|____lib
|    |___email.js
|
|____node_modules
|
|
|____public.js
|    |____css
|    |    |__style.css
|    |    
|    |____js
|    |    |__script.js
|    |
|    |____img
|    |    |__img.jpg
|    |
|    |____uploads
|         |__img.jpg
|      
|   
|
|_____app.js
|
|
|
|_____package.json

Я создал npm модуль для генерации структуры папок в формате Express MVC. Вы можете найти его по следующей ссылке: express-mvc-generator.

Вот простые шаги для генерации и использования этого модуля:

1. Установите модуль: npm install express-mvc-generator -g
2. Проверьте доступные опции: express -h
3. Генерируйте структуру Express MVC: express myapp
4. Установите зависимости: npm install
5. Откройте файл config/database.js, чтобы настроить ваше подключение к MongoDB.
6. Запустите приложение: node app или nodemon app
7. Перейдите по URL: http://localhost:8042/signup или http://ваш_IP:8042/signup

Надеюсь, эта информация поможет вам настроить ваше приложение! Если у вас есть дополнительные вопросы, не стесняйтесь спрашивать.

Я не думаю, что добавление маршрутов в конфигурацию — это хороший подход. Лучше использовать такую структуру:

application/
| - app.js
| - config.js
| - public/ (статические файлы - js, css, изображения)
| - views/ (все ваши файлы представлений)
| - libraries/ (это также можно назвать модулями или маршрутами/)
    | - users.js
    | - products.js
    | - и т.д...

Таким образом, файлы products.js и users.js будут содержать все ваши маршруты и всю логику внутри.