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

У меня есть проект достойного размера, и мне нужно сделать небольшую реструктуризацию.

Я использую mongoose как свой ORM для node. Я хотел бы поместить все мои модели mongoose в папку под названием "модели". Я прочитал, что когда я это делаю, я могу поместить файл index.js в папку с образцами, так что он будет тянуть во всех моделях и хранить их.

app.js:

...
var mongoose = require('mongoose');
var models = require('./models')(mongoose);

app.configure(function () {
  mongoose.connect(dbPath, function(err) {
    if (err) throw err;
  });
  ...
});

// include models in my routes so I need access
...

Я зациклился на том, что мне нужно сделать в index.js, чтобы вернуть все мои модели.

index.js(это то, что я пробовал, даже не закрыл)

function Models(mongoose) {
    var Counters = require('./counters')(mongoose);
    var User = require('./user')(mongoose);
    var Token = require('./token')(mongoose);
    var Team = require('./team')(mongoose);
    var Role =  require('./role')();
    var Layer = require('./layer')(mongoose, counters);
    var Feature = require('./feature')(mongoose, counters, async);


}

module.exports = Models;

Также должен ли я проходить в mongoose из app.js, так как мне там нужно было подключиться к монго? И.Е. Я могу потребовать его снова в index.js, но я не уверен, что требование о том же модуле в разных файлах - плохая практика.

EDIT: (здесь мои модели)

Извините, забыл упомянуть, что я добавляю функции типа "accessor" в своих классах моделей. И.Е. Я хотел бы представить публичный интерфейс для каждой модели.

user.js:

module.exports = function(mongoose) {

  // Creates a new Mongoose Schema object
  var Schema = mongoose.Schema; 

  // Collection to hold users
  var UserSchema = new Schema({
      username: { type: String, required: true },
      password: { type: String, required: true },
    },{ 
      versionKey: false 
    }
  );

  // Creates the Model for the User Schema
  var User = mongoose.model('User', UserSchema);

  var getUserById = function(id, callback) {
    User.findById(id, callback);
  }

  var getUserByUsername = function(username, callback) {
    var query = {username: username};
    User.findOne(query, callback);
  }


  return {
    getUserById: getUserById,
    getUserByUsername: getUserByUsername
  }
}

Ответ 1

В node.js модули кэшируются после первого раза загрузки. Поэтому вам не нужно передавать mongoose из app.js.

Например, в моделях /index.js:

require('./counters')
exports.User = require('./user')
require('./token');
require('./team');
require('./role');
require('./layer');
require('./feature');
// I prefer to use a loop to require all the js files in the folder.

в моделях /user.js:

var mongoose = require('mongoose');
var userSchema = mongoose.Schema({
  // ... Define your schema here
});

var User = module.exports = mongoose.model('User', userSchema);
module.exports.getUserById = function(id, callback) {
  User.findById(id, callback);
}

module.exports.getUserByUsername = function(username, callback) {
  var query = {username: username};
  User.findOne(query, callback);
}

в app.js:

var mongoose = require('mongoose');
var models = require('./models');

mongoose.connect(dbPath, function(err) {
  if (err) throw err;
});

// Yes! You can use the model defined in the models/user.js directly
var UserModel = mongoose.model('User');

// Or, you can use it this way:
UserModel = models.User;

app.get('/', function(req, res) {
  var user = new UserModel();
  user.name = 'bob';
  user.save();
  // UserModel.getUserByUsername();
  ...
});

Подробнее о кэшировании модулей в node.js: http://nodejs.org/api/modules.html#modules_caching

Ответ 2

Другим очень приятным подходом ко всем моделям простым и понятным способом может быть следующий:

Структура проекта:

.   
├── app.js
└── models
    ├── Role.js
    ├── Team.js
    └── User.js

app.js

const fs = require('fs');
const path = require('path');

const modelsPath = path.resolve(__dirname, 'models')
fs.readdirSync(modelsPath).forEach(file => {
  require(modelsPath + '/' + file);
})