是否有app.js
在Express.js应用程序中分解和模块化文件的通用约定?还是将所有内容保存在一个文件中很常见?
是否有app.js
在Express.js应用程序中分解和模块化文件的通用约定?还是将所有内容保存在一个文件中很常见?
Answers:
我的分解如下:
~/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
我使用Exports返回相关内容。例如,在模型中,我这样做:
module.exports = mongoose.model('PhoneNumber', PhoneNumberSchema);
然后,如果我需要创建一个电话号码,它非常简单:
var PhoneNumber = require('../models/phoneNumber');
var phoneNumber = new PhoneNumber();
如果我需要使用架构,那么 PhoneNumber.schema
(假设我们正在routes文件夹中工作,需要先上一层然后再下一层模型)
该快递维基具有建立在它之上的框架的列表。
其中,我认为Twitter的斗牛士的结构非常好。实际上,我们使用了非常类似的方法来加载应用程序的各个部分。
derby.js看起来也非常有趣。它类似于流星,没有所有的炒作,实际上在应归功于信用的地方给予了荣誉(特别是节点和特快)。
如果您是CoffeeScript的粉丝(我不是),并且又希望使用Rails的L&F,那么还有Tower.js。
如果您熟悉Rails,并且不介意某些概念的泛滥,那么您可以使用Locomotive。它是基于Express构建的轻量级框架。它具有与RoR非常相似的结构,并且继承了一些更基本的概念(例如路由)。
即使您不打算使用它,也值得一试。
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");
};
好吧,它将所有服务器初始化设置拆分为漂亮的块。特别
app.configure
)例如,让我们看一下路由文件
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
)被调用时可以。在服务器启动时调用同步阻塞调用只会使代码更具可读性(基本上是hack)
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打孔以实际使用授权,而不是让任何tom和jack与我的socket.io服务器进行通信
routes.forEach(function(file) {
var route = require(routeUrl + file),
model = require(modelUrl + file);
route(app, model, io);
});
};
在这里,我通过将相关模型传递到从路由文件返回的每个路由对象中来开始路由。
基本上,基本原则是将所有内容组织到漂亮的小模块中,然后具有一些自举机制。
我的另一个项目(我的博客)有一个具有类似结构的init文件。
免责声明:博客已损坏且无法构建,我正在努力。
为了维护路由组织你可以看看这篇文章有关的明示,routescan节点模块和尝试。这对我来说是最好的解决方案。
我的应用程序基于express-generator工具构建。您可以通过运行安装它, 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;
希望这有助于回答您的问题!祝你好运!