Node.js & express - глобальные модули и лучшие практики для структуры приложения

Я создаю приложение node.js, которое является REST api, используя экспресс и мангуст для моего mongodb. Теперь у меня есть конечные точки CRUD, но мне было просто интересно две вещи.

Кроме того, мне бы хотелось, чтобы любые мнения о приложении в целом были новы для node, трудно понять, что то, как вы делаете что-то, является самой эффективной или "лучшей" практикой. Спасибо!

Ответы

Ответ 1

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

Каждая схема (и модель) находится в собственном файле (модуле)
Каждая группа маршрутов для определенного ресурса REST находится в собственном файле (модуле)
Каждому модулю маршрута просто require нужна модель Mongoose (всего 1)
Основной файл (точка входа приложения) всего require всех модулей маршрута для их регистрации.
Монгольское соединение находится в корневом файле и передается как параметр для того, что ему нужно.

У меня есть два подпапки под моим корнем приложения - routes и schemas.

Преимущества такого подхода заключаются в следующем:

Вы только пишете схему один раз.
Вы не загрязняете свой основной файл приложения регистрацией маршрута для 4-5 маршрутов на ресурс REST (CRUD)
Определяется только соединение DB после

Вот как выглядит конкретный файл схемы:

Файл:/schemas/theaterSchema.js

module.exports = function(db) {
        return db.model('Theater', TheaterSchema());
}

function TheaterSchema () {
        var Schema = require('mongoose').Schema;

        return new Schema({
            title: { type: String, required: true },
            description: { type: String, required: true },
            address: { type: String, required: true },
            latitude: { type: Number, required: false },
            longitude: { type: Number, required: false },
            phone: { type: String, required: false }
    });
}

Вот как выглядит набор маршрутов для определенного ресурса:

Файл:/routes/theaters.js

module.exports = function (app, options) {

    var mongoose = options.mongoose;
    var Schema = options.mongoose.Schema;
    var db = options.db;

    var TheaterModel = require('../schemas/theaterSchema')(db);

    app.get('/api/theaters', function (req, res) {
            var qSkip = req.query.skip;
            var qTake = req.query.take;
            var qSort = req.query.sort;
            var qFilter = req.query.filter;
            return TheaterModel.find().sort(qSort).skip(qSkip).limit(qTake)
            .exec(function (err, theaters) {
                    // more code
            });
    });

    app.post('/api/theaters', function (req, res) {
      var theater;

      theater.save(function (err) {
        // more code
      });
      return res.send(theater);
    });

    app.get('/api/theaters/:id', function (req, res) {
      return TheaterModel.findById(req.params.id, function (err, theater) {
        // more code
      });
    });

    app.put('/api/theaters/:id', function (req, res) {
      return TheaterModel.findById(req.params.id, function (err, theater) {
        // more code
      });
    });

    app.delete('/api/theaters/:id', function (req, res) {
      return TheaterModel.findById(req.params.id, function (err, theater) {
        return theater.remove(function (err) {
          // more code
        });
      });
    });
};

И вот файл корневого приложения, который инициализировал соединение и регистрирует все маршруты:

Файл: app.js

var application_root = __dirname,
        express = require('express'),
        path = require('path'),
        mongoose = require('mongoose'),
        http = require('http');

var app = express();

var dbProduction = mongoose.createConnection('mongodb://here_insert_the_mongo_connection_string');

app.configure(function () {
        app.use(express.bodyParser());
        app.use(express.methodOverride());
        app.use(app.router);
        app.use(express.static(path.join(application_root, "public")));
        app.use('/images/tmb', express.static(path.join(application_root, "images/tmb")));
        app.use('/images/plays', express.static(path.join(application_root, "images/plays")));
        app.use(express.errorHandler({ dumpExceptions: true, showStack: true }));
});

app.get('/api', function (req, res) {
        res.send('API is running');
});

var theatersApi = require('./routes/theaters')(app, { 'mongoose': mongoose, 'db': dbProduction });
// more code

app.listen(4242);

Надеюсь, это было полезно.

Ответ 2

Я нашел сообщение StackOverflow очень полезным:

Структура файла проекта Mongoose и NodeJS

Трюк заключается в том, чтобы поместить вашу схему в каталог models. Затем в любом маршруте вы можете require('../models').whatever.

Кроме того, я обычно запускаю db-соединение mongoose в app.js и запускаю только сервер Express после завершения соединения:

mongoose.connect('mongodb://localhost/whateverdb')
mongoose.connection.on('error', function(err) {
  console.log("Error while connecting to MongoDB:  " + err);
  process.exit();
});
mongoose.connection.on('connected', function(err) {
  console.log('mongoose is now connected');
  // start app here
  http.createServer(app).listen(app.get('port'), function(){
    console.log('Express server listening on port ' + app.get('port'));
  });

});

Ответ 3

Я бы посмотрел на этот проект https://github.com/madhums/node-express-mongoose-demo. Это отличный пример того, как создать приложение nodejs стандартным способом.