Question

在 Express.js 应用程序中是否存在分解和模块化app.js文件的通用约定？或者将所有内容保存在一个文件中是否常见？

Answer 1

我的分手如下：

~/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

（假设我们正在路线文件夹中工作，需要升级1级，然后转到模型）

编辑4

express wiki 有一个基于它构建的框架列表。

其中，我认为Twitter的 matador 结构非常好。我们实际上使用了一种非常类似的方法来加载部分应用程序。

derby.js 也非常有趣。它类似于meteor没有所有的炒作，实际上在信用到期时给予信用（特别是节点和快递）。

编辑3

如果你是CoffeeScript的粉丝（我不是）并且想要R＆amp; F of Rails，那么还有 Tower.js 。

编辑2

如果您熟悉Rails并且不介意某些概念的流血，那么 Locomotive 。它是一个基于Express的轻量级框架。它具有与RoR非常相似的结构，并且带有一些更基本的概念（例如路由）。

即使您不打算使用它，也值得一试。

编辑1

nodejs-express-mongoose-demo 与我的结构非常相似。看看吧。

Answer 2

警告：引用我一起攻击节点淘汰的代码，它有点工作，但远非优雅或抛光。

要更具体地分割app.js我有以下app.js文件

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

bootstrap(app);

这基本上意味着我将所有引导放在一个单独的文件中，然后我引导服务器。

那么bootstrap做了什么？

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");
};

好吧它以漂亮的块分割所有服务器初始化设置。具体来说

我有一个使用everyauth设置所有远程OAuth身份验证的块。
我有一个配置我的应用程序的块（基本上是调用app.configure）
我有一些代码可以减少，所以它会在运行时重新编译我的任何一个css。
我有设置所有路线的代码
我称这个小nko模块
最后，我通过收听端口来启动服务器。

例如，让我们看一下routing文件

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打到实际使用授权，而不是让任何tom和jack与我的socket.io服务器通信

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

这里我通过将相关模型传递到路径文件返回的每个路径对象来启动路径。

基本上，jist是你将所有东西组织成漂亮的小模块，然后有一些引导机制。

我的其他项目（我的博客）has an init file with a similar structure。

免责声明：博客已损坏且无法构建，我正在努力。

Answer 3

对于可维护的路由组织，您可以查看有关this article的the express-routescan node module并尝试一下。这对我来说是最好的解决方案。

Answer 4

我的应用程序建立在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;

希望这有助于回答您的问题！祝你好运！

如何构建express.js应用程序？

4 个答案:

编辑4

编辑3

编辑2

编辑1