10个Node.js最佳实践：来自Node Gurus的启示是由来宾作者Azat Mardan撰写的。 SitePoint来宾帖子旨在为您带来来自Web社区知名作家和演讲者的引人入胜的内容。

在我上一篇文章《 2017年成为更好的Node Developer的十个技巧》中 ，我介绍了今天可以应用于代码的10个Node.js技巧，窍门和技术。 这篇文章将继续提供10种最佳实践，以帮助您将Node技能提升到一个新的水平。 这是我们要介绍的内容：

1. 使用npm脚本 -当您可以使用npm脚本和Node更好地组织bash脚本时，请停止编写bash脚本。 例如， npm run build ， start和test 。 当Node开发人员查看新项目时，npm脚本就像真相的唯一来源。
2. 使用env vars-通过将process.env.NODE_ENV设置为development或production来使用它。 某些框架也将使用此变量，因此请遵循惯例。
3. 了解事件循环 setImmediate()不是立即，而nextTick()不是next。 使用setImmediate()或setTimeout()将CPU密集型任务卸载到下一个事件循环周期。
4. 使用功能继承 -通过像某些最多产的Node贡献者一样使用功能继承 ，避免陷入盲目的辩论和调试和理解原型继承或类的麻烦。
5. 适当命名事物 -提供有意义的名称，将其用作文档。 另外，请不要使用大写文件名，如果需要，请使用破折号。 文件名中的大写字母不仅看起来很奇怪，而且可能导致跨平台问题 。
6. 考虑不使用JavaScript -ES6 / 7是可悲的添加，它是在6年的会议中诞生的，当时我们已经有了一个更好的JavaScript，称为CoffeeScript。 如果您想更快地发布代码并停止浪费时间来辩论var / const / let ，分号， class和其他参数，请使用它。
7. 提供本机代码 —使用编译器时，提交本机JS代码（构建结果），以便您的项目无需构建即可运行
8. 使用gzip -h！ npm i compression -S和合理的日志记录-视环境而定，太多或更少。 npm i morgan -S
9. 向上扩展 -从Node开发的第一天开始考虑集群化和拥有无状态服务。 使用pm2或Strongloop的集群控制
10. 缓存请求 -通过将它们隐藏在诸如nginx之类的静态文件服务器和/或诸如Varnish Cache和CDN缓存之类的请求级缓存之后，来最大程度地发挥Node服务器的作用。

因此，让我们一分为二，分别看看其中的每个。 我们可以？

使用npm脚本

现在，创建用于构建，测试以及最重要的是启动应用程序的npm脚本几乎是一种标准。 这是Node开发人员在遇到新Node项目时首先要看的地方。 有些人（ 1 ， 2 ， 3 ， 4 ）甚至抛弃咕噜，咕嘟咕嘟和更低水平的喜欢，但更可靠的NPM脚本。 我完全理解他们的论点。 考虑到npm脚本具有前钩和后钩，您可以达到非常复杂的自动化水平：

"scripts": {"preinstall": "node prepare.js","postintall": "node clean.js","build": "webpack","postbuild": "node index.js","postversion": "npm publish"
}

通常，在为前端开发时，您需要运行两个或多个监视进程来重新构建代码。 例如，一个用于webpack，另一个用于nodemon。 您可以使用&&进行此操作，因为第一个命令不会释放提示。 但是，有一个方便的并发模块，它可以产生多个进程并同时运行它们。

另外，请在本地安装开发命令行工具，例如webpack，nodemon，gulp，Mocha等，以避免冲突。 例如，您可以指向./node_modules/.bin/mocha或./node_modules/.bin/mocha添加到您的bash / zsh配置文件中（路径！）：

export PATH="./node_modules/.bin:$PATH"

使用环境变量

即使在项目的早期阶段，也要使用环境变量，以确保不会泄漏敏感信息，而只是从一开始就正确构建代码。 此外，某些库和框架（我肯定Express确实可以做到）会NODE_ENV信息来修改其行为。 将其设置为production 。 MONGO_URI设置您的MONGO_URI和API_KEY值。 您可以创建一个shell文件（例如start.sh ）并将其添加到.gitignore ：

NODE_ENV=production MONGO_URL=mongo://localhost:27017/accounts API_KEY=lolz nodemon index.js

Nodemon还具有一个配置文件，您可以在其中放置环境变量（ 示例 ）：

{"env": {"NODE_ENV": "production","MONGO_URL": "mongo://localhost:27017/accounts"}
}

了解事件循环

强大而聪明的事件循环使Node如此之快和出色，它利用了浪费所有时间等待输入和输出任务完成的所有时间。 因此，Node擅长优化I / O绑定系统。

如果您需要执行一些CPU密集型工作（例如，计算，密码散列或压缩），那么除了为这些CPU任务生成新进程外，您可能还想使用setImmediate()或setTimeout() —他们的回调中的代码将在下一个事件循环周期继续。 nextTick()与名称相反，在同一循环上工作。 啊！

这是来自Bert Belder的事件循环图。 他清楚地知道事件循环的工作原理！

使用功能继承

JavaScript支持原型继承，即对象从其他对象继承。 ES6也将class运算符添加到该语言中。 但是，与功能继承相比，它明显复杂。 大多数Node专家都喜欢后者的简单性。 它是通过简单的函数工厂模式实现的，不需要使用prototype ， new或this 。 更新原型时，不会有任何隐式影响（导致所有实例也都会发生变化），因为在函数继承中，每个对象都使用自己的方法副本。

考虑一下TJ Holowaychuk的代码，TJ Holowaychuk是Express，Mocha，Connect，Superagent和许多其他Node模块背后的天才。 Express使用功能继承（ 完整的源代码 ）：

exports = module.exports = createApplication;
// ...
function createApplication() {var app = function(req, res, next) {app.handle(req, res, next);};mixin(app, EventEmitter.prototype, false);mixin(app, proto, false);app.request = { __proto__: req, app: app };app.response = { __proto__: res, app: app };app.init();return app;
}

客观地说，核心Node模块经常使用原型继承。 如果遵循该模式，请确保知道其工作方式。 您可以在此处阅读有关JavaScript继承模式的更多信息。

适当命名事物

这是显而易见的。 好名字用作文档。 您想要哪一个？

const dexter = require('morgan')
// ...
app.use(dexter('dev')) // When is the next season?

当我只看app.use()时，我不知道dexter在做什么。 如何使用另一个更有意义的名称：

const logger = require('morgan')
// ...
app.use(logger('dev')) // Aha!

以同样的方式，文件名必须正确反映内部代码的目的。 如果您查看Node的lib文件夹（ GitHub链接 ），该文件夹具有与平台捆绑的所有核心模块，那么您将看到文件/模块的明确命名（即使您对所有核心模块不是很熟悉） ）：

events.js
fs.js
http.js
https.js
module.js
net.js
os.js
path.js
process.js
punycode.js
querystring.js

内部模块标有下划线（ _debugger.js ， _http_agent.js ， _http_client.js ），就像代码中的方法和变量一样。 这有助于警告开发人员这是一个内部接口，如果您正在使用它，则您一个人使用-如果重构或删除它，请不要抱怨。

考虑不使用JavaScript

?？ 您是否正确阅读了？ 但是到底呢？ 是。 没错 即使有了ES6和ES2016 / ES7添加的两个功能，JavaScript仍然存在其怪癖。 除JavaScript以外，还有其他选项，您或您的团队只需很少的设置即可受益。 根据专业水平和应用程序的性质，使用TypeScript或Flow提供更好的键入效果可能会更好。 在频谱的另一端，是纯功能的Elm或ClojureScript 。 CoffeeScript是另一个出色且经过考验的选项。 您也可以看看Dart 2.0 。

当您只需要几个宏（使用宏即可完全构建所需的语言）而不是一种全新的语言时，请考虑可以做到这一点的Sweet.js-允许您编写生成代码的代码。

如果您采用非JavaScript路线，请仍然包括编译后的代码，因为某些开发人员可能对您的语言不太了解，无法正确构建它。 例如，VS Code是最大的TypeScript项目之一，可能在Angular 2之后，而Code使用TypeScript用类型来修补Node的核心模块。 在VS Code repo（ link ）的vscode/src/vs/base/node/中，您可以看到熟悉的模块名称，例如crypto ， process等，但带有ts扩展名。 存储库中还有其他ts文件。 但是，它们还包括带有本地JavaScript代码的vscode/build 。

知道Express中间件

Express是一个很棒且非常成熟的框架。 它的卓越之处在于允许无数其他模块来配置其行为。 因此，您需要了解最常用的中间件，并且需要了解如何使用它 。 所以，为什么不抓住我的Express速查表 。 我在那里列出了主要的中间件模块。 例如， npm i compression -S将通过缩小响应来降低下载速度。 logger('tiny')或logger('common')将分别提供更少（dev）或更多（prod）日志。

放大

节点由于其非阻塞的I / O而非常擅长异步，并且由于只有一个线程，它使这种异步编码方式保持简单。 这是一个尽早开始扩展的机会，甚至在代码的第一行也是如此。 有一个核心cluster模块，可以让您垂直扩展而不会出现太多问题。 然而，更好的方法是是使用工具，如PM2或StrongLoop的集群控制 。

例如，这是您开始使用pm2的方法：

npm i -g pm2

然后，您可以启动同一服务器的四个实例：

pm2 start server.js -i 4

对于Docker，pm2版本2+具有pm2-docker 。 因此，您的Dockerfile可能如下所示：

# ...RUN npm install pm2 -gCMD ["pm2-docker", "app.js"]

官方Alpine Linux pm2映像位于Docker Hub中 。

缓存请求

这是一个DevOps最佳实践，它将使您可以从Node实例中获取更多的汁液（使用pm2之类的资源，您可以获得更多的收益，请参见上文）。 可行的方法是让Node服务器执行诸如发出请求，处理数据和执行业务逻辑之类的应用程序工作，并将流量的静态负载转移到另一个Web服务器（例如Apache httpd或Nginx）。 同样，您可能应该使用Docker进行设置：

FROM nginxCOPY nginx.conf /etc/nginx/nginx.conf

我喜欢使用Docker compose来使多个容器（nginx，Node，Redis，MongoDB）相互配合。 例如：

web:build: ./appvolumes:- "./app:/src/app"ports:- "3030:3000"links:- "db:redis"command: pm2-docker app/server.jsnginx:restart: alwaysbuild: ./nginx/ports:- "80:80"volumes:- /www/publicvolumes_from:- weblinks:- web:webdb:image: redis

摘要

在当今开放源代码软件的时代，没有任何借口不向公开发布的受信任和经过测试的代码学习。 您无需进入内心世界。学习永无止境，我相信很快，我们将根据经历的失败和成功采取不同的最佳实践。 他们得到保证。

最后，我想写一篇关于软件如何吞噬整个世界以及JavaScript如何吞噬软件的信息……有很多很棒的东西，例如年度标准版本，大量的npm模块，工具和会议……但是，我将一言以蔽之小心点

我看到越来越多的人追求下一个新的框架或语言。 这是发亮的物体综合症。 他们每周都会学习一个新的图书馆，每个月都会学习一个新的框架。 他们强迫检查Twitter，Reddit，Hacker News和JS Weekly。 他们使用JavaScript世界中压倒性的活动来拖延。 他们有空的公共GitHub历史记录。

学习新事物是好的，但不要混淆它以实际构建事物。 重要的事情和支付薪水的东西实际上是在建造东西。 停止工程 。 您不是要建立下一个Facebook。 Promises vs.generators.async await对我来说是没有实际意义的，因为当有人在讨论中回复某个线程时，我已经写了我的回调（并且使用CoffeeScript来完成它的速度比普通ES5 / 6/7快2倍！ ）。

最终的最佳实践是使用最佳实践，而最好的则是掌握基础知识。 阅读源代码，尝试代码中的新事物，最重要的是，您自己编写大量代码。 现在，到此为止，停止阅读并发布重要的代码！

以防万一，这篇文章不够用，这里有更多关于最佳Node做法的阅读：

• https://blog.risingstack.com/nodejs-at-scale-npm-best-practices
• https://devcenter.heroku.com/articles/node-best-practices
• https://blog.risingstack.com/node-js-best-practices
• https://expressjs.com/cn/advanced/best-practice-performance.html
• https://www.codementor.io/nodejs/tutorial/nodejs-best-practices

From: https://www.sitepoint.com/node-js-best-practices-from-the-node-gurus/