网络埋伏纪事

Node Hero - 7. Node.js 项目结构

网络埋伏纪事 · 2016-11-21翻译 · 821阅读 原文链接

大多数 Node.js 框架不会提供固定的目录结构,并且从开始就做对可能就是一个挑战。本教程会学习如何正确组织一个 Node.js 项目的结构,从而在应用程序开始增长时避免混乱。

Node.js 项目结构的五个基本规则

组织 Node.js 项目有不少可能的方式 - 并且每种已知的方式都有其兴衰。不过,根据我们的经验,开发者总想实现同样的事情:干净的代码,以及轻松添加新功能的可能性。

过去在 RisingStack,我们有机会创建各种规模的高效 Node 应用程序,也获得了大量关于项目结构注意事项的见解。

我们总结出了我们在 Node.js 开发期间贯彻的五种简单指导原则。如果你设法遵循它们的话,你的项目将会更好:

规则 1 - 围绕着功能而不是角色来组织文件

假设有如下的目录结构:

// DON'T
.
├── controllers
|   ├── product.js
|   └── user.js
├── models
|   ├── product.js
|   └── user.js
├── views
|   ├── product.hbs
|   └── user.hbs

这种方式的问题是:

  • 要理解产品页是如何工作的,就必须打开三个不同目录,需要有大量上下文切换,
  • 在 require 模块时,要写长路径:require('../../controllers/user.js')

要取代这种方式,你可以围绕产品功能/页面/组件来组织 Node.js 应用程序结构。这样做更容易理解一些:

// DO
.
├── product
|   ├── index.js
|   ├── product.js
|   └── product.hbs
├── user
|   ├── index.js
|   ├── user.js
|   └── user.hbs

规则 2 - 不要把逻辑放在 index.js 文件中

只使用这些 index.js 文件输出功能,比如:

// product/index.js
var product = require('./product')

module.exports = {  
  create: product.create
}

规则 3 - 测试文件挨着实现文件

测试不仅仅是为了检查模块是否产生预期的输出,还用来文档化你的模块(在后续章节中会学到更多有关测试的内容)。因此,如果测试文件挨着实现文件放,会更容易理解。

将附加的测试文件放在一个单独的 test 文件夹中,避免冲突。

.
├── test
|   └── setup.spec.js
├── product
|   ├── index.js
|   ├── product.js
|   ├── product.spec.js
|   └── product.hbs
├── user
|   ├── index.js
|   ├── user.js
|   ├── user.spec.js
|   └── user.hbs

规则 4 - 使用 config 目录

使用一个 config 目录放配置文件。

.
├── config
|   ├── index.js
|   └── server.js
├── product
|   ├── index.js
|   ├── product.js
|   ├── product.spec.js
|   └── product.hbs

规则 5 - 将长 npm 脚本放进 scripts 目录

为 package.json 中的附加长脚本创建一个单独的目录。

.
├── scripts
|   ├── syncDb.sh
|   └── provision.sh
├── product
|   ├── index.js
|   ├── product.js
|   ├── product.spec.js
|   └── product.hbs

下一步

下章将学习如何使用 Passport.js 验证用户身份

相关文章