Как структурировать приложение express.js?

Есть ли общее соглашение о разбиении и разбиении app.jsфайла на модули в приложении Express.js ? Или принято хранить все в одном файле?

Я разбил мою следующим образом:

~/app
|~controllers
| |-monkey.js
| |-zoo.js
|~models
| |-monkey.js
| |-zoo.js
|~views
| |~zoos
|   |-new.jade
|   |-_form.jade
|~test
|  |~controllers
|    |-zoo.js
|  |~models
|    |-zoo.js
|-index.js

Я использую экспорт, чтобы вернуть то, что имеет значение. Например, в моделях, которые я делаю:

module.exports = mongoose.model('PhoneNumber', PhoneNumberSchema);

а затем, если мне нужно создать номер телефона, это очень просто:

var PhoneNumber = require('../models/phoneNumber');
var phoneNumber = new PhoneNumber();

если мне нужно использовать схему, то PhoneNumber.schema

(что предполагает, что мы работаем из папки маршрутов и нам нужно подняться на 1 уровень вверх, а затем вниз к моделям)

РЕДАКТИРОВАТЬ 4

В экспресс-вики есть список фреймворков, построенных поверх нее.

Из них я думаю, что матадор Twitter структурирован довольно хорошо. На самом деле мы использовали очень похожий подход к тому, как они загружают части приложения.

derby.js тоже выглядит очень интересно. Это сродни метеору без всякой шумихи и действительно дает кредит там, где он должен быть (в частности, node и express).

РЕДАКТИРОВАТЬ 3

Если вы поклонник CoffeeScript (а я нет) и действительно хотите L&F от Rails, есть еще Tower.js .

РЕДАКТИРОВАТЬ 2

Если вы знакомы с Rails и не возражаете против перетекания некоторых концепций, то есть Locomotive . Это легкий фреймворк, построенный на Express. Он имеет очень похожую структуру, что и RoR, и переносит некоторые из более элементарных концепций (например, маршрутизацию).

Стоит проверить, даже если вы не планируете его использовать.

ИЗМЕНИТЬ 1

nodejs-express-mongoose-demo очень похож на мою структуру. Проверить это.

Предупреждение: ссылка на код, который я собрал вместе для нокаута узла, вроде работает, но далеко не элегантен или отполирован.

Чтобы быть более конкретным о разделении, у app.jsменя есть следующий файл app.js

var express = require('express'),
    bootstrap = require('./init/bootstrap.js'),
    app = module.exports = express.createServer();

bootstrap(app);

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

Так что же делает бутстрап ?

var configure = require("./app-configure.js"),
    less = require("./watch-less.js"),
    everyauth = require("./config-everyauth.js"),
    routes = require("./start-routes.js"),
    tools = require("buffertools"),
    nko = require("nko"),
    sessionStore = new (require("express").session.MemoryStore)()

module.exports = function(app) {
    everyauth(app);
    configure(app, sessionStore);
    less();
    routes(app, sessionStore);
    nko('/9Ehs3Dwu0bSByCS');


    app.listen(process.env.PORT);
    console.log("server listening on port xxxx");
};

Он разбивает все настройки инициализации сервера на красивые куски. В частности

• У меня есть блок, который настраивает всю мою удаленную аутентификацию OAuth с использованием everyauth.
• У меня есть блок, который настраивает мое приложение (в основном вызывающий app.configure)
• У меня есть немного кода, который меньше пробивает, поэтому он повторно компилирует любой из моих less в css во время выполнения.
• У меня есть код, который настраивает все мои маршруты
• Я называю этот небольшой модуль nko
• Наконец, я запускаю сервер, прослушивая порт.

Например, давайте посмотрим на файл маршрутизации

var fs = require("fs"),
    parseCookie = require('connect').utils.parseCookie;

module.exports = function(app, sessionStore) {
    var modelUrl = __dirname + "/../model/",
        models = fs.readdirSync(modelUrl),
        routeUrl = __dirname + "/../route/"
        routes = fs.readdirSync(routeUrl);

Здесь я загружаю все свои модели и маршруты в виде массивов файлов.

Отказ от ответственности: readdirSync это нормально, только если вызывается перед запуском http-сервера (раньше .listen). Вызов синхронных вызовов блокировки во время запуска сервера просто делает код более читабельным (в основном это взлом)

    var io = require("socket.io").listen(app);

    io.set("authorization", function(data, accept) {
        if (data.headers.cookie) {
            data.cookie = parseCookie(data.headers.cookie);

            data.sessionId = data.cookie['express.sid'];

            sessionStore.get(data.sessionId, function(err, session) {

                if (err) {
                    return accept(err.message, false);
                } else if (!(session && session.auth)) {
                    return accept("not authorized", false)
                }
                data.session = session;
                accept(null, true);
            });
        } else {
            return accept('No cookie', false);
        }
    });

Здесь я нажимаю socket.io, чтобы фактически использовать авторизацию, а не позволять любому тому и джеку разговаривать с моим сервером socket.io

    routes.forEach(function(file) {
        var route = require(routeUrl + file),
            model = require(modelUrl + file);

        route(app, model, io);
    });
};

Здесь я начинаю свои маршруты с передачи соответствующей модели в каждый объект маршрута, возвращаемый из файла маршрута.

По сути, суть состоит в том, чтобы вы организовали все в красивые маленькие модули, а затем получили какой-то механизм начальной загрузки.

В другом моем проекте (в моем блоге) есть файл инициализации с аналогичной структурой .

Отказ от ответственности: блог сломан и не строится, я над этим работаю.

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

Мои приложения создаются на основе инструмента экспресс-генератора. Вы можете установить его, запустив npm install express-generator -gи запустить с помощью express <APP_NAME>.

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

~/
|~bin
| |-www
|
|~config
| |-config.json
|
|~database
| |-database.js
|
|~middlewares
| |-authentication.js
| |-logger.js
|
|~models
| |-Bank.js
| |-User.js
|
|~routes
| |-index.js
| |-banks.js
| |-users.js
|
|~utilities
| |-fiat-converersion.js
|
|-app.js
|-package.json
|-package-lock.json

Одна крутая вещь, которая мне нравится в этой структуре, которую я в конечном итоге использую для любого разрабатываемого мной экспресс-приложения, - это способ организации маршрутов. Мне не нравилось запрашивать каждый файл маршрута в app.js и app.use()каждый маршрут, особенно когда файл становится больше. Таким образом, я нашел полезным сгруппировать и централизовать все мои app.use()файлы в файле ./routes/index.js.

В итоге мой app.js будет выглядеть примерно так:

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

...
require('./routes/index')(app);

и мой ./routes/index.js будет выглядеть примерно так:

module.exports = (app) => {
  app.use('/users', require('./users'));
  app.use('/banks', require('./banks'));
};

Я могу это сделать просто require(./users)потому, что написал пользовательский маршрут с помощью express.Router (), который позволяет мне «группировать» несколько маршрутов, а затем экспортировать их сразу, с целью сделать приложение более модульным.

Это пример того, что вам подходит на моем маршруте ./routers/users.js:

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

router.post('/signup', async (req, res) => {
    // Signup code here
});

module.exports = router;

Надеюсь, это помогло ответить на ваш вопрос! Удачи!