原文: http://blog.risingstack.com/node-js-best-practices/

下面的的最佳实践分为代码风格和开发工作流两种.

代码风格

Callback约定

Modules应该暴露出一个以error为第一个参数的callback接口.

如下:

module.exports = function (dragonName, callback) {
// 写下你module的逻辑
var dragon = createDragon(dragonName); // 注意, 第一个参数是error
// 在这里error为null
// 但是当一个错误发生的时候应该是一个Error
return callback(null, dragon);
}

  

总是在callback函数里面去检查error

为了更好的理解为什么要在callback函数里面检查error,  我们故意让程序出错, 下一步在修复他.

// this example is **BROKEN**, we will fix it soon :)
var fs = require('fs'); function readJSON(filePath, callback) {
fs.readFile(filePath, function(err, data) {
callback(JSON.parse(data));
});
} readJSON('./package.json', function (err, pkg) { ... }

  

readJSON的第一个问题是他从来没有去检查是否出错.下面让我们来改善一下

// this example is **STILL BROKEN**, we are fixing it!
function readJSON(filePath, callback) {
fs.readFile(filePath, function(err, data) {
// 在这我们检查是不是有一个错误发生了
if (err) {
// 传递error给callback
// 记住: callback的第一个参数是err
callback(err);
} // 没错的话, 传递一个null和JSON
callback(null, JSON.parse(data));
});
}

返回callback

上面的例子还有一个错误, 如果一个错误发生了, 代码不会在if里面停止还会继续执行下面的代码. 我们一定要记得return callback.

// this example is **STILL BROKEN**, we are fixing it!
function readJSON(filePath, callback) {
fs.readFile(filePath, function(err, data) {
if (err) {
return callback(err);
} return callback(null, JSON.parse(data));
});
}

在同步代码里面使用try-catch

值得注意的是如果传入的data是一个非法的JSON格式, JSON.parse可能会抛出一个exception.

因为JSON.parse是同步执行的, 我们可以用一个try-catch把他包起来. 注意, 只能在同步的代码块用try-catch!

// this example **WORKS**! :)
function readJSON(filePath, callback) {
fs.readFile(filePath, function(err, data) {
var parsedJson; // Handle error
if (err) {
return callback(err);
} // Parse JSON
try {
parsedJson = JSON.parse(data);
} catch (exception) {
return callback(exception);
} // Everything is ok
return callback(null, parsedJson);
});
}

  

避免使用avoid和new

在Node里面绑定一个特殊的上下文不是一个好的选择, 因为Node有太多太多的callback, and heavy use of higher-level functions to manage control flow. 使用函数风格可以解决你很多问题. 
当然在某些情况下使用prototypes非常有效率, 但是如果可以的话尽量避免使用他们.

创建小的modules

使用好的异步模式

使用 async.

处理Error

Errors分为两种: operational errors 和 programmer errors.

Operational errors

及时完美无bug的应用也可能发生错误, 如下:

  • 请求超时
  • 系统内存耗尽
  • 链接远程服务失败failed to connect to a remote service
处理operational errors

你可以通过下面的方式来处理:

  • 试着去解决错误 - 如果一个文件没了, 你可以先创建一个
  • 诸如请求外网失败的时候可以自动重新在去操作一次
  • 告诉客户有错误发生了 - 可以使用来处理客户的输入
  • Crash the process, when the error condition is unlikely to change on its own, like the application cannot read its configuration file

当然最重要的是使用log.

Programmer errors

Programmer errors一般来说都是一些bug, 如下:

  • 调用异步函数但是没有使用callback
  • 不能读取undefined的属性
处理programmer errors

立刻崩溃 - 因为这些错误是一些bug. 当应用崩溃的话, 应该自动去重新启动应用. 可以使用: supervisord 和 monit.

Workflow tips

开始一个新项目的第一步一定是npm init

init命令帮助我们创建应用程序的package.json文件.

以下面的命令开始你的新项目:

mkdir my-awesome-new-project
cd my-awesome-new-project
npm init

指定一个start和test script

package.json中的scripts节点中里面设置script. 默认情况下面npm生成两个script, starttest. 在这我们可以使用npm start和npm test.

我们可以自定义一些script, 可以使用npm run-script <SCRIPT_NAME> 调用触发.

Note, that NPM will set up $PATH to look in node_modules/.bin for executables. This helps avoid global installs of NPM modules.

环境变量

Production/staging 部署应该通过环境变量来完成.

可以使用nconf根据你的环境变量, 加载不同的配置.

不要重复制造轮子

总是先查找是不是已经有现成的解决方案. NPM有非常多的packages, 这里极有可能有符合你要求的package.

使用统一的代码风格指南

如果代码都是使用一种风格编写的, 这将对我们阅读代码变的容易些. 比如缩进规则, 参数命名规则.

可以看看这 RisingStack's Node.js style guide.

[译]Node.js Best Practices的更多相关文章

  1. [译]Node.js Best Practices - Part 2

    原文: https://blog.risingstack.com/node-js-best-practices-part-2/ 统一风格 在大团队开发JS应用, 创建一个风格指南是很有必要的. 推荐看 ...

  2. [译]Node.js - Event Loop

    介绍 在读这篇博客之前,我强列建议先阅读我的前两篇文章: Getting Started With Node.js Node.js - Modules 在这篇文章中,我们将学习 Node.js 中的事 ...

  3. [译]Node.js Interview Questions and Answers (2017 Edition)

    原文 Node.js Interview Questions for 2017 什么是error-first callback? 如何避免无止境的callback? 什么是Promises? 用什么工 ...

  4. 译\Node.js应用的持续部署

    Node.js应用的持续部署 翻译前 翻译自:https://blog.risingstack.com/continuous-deployment-of-node-js-applications/ 正 ...

  5. [译]Node.js : Building RESTful APIs using Loopback and MySQL

    国庆后可能就要使用StrongLoop那套东西来做项目了 原文:http://www.javabeat.net/loopback-mysql/ Loopback是什么? Loopback是一个开源的N ...

  6. [译]Node.js面试问与答

    原文: http://blog.risingstack.com/node-js-interview-questions/ 什么是error-first callback? 如何避免无休止的callba ...

  7. (译)Node.js的 EventEmitter 教程

    原文标题:Node.js EventEmitter Tutorial 原文链接:http://www.hacksparrow.com/node-js-eventemitter-tutorial.htm ...

  8. (译)Node.js的全局变量

    原文标题:Global Variables in Node.js 原文链接:http://www.hacksparrow.com/global-variables-in-node-js.html 你可 ...

  9. (译)Node.js的模块-exports和module.exports

    原文标题:Node.js Module – exports vs module.exports 原文链接:http://www.hacksparrow.com/node-js-exports-vs-m ...

随机推荐

  1. 公司内多个公众号实现账号互通(UnionID机制处理)

    场景: 由于用户在每个公众号上的OpenID都不一样,如果要实现判断判断某个用户在其中一个公众号上已经绑定过,那么就要借助(UnionID机制)的机制. 条件: 1.拥有微信开放平台账号,且认证(ht ...

  2. Zabbix low-level discovery

    Version: zabbix 3.0.1 概述 Low-Level discovery 可以自动创建items,triggers,graphs为不同的实体对象. 例如:zabbix能自动监控服务器上 ...

  3. 在c#中用指针操作图片像素点

    在Bitmap类中有两个函数SetPixel,GetPixel,分别用来设置或读取图片中指定点的颜色(这里发现了VS的一个错误,SetPixel的文档说明写的是“获取颜色”??). 当要对一幅图进行相 ...

  4. HDU 5923 Prediction

    这题是2016 CCPC 东北四省赛的B题, 其实很简单. 现场想到的就是正解, 只是在合并两个并查集这个问题上没想清楚. 做法 并查集合并 + 归并 对每个节点 \(u\), 将 \(u\) 到根的 ...

  5. 【Alpha版本】 第四天 11.10

    一.站立式会议照片: 二.项目燃尽图: 三.项目进展: 成 员 昨天完成任务 今天完成任务 明天要做任务 问题困难 心得体会 胡泽善 填写招聘时用户填写各个日期到可以使用工具方便选择日期的修改 完成了 ...

  6. css3新增属性API

    写在前面:由于CSS5标准还未完全订下来,所以各种内核的浏览器都有自己的标准,为了不使属性混淆,所以各家在各自标准前加了一个前缀. -moz-  主要是firefox火狐 -webikt-主要是chr ...

  7. 【转载】C++中的基类与派生类

    转自:http://www.cnblogs.com/sujz/articles/2044365.html 派生类的继承方式总结: 继承方式 说明 public 基类的public和protected的 ...

  8. 深入理解JavaScript中创建对象模式的演变(原型)

    深入理解JavaScript中创建对象模式的演变(原型) 创建对象的模式多种多样,但是各种模式又有怎样的利弊呢?有没有一种最为完美的模式呢?下面我将就以下几个方面来分析创建对象的几种模式: Objec ...

  9. kaili camera

    #lsusb #dmesg | grep uvc #apt-get install guvcview cheese

  10. php返回json数据中文显示的问题

    PHP5.4版本,已经给Json新增了一个选项: JSON_UNESCAPED_UNICODE.加上这个选项后,就不会自动把中文编码了. echo json_encode("厦门" ...