如何从我的Express应用程序中将server.js中的代码抽象到子目录中?

时间:2017-04-18 19:17:08

标签: javascript node.js mongodb express directory-structure

我是Node的新手,我正在尝试使用Express和MongoDB为我构建的网络应用构建一个API。我正在学习一些教程,并且我有一些基本的路由,但是现在我的所有代码都存在于一个文件server.js中。我想将其中的一部分移到子目录中以更好地组织代码。我怎么能这样做?

var express = require('express'),
    mongoose = require('mongoose'),
    app = express();

var userSchema = new mongoose.Schema({
    email: {
        type: String
    },
    password: {
        type: String
    }
});

var UserModel = mongoose.model('user', userSchema);

app.use(function(req, res, next) {
    res.setHeader('Access-Control-Allow-Origin', 'http://localhost:4200');
    res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
    res.header('Access-Control-Allow-Methods', 'POST, GET, PUT, DELETE, OPTIONS');
    next();
});

mongoose.connect('mongodb://localhost/mymongocollection');

app.get('/user', function(req,res) {
    // do something
});

app.post('/user', function(req,res) {
    // do something
});

app.listen('4500');

我认为这是有道理的:

- server.js
- routes/
  - user.js
- models/
  - user.js

server.js内,我似乎正在使用require()

var userModel = require('models/user.js);

我已经在Node和module中了解了module.exports,但我还没有完全理解它。这有什么作用?

最后,用户架构应该放在models/user.js文件中吗?或者应该将模式存放在他们自己的目录中?

2 个答案:

答案 0 :(得分:0)

我可能已经想到了这一点。它似乎工作,但我想确认这确实是正确的方法。这种结构是否允许我轻松添加新模型和路线?我认为这只是意味着我需要不断将appmongoose传递给我的模型和路线。

<强> server.js

var express = require('express'),
    mongoose = require('mongoose'),
    app = express();

// set headers

app.use(function(req, res, next) {
    res.setHeader('Access-Control-Allow-Origin', 'http://localhost:4200');
    res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
    res.header('Access-Control-Allow-Methods', 'POST, GET, PUT, DELETE, OPTIONS');
    next();
});

// connect

mongoose.connect('mongodb://localhost/mymongocollection');

// models

var UserModel = require('./models/user.js')(mongoose);

// routes

var userRoutes = require('./routes/user.js')(app, UserModel);

// listener

app.listen('4500');

<强>模型/ user.js的

module.exports = function(mongoose) {

    var userSchema = new mongoose.Schema({
        email: {
            type: String,
        },
        password: {
            type: String,
        }
    });

    return mongoose.model('user', userSchema);
};

<强>路由/ user.js的

module.exports = function(app, UserModel) {

    app.get('/user', function(req,res) {
        // do something
    });

    app.post('/user', function(req,res) {
        // do something
    });
};

答案 1 :(得分:0)

构建节点应用程序确实没有正确或错误的方法,只要它有效。这主要取决于个人偏好。有了这样的说法,有一些惯例经常被用来帮助保持组织和理智。

构建应用程序的两种主要方式是根据模块类型(路由,模型等)或基于功能(用户,产品等)分离文件

示例方法1

+ app
  + routes
    - user.js
    - product.js
  + models
    - user.js
    - product.js
- config.js
- server.js

示例方法2

+ app
  + user
    - model.js
    - route.js
  + product
    - model.js
    - route.js
- config.js
- server.js

就我个人而言,我的设置通常类似于:

+ app
  + controllers
    - user.js
    - product.js
  + models
    - user.js
    - product.js
  + templates
    - user.html
    - product.html
  + utils
    - some_cool_thing.js
  - config.js
  - router.js
  - server.js

我有一个大的router.js,其中包含整个应用程序的路由,而不是为每个功能分解路由。每个路由的所有逻辑都包含在controllers目录中的文件中。绝不是这种典型/完美/或理想的。这只是我个人的偏好。

现在就实际文件而言,您拥有的内容非常接近,但您应该尽量避免将appmongoose对象传递给其他模块。每个模块应尽可能与应用程序的其余部分隔离。如果你的模型需要mongoose简单require mongoose模块而不是传入它。在路由中,你将使用快速路由器,然后从路由模块导出路由器,然后你需要并使用应用程序中的路由模块。

示例:

<强> server.js

var express = require('express'),
    mongoose = require('mongoose'),
    router = require('./router'), // this is your router.js file
    app = express();

// connect
mongoose.connect('mongodb://localhost/mymongocollection');

// routes
app.use('/', router); // use your routes on the root of the application
// app.use('/api', router); // you could easily use your routes prefixed with `/api`

// listener
app.listen('4500');

<强> router.js

var router = require('express').Router(); // https://expressjs.com/en/4x/api.html#router

// controllers
var Users = require('./controllers/user.js');
var Products = require('./controllers/products.js');

// routes
router.route('/user')
.get(Users.findAll)
.post(Users.create);

router.route('/users/:id')
.get(Users.findOne)
.put(Users.update)
.delete(Users.remove);

...

<强>控制器/ user.js的

var UserModel = require('../models/user.js');

exports.findAll = function(req, res, next) {
    UserModel.find(function(err, users) {
        if (err) return next(err);

        res.send(users);
    }
}

exports.create = function(req, res, next) {
    var user = new UserModel();  

    user.name = req.body.name;

    user.save(function(err) {
        if (err) return next(err);

        res.send('user created');
    });
} 

...

<强>模型/ user.js的

var mongoose     = require('mongoose');
var Schema       = mongoose.Schema;

var UserSchema   = new Schema({
    name: String
});

module.exports = mongoose.model('User', UserSchema);

注意: 我对Mongo / Mongoose并不太熟悉,因为我已经有一段时间了,因为我在项目中使用了它们,所以语法可能有点过时了。以上示例仅用于说明目的,尚未经过测试或调试。