如何在2016年成為一個(gè)更好的Node.js開(kāi)發(fā)者

2016-01-21 10:58:41

如果是一個(gè)不會(huì)向后兼容（backward-compatible）的API變化使用主版本號(hào)。當(dāng)添加新的特性且API變化是向后兼容的時(shí)候使用次版本號(hào)。如果只是對(duì)Bug進(jìn)行修復(fù)可以使用包版本號(hào)。

本文主要討論一些進(jìn)行Node.js開(kāi)發(fā)的***實(shí)踐和建議，這些建議不僅僅適合開(kāi)發(fā)者，還適合那些管理與維護(hù)Node.js基礎(chǔ)架構(gòu)的工作人員。遵循本文提供的這些建議，能夠讓你更好的進(jìn)行日常的開(kāi)發(fā)工作。

[[162262]]

使用ES2015

在2015年的夏天，ES2015的最終草案（即ES6）正式發(fā)布了。該版本為JavaScript語(yǔ)言增加了大量的新的語(yǔ)言特性，主要包括：

箭頭函數(shù)
模版字符串
不定參數(shù)（rest operator）, argument spreading
生成器
promises
maps, sets
symbols

以及很多其他特性。一個(gè)更加完整的新特性的列表你可以從Kyle Simpson的ES6 and Beyond中進(jìn)行了解。并且它們中的絕大部分特性已經(jīng)被加入到了Node.js v4中。

在客戶(hù)端，你也可以借助Babel來(lái)使用ES6的所有新特性，Babel是一個(gè)JavaScript轉(zhuǎn)譯器。目前在服務(wù)器端，我們只傾向于使用那些被加入到***的穩(wěn)定版本的特性，這樣無(wú)需轉(zhuǎn)譯代碼，這可以避免出現(xiàn)那些令我們頭疼的潛在問(wèn)題。

對(duì)于Node.js中的ES6的更多信息，你可以訪問(wèn)官方站點(diǎn)：https://nodejs.org/en/docs/es6/

回調(diào)約定 – 同時(shí)支持Promise

在去年，我們可能會(huì)推薦你為你的模塊暴露錯(cuò)誤優(yōu)先的回調(diào)接口。但是隨著生成器函數(shù)的正式標(biāo)準(zhǔn)化，并且異步函數(shù)也即將到來(lái)，因此我們現(xiàn)在建議你在編寫(xiě)模塊的接口時(shí)應(yīng)該暴露支持Promise的的錯(cuò)誤優(yōu)先的回調(diào)函數(shù)。

為什么需要這樣？首先回調(diào)接口是為了提供向后兼容性，為了能夠在未來(lái)能夠獲得更好的兼容性，需要同時(shí)提供Promise支持。

你可以參考下面的例子來(lái)進(jìn)一步的理解具體應(yīng)該如何進(jìn)行編程。在這個(gè)例子中readPackage函數(shù)讀取了package.json文件，并同時(shí)通過(guò)Promise和回調(diào)接口返回了它的內(nèi)容。

const fs = require('fs'); 
 
function readPackage (callback) { 
  // as of now we do not have default values in Node.js 
  callback = callback || function () {} 
  return new Promise((resolve, reject) => { 
    fs.readFile('./package.json', (err, data) => { 
      if (err) { 
        reject(err); 
        return callback(err); 
      } 
      resolve(data); 
      return callback(null, data); 
    }) 
  })  
} 
 
module.exports.readPackage = readPackage;

異步模式

在Node.js中，很長(zhǎng)一段時(shí)間你只有兩種方法來(lái)管理異步流：回調(diào)或者流（Stream）。對(duì)于回調(diào)函數(shù)而言，你可以使用類(lèi)似于async這類(lèi)庫(kù)，對(duì)于流而言，有through、bl、highland等庫(kù)可以選擇。

但是隨著Promise、生成器、異步函數(shù)等被逐漸引入進(jìn)標(biāo)準(zhǔn)的ECMAScript，JS中的流程控制也得到了極大的改善。

關(guān)于異步JavaScript的發(fā)展歷史，你可以參考異步JavaScript的發(fā)展歷程這篇博文。

錯(cuò)誤處理

錯(cuò)誤處理在應(yīng)用開(kāi)發(fā)過(guò)程中起著至關(guān)重要的作用：確定應(yīng)用崩潰的時(shí)間，或者僅僅是打印錯(cuò)誤信息，確保應(yīng)用繼續(xù)運(yùn)行都是有一定難度的。

為了能夠更簡(jiǎn)單的說(shuō)明這個(gè)問(wèn)題，我們決定將其分為兩種：程序員錯(cuò)誤（programmer errors）和運(yùn)算錯(cuò)誤（operational errors）。

程序員錯(cuò)誤就是我們所說(shuō)的bug，由于你不知道程序運(yùn)行的確切狀態(tài)因此當(dāng)出現(xiàn)錯(cuò)誤時(shí)你***立刻停止應(yīng)用的運(yùn)行（crash the process）。

另一方面，運(yùn)算錯(cuò)誤是由于系統(tǒng)或者遠(yuǎn)程服務(wù)本身所導(dǎo)致的問(wèn)題。例如：請(qǐng)求超時(shí)和內(nèi)存不足等。基于錯(cuò)誤發(fā)生的特點(diǎn)，你可以對(duì)癥下藥，然后重試，例如文件丟失，你可以去創(chuàng)建相應(yīng)的文件。

在回調(diào)中進(jìn)行錯(cuò)誤處理

如果一個(gè)錯(cuò)誤發(fā)生在異步操作的過(guò)程中，錯(cuò)誤對(duì)象應(yīng)該作為異步函數(shù)的***個(gè)參數(shù)進(jìn)行傳遞。你必須始終要檢查該錯(cuò)誤對(duì)象并進(jìn)行錯(cuò)誤處理。

在前面的有關(guān)回調(diào)約定的例子里面已經(jīng)展示了如何在回調(diào)函數(shù)中進(jìn)行錯(cuò)誤的優(yōu)先處理。

在Promise中進(jìn)行錯(cuò)誤處理

如果是下面的代碼片段會(huì)發(fā)生什么情況？

Promise.resolve(() => 'John') 
  .then(() => { 
    throw new Error('ops'); 
  }) 
  .catch((ex) => { 
    console.log(ex); 
  }) 
  .then(() => { 
    throw new Error('ups'); 
    console.log(Doe'); 
  })

在第3行會(huì)拋出一個(gè)異常。

catch會(huì)處理它，并且在stdout中打印出：[Error: ops]
執(zhí)行繼續(xù)，并且在第9行會(huì)拋出一個(gè)新的錯(cuò)誤
沒(méi)有了

的確沒(méi)有什么了 – ***一個(gè)被拋出的錯(cuò)誤將會(huì)是靜默的。你需要注意，你應(yīng)該始終以一個(gè)catch語(yǔ)句作為promise鏈的***一環(huán)。這會(huì)為你解決很多頭疼的問(wèn)題。像下面這樣：

Promise.resolve(() => 'John') 
  .then(() => { 
    throw new Error('ops'); 
  }) 
  .catch((ex) => { 
    console.log(ex); 
  }) 
  .then(() => { 
    throw new Error('ups'); 
    console.log(Doe'); 
  }) 
  .catch((ex) => { 
    console.log(ex); 
  });

現(xiàn)在會(huì)輸出如下內(nèi)容：

[Error: ops] 
[Error: ops]

使用JavaScript標(biāo)準(zhǔn)風(fēng)格

在過(guò)去幾年中，我們會(huì)使用JSHint、JSCS、ESLint等非常有用的代碼質(zhì)量工具來(lái)盡可能的自動(dòng)化檢查我們的代碼。

最近，當(dāng)談到代碼風(fēng)格的時(shí)候，我們使用feross的JavaScript標(biāo)準(zhǔn)風(fēng)格。

原因是它非常的簡(jiǎn)單：無(wú)需任何配置文件，只需要將其放到項(xiàng)目中。主要包括如下一些規(guī)則：

使用2個(gè)空格作為縮進(jìn)
字符串使用單引號(hào) – 除了為了避免轉(zhuǎn)義
不要包括沒(méi)有被使用的變量
沒(méi)有分號(hào)
永遠(yuǎn)不要以（或者 [ 作為一行的開(kāi)始
關(guān)鍵字后加空格 if (condition) { ... }
函數(shù)名后加空格 function name (args) { ... }
始終使用===代替==，但是可以使用obj == null來(lái)檢查null || undefined。
始終要處理Node.js的err函數(shù)參數(shù)
始終要為瀏覽器全局變量增加window前綴，除了document和navigator
盡可能避免使用類(lèi)似于open、length、evet、name等走位瀏覽器全局變量。

當(dāng)然，如果你的編輯器只支持ESLint的話，這里有一個(gè)ESLint的規(guī)則庫(kù)用于使用標(biāo)準(zhǔn)風(fēng)格，即eslint-plugin-standard。安裝了這個(gè)插件后，你的.eslintrc文件可以是下面這樣的：

{ 
    "plugins": [ 
        "standard" 
    ], 
}

12-Factor應(yīng)用（The Twelve-Factor Application）

如今，軟件通常會(huì)作為一種服務(wù)來(lái)交付，它們被稱(chēng)為網(wǎng)絡(luò)應(yīng)用程序，或軟件即服務(wù)（SaaS）。 12-Factor應(yīng)用宣言描述了進(jìn)行Web應(yīng)用開(kāi)發(fā)的***實(shí)踐：

基準(zhǔn)代碼：一份基準(zhǔn)代碼，多份部署
依賴(lài)：顯示聲明依賴(lài)
配置：在環(huán)境中存儲(chǔ)配置
后端服務(wù)：把后端服務(wù)當(dāng)作附加資源
構(gòu)建、發(fā)布、運(yùn)行：嚴(yán)格分離構(gòu)建和運(yùn)行
進(jìn)程：以一個(gè)或多個(gè)無(wú)狀態(tài)進(jìn)程運(yùn)行應(yīng)用
端口綁定：通過(guò)端口綁定提供服務(wù)
并發(fā)：通過(guò)進(jìn)程模型進(jìn)行擴(kuò)展
易處理：快速啟動(dòng)和優(yōu)雅終止可***化健壯性
開(kāi)發(fā)環(huán)境與線上環(huán)境等價(jià)：盡可能的保持開(kāi)發(fā)、預(yù)發(fā)布、線上環(huán)境相同
日志：把日志當(dāng)作事件流
管理進(jìn)程：后端管理任務(wù)當(dāng)作一次性進(jìn)程運(yùn)行

這套理論適用于任意語(yǔ)言和后端服務(wù)（數(shù)據(jù)庫(kù)、消息隊(duì)列、緩存等）開(kāi)發(fā)的應(yīng)用程序。

開(kāi)始新的項(xiàng)目

始終通過(guò)npm init命令來(lái)開(kāi)始一個(gè)新項(xiàng)目。這可以為你的項(xiàng)目創(chuàng)建一個(gè)初始的package.json。

如果你想跳過(guò)初始的提問(wèn)并直接使用默認(rèn)的配置，只需要運(yùn)行npm init --yes即可。

監(jiān)控你的應(yīng)用

當(dāng)發(fā)生某個(gè)故障或是故障即將發(fā)生時(shí)，及時(shí)的通知你，能夠?yàn)槟阃旎負(fù)p失。

為了進(jìn)行應(yīng)用的監(jiān)控，你可以使用類(lèi)似的SaaS產(chǎn)品或是開(kāi)源軟件。在開(kāi)源軟件方面，主要包括：Zabbix, Collected, ElasticSearch和Logstash。

如果你不想要自己進(jìn)行部署，可以考慮使用線上的服務(wù)，你可以嘗試使用Trace，它是我們公司開(kāi)發(fā)的Node.js和微服務(wù)監(jiān)控解決方法。

如何在2016年成為一個(gè)更好的 Node.js 開(kāi)發(fā)者

使用構(gòu)建系統(tǒng)

盡可能的自動(dòng)化一切東西。沒(méi)有什么比讓開(kāi)發(fā)來(lái)做應(yīng)該讓grunt做的事情更無(wú)聊和令人惱火的了，這不僅浪費(fèi)時(shí)間，而且沒(méi)有意義。

現(xiàn)如今JavaScript的這類(lèi)工具已經(jīng)非常的豐富了，包括Grunt, Gulp, 和Webpack，你知道幾個(gè)就行。

在RisingStack，絕大部分的前端開(kāi)發(fā)新項(xiàng)目都是使用Webpack來(lái)進(jìn)行自動(dòng)化構(gòu)建，其他類(lèi)型的則使用gulp實(shí)現(xiàn)自動(dòng)化任務(wù)。對(duì)于新手而言，Webpack可能會(huì)花費(fèi)大量的時(shí)間去理解，所以我強(qiáng)烈建議你去閱讀一下Webpack Cookbook。

使用***的長(zhǎng)期支持（LTS）的Node版本

為了能夠更好的獲取穩(wěn)定性和新特性，我們建議你使用***的Node的LTS（長(zhǎng)期支持）版本，它們是使用偶數(shù)發(fā)布編號(hào)的版本。當(dāng)然，你也可以自由的使用***的實(shí)驗(yàn)版本，即稱(chēng)為穩(wěn)定發(fā)布版本的使用奇數(shù)發(fā)布編號(hào)的。

如果你需要為多個(gè)項(xiàng)目工作，并且使用了不同的Node.js版本，建議你***使用一個(gè)Node版本管理器——nvm。

更多信息你可以參考Node.js官方網(wǎng)站的發(fā)布信息：

What You Should Know about Node.js v5 and More

每周更新你的項(xiàng)目依賴(lài)

養(yǎng)成每周更新一次你的項(xiàng)目依賴(lài)的習(xí)慣。這方面，你可以使用npm outdated或者是ncu包。

選擇合適的數(shù)據(jù)庫(kù)

當(dāng)我們談到Node.js和數(shù)據(jù)庫(kù)的時(shí)候，可能你想到的***個(gè)技術(shù)是MongoDB。當(dāng)然這并沒(méi)有什么錯(cuò)，但是你不應(yīng)該直接就去使用它。在這么做之前你需要問(wèn)你自己和你的團(tuán)隊(duì)幾個(gè)問(wèn)題。包括下面幾個(gè)：