【Node Hero】7. Node.js 项目结构

张红新发布于2019-08-20 19:06 / 2468人阅读

摘要：本教程会学习如何正确组织一个项目的结构，从而在应用程序开始增长时避免混乱。项目结构的五个基本规则组织项目有不少可能的方式并且每种已知的方式都有其兴衰。过去在，我们有机会创建各种规模的高效应用程序，也获得了大量关于项目结构注意事项的见解。

本文转载自：众成翻译
译者：网络埋伏纪事
链接：http://www.zcfy.cc/article/1756
原文：https://blog.risingstack.com/node-hero-node-js-project-structure-tutorial/

大多数 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 验证用户身份。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/85139.html

【Node Hero】1. 开始使用 Node.js

摘要：使用一个事件驱动的非阻塞式的模型，让它轻量而高效。也就是说提供了用编写服务器的可能性，这种服务器具有令人难以置信的性能。正如官方声明所说是一个使用与浏览器相同引擎的运行时。这意味着有两个发布版本稳定版和试验版。本文转载自：众成翻译译者：网络埋伏纪事链接：http://www.zcfy.cc/article/1748原文：https://blog.risingstack.com/nod...

hqman 2019-08-20 18:59 评论0 收藏0
【Node Hero】8. 使用 Passport.js 进行 Node.js 身份验证

摘要：本文转载自众成翻译译者网络埋伏纪事链接原文本教程中将学习如何使用和实现一个本地身份验证策略。我们将有一个用户页，一个备注页，和一些与身份验证相关的功能。下一步下一章主要涉及应用程序的单元测试。你会学习单元测试测试金字塔测试替代等概念。本文转载自：众成翻译译者：网络埋伏纪事链接：http://www.zcfy.cc/article/1755原文：https://blog.risings...

CoderStudy 2019-08-20 19:07 评论0 收藏0
【Node Hero】6. Node.js Request 模块

摘要：状态码描述了请求的结果，它对错误处理是必不可少的。响应还没完成成功这些状态码表示请求被接收并正确处理了。服务器错误当服务器由于某些错误不能完成有效的请求时，就发送这些状态码。本文转载自：众成翻译译者：网络埋伏纪事链接：http://www.zcfy.cc/article/1758原文：https://blog.risingstack.com/node-hero-node-js-req...

BlackHole1 2019-08-20 19:06 评论0 收藏0
【Node Hero】4. 第一个 Node.js HTTP 服务器

摘要：本文转载自众成翻译译者网络埋伏纪事链接原文本章我会指导你启动一个简单的服务器，并开始为请求服务。现在，我们开始创建第一个服务器我们将模块，并将服务器绑定到端口来监听。必须用如下方式启动服务器总结本章学习了如何从头开始创建第一个服务器。本文转载自：众成翻译译者：网络埋伏纪事链接：http://www.zcfy.cc/article/1750原文：https://blog.risings...

Coly 2019-08-20 18:59 评论0 收藏0
【Node Hero】3. 理解异步编程

摘要：异步编程在传统编程实践中，大多数操作都是同步发生的。中的异步编程异步是一种输入输出处理的形式，它允许在传输完成之前，其它处理能继续进行。本文转载自：众成翻译译者：网络埋伏纪事链接：http://www.zcfy.cc/article/1759原文：https://blog.risingstack.com/node-hero-async-programming-in-node-js/ ...

kevin 2019-08-20 18:59 评论0 收藏0