10 個技巧，讓你在2017 年成為更好的 Node 開發者

下面我將列出10個建議，這些建議可以幫助你在2017年成為更好的Node開發者。其中一些建議是我在日常實踐中所學到的，有些則是從那些寫了最受歡迎的Node和npm模組的人身上學到的。 以下是我們將要介紹的內容：

1.避免複雜性 — 盡可能將你的程式碼區塊拆到最小，要小到極致。

2.使用非同步程式設計 — 像躲避瘟疫般避免使用同步程式碼。

3.避免require阻塞 — 把你所有的require宣告都放在檔案的頂部，因為require是同步的，會阻塞程式碼運作。

4.了解require快取 — 了解它則可以利用它，否則它可能會帶來bug。

5.總是檢查錯誤 — 錯誤不是足球，任何時候都不要拋出錯誤或跳過錯誤檢查。

6.只在同步程式碼中使用try…catch — 在非同步程式碼中try...catch是沒有作用的。 V8引擎針對try...catch無法進行最佳化。

7.返回callbacks或使用if … else — 回傳一個callback只是為了確保不繼續執行。

8.監聽錯誤事件 — 幾乎所有的Node的類別/物件都有event emitter(觀察者模式)並且會廣播error事件，確保你監聽了它們。

9.了解你的npm — 使用-S或-D來安裝模組來代替--save或--save-dev`。

10.在package.json中使用精確的版本號: npm在使用-S來安裝模組時會自動使用預設的版本號，你需要手動修改去鎖定版本號。除非是開源模組，否者不要相信你的專案中的SemVer（語義化版本標準）。

11.加分 — 使用不同的依賴。把專案在開發階段需要的東西放在 devDependencies 中，記得使用 npm i --production。多餘的依賴越多，出現問題的風險就越大。

好的，接下來讓我們一個個單獨地去了解上面的每一點。

---

避免複雜性

讓我看一眼npm的創造者在這個模組中強制使用的一些模組，例如，情況嚴格模式，這個模組只是只有三行程式碼：

var module = require('module')
module.wrapper[0] += '"use strict";'
Object.freeze(module.wrap)

所以我們為什麼要避免複雜性呢? 一個起源於美國海軍的著名短語:KEEP IT SIMPLE STUPID(或者是“Keep it simple, stupid”)。這就是原因。事實說明，人類大腦在任何一個時間只能在其工作記憶中保持五到七個項目。

把你的程式碼模組化成一個更小的部分，你和其他的開發者會更加好的理解它。你也可以更加好的去測試它。如下例子，

app.use(function(req, res, next) {
  if (req.session.admin === true) return next()
  else return next(new Error('Not authorized'))
}, function(req, res, next) {
  req.db = db
  next()
})

或是

const auth = require('./middleware/auth.js')
const db = require('./middleware/db.js')(db)

app.use(auth, db)

我相信大多數人都會喜歡第二個例子，特別是光看名字就能了解其作用。當日，在你寫程式碼的時候，你可能認為你知道程式碼是如何運作的。甚至你想要展示你把幾個功能連接在一起寫在同一行中是多麼的機智。但是，這樣你是寫了一段愚蠢的程式碼。如果你思考的很複雜去寫這程式碼，那麼今後你再去看這段程式碼將會很難去理解。保證你的程式碼簡單，特別是在Node的非同步程式碼中。

當然也會有left-pad 事件，但是其實它只是影響了依賴left-pad模組的項目而且11分鐘後就發布了替代品。程式碼的最小化帶來的好處超過了它的缺點。 npm已經改變了發布策略,任何重要的項目都應該使用快取或私有的來源（作為臨時解決方案）。

---

使用非同步程式設計

在Node中同步程式碼只要很小的一部分。這些程式碼大多數都是用於命令列工具或其他與web應用程式無關的腳本。 Node開發者大多數都是編寫web應用，因此使用非同步程式碼可以避免阻塞現場。

例如，當你在編寫一個資料庫的腳本或是一個不需要控制並行的任務時，下面這種寫法可能是可以的：

let data = fs.readFileSync('./acconts.json')
db.collection('accounts').insert(data, (results))=>{
  fs.writeFileSync('./accountIDs.json', results, ()=>{process.exit(1)})
})

但是當你創建一個web應用時，下面這個寫法會更好：

app.use('/seed/:name', (req, res) => {
  let data = fs.readFile(`./${req.params.name}.json`, ()=>{
    db.collection(req.params.name).insert(data, (results))=>{
      fs.writeFile(`./${req.params.name}IDs.json`, results, ()={res.status(201).send()})
    })
  })
})

這個區別在於你是否需要編寫一個並發（通常是長期運行）或非並發（短期運行）的系統。根據經驗來說，總是要在Node中使用非同步程式碼。

---

避免require阻塞

Node有一個使用了CommonJS模組格式的簡單的模組載入系統。它是基於require函數，require函數可以很方便的在不同的檔案中引入模組。和AMD/requirejs不同，Node/CommonJS的模組載入時同步的。 require的工作方式是：引入一個模組或一個檔案export的內容:

`const react = require('react')`

但是大多数的开发者并不知道require是会被缓存的。因此，只要解析的文件名（resolved filename）没有剧烈的变化（比如npm模块不存在的情况），模块的代码只会被执行并存入变量中一次（在当前进程中）。这是一个很好的优化。当然，即使有了缓存，你最好还是把你的require声明写在开头。下面这段代码，它在路由中真正使用到了axios模块的时候才加载。当请求发送的时候/connect会因为需要加载模块所以会变得慢。

app.post('/connect', (req, res) => {
  const axios = require('axios')
  axios.post('/api/authorize', req.body.auth)
    .then((response)=>res.send(response))})

一个更好，性能更优的方式是在服务定义之前就引入模块而不是在路由中:

const axios = require('axios')
const express = require('express')
app = express()
app.post('/connect', (req, res) => {
  axios.post('/api/authorize', req.body.auth)
    .then((response)=>res.send(response))
})

---

知道require会被缓存

我在上面一节已经提到了require会被缓存，但是有趣的是我们在module.exports之外也会有代码。举例来说：

console.log('I will not be cached and only run once, the first time')

module.exports = () => {
  console.log('I will be cached and will run every time this module is invoked')
}

从中我们了解到有一些代码只会运行一次，你可以使用这个特性来优化你的代码。

---

始终检查错误

Node不是Java。在Java中，你可以抛出错误，因为如果发生了错误那么你会希望应用不在继续执行。在Java中，你可以在外层仅仅使用一个简单的try...catch就可以处理多个错误。

但是在Node中并不是这样的。自从Node使用了事件循环和异步执行后，任何的错误发生时都会与错误处理器（例如try...catch）的上下文分离，下面这样做在Node中是没有用的：

try {
  request.get('/accounts', (error, response)=>{
    data = JSON.parse(response)
  })
} catch(error) {
  // Will NOT be called
  console.error(error)
}

但是try...catch在同步代码中是可以被用的。前面的代码片段可以被更好的重构为：

request.get('/accounts', (error, response)=>{
  try {
    data = JSON.parse(response)
  } catch(error) {
    // Will be called
    console.error(error)
  }
})

如果我们无法将request的返回内容包裹在try...catch中，那么我们将没有办法去处理请求的错误。Node的开发者通过在返回的参数里面加上error来解决了这个问题。因此，我们需要在每一个回调中手动去处理错误。你可以去检查这些错误（判断error不是null）,然后展示错误信息给用户或者展示在客户端上并且记录它， 或者你可以通过调用 callback ，给它传 error 参数，将错误传回给上一级调用栈（如果你在调用栈之上有另一个回调函数）。

request.get('/accounts', (error, response)=>{
  if (error) return console.error(error)
  try {
    data = JSON.parse(response)
  } catch(error) {
    console.error(error)
  }
})

一个小技巧是你可以使用okay库。你可以像下面的例子一样使用它去避免在回调地狱中手动去检查错误(你好, 回调地狱).

var ok = require('okay')

request.get('/accounts', ok(console.error, (response)=>{
  try {
    data = JSON.parse(response)
  } catch(error) {
    console.error(error)
  }
}))

---

返回回调或者使用if … else

Node是并行的。但是如果你不够细心也会因为这个特性产生bug。 为了安全起见，应该要使用return来终止代码的继续执行：

let error = true
if (error) return callback(error)
console.log('I will never run - good.')

这样可以避免一些因为代码逻辑的处理不当导致一些不应该执行的内容（或者错误）被执行。

let error = true
if (error) callback(error)
console.log('I will run. Not good!')

请确保使用return去阻止代码的继续执行。

---

监听 error 事件

Node中几乎所有的类/对象都有事件分发器（观察者模式）并且会广播 error 事件。 这是一个很好的特性，可以使开发者在这些讨厌的错误造成巨大后果之前捕捉到它们。

养成一个通过.on()来创建error事件监听的好习惯：

var req = http.request(options, (res) => {
  if (('' + res.statusCode).match(/^2\d\d$/)) {
    // Success, process response
  } else if (('' + res.statusCode).match(/^5\d\d$/))
    // Server error, not the same as req error. Req was ok.
  }
})

req.on('error', (error) => {
  // Can't even make a request: general error, e.g. ECONNRESET, ECONNREFUSED, HPE_INVALID_VERSION
  console.log(error)
})

---

了解你的npm

很多的Node和前端的开发者知道在安装模块的时候使用--save会在安装模块的同时，会在package.json保存一条含有模块版本信息的条目。当然，还有--save-dev可以用于安装devDependencies(在生成环境中不需要的模块)。但是你知道用-S和-D是否可以代替--save 和--save-dev么？答案是可以的。

当你安装模块的时候，你需要删除-S和-D自动为你模块的版本号添加的^标签。否者当你使用npm install（或者npm i）安装模块的时候，就会自动拉取最新的镜像（版本号的第二位数字）。例如v6.1.0就是v6.2.0的一个镜像分支。

npm团队推荐使用semver，但是你最好不要这样。npm团队认为开源开发者会遵守semver所以他们在npm安装时自动加上了^。没有人可以去保证，所以最好是锁定你的版本号。更好的办法是使用shrinkwrap：npm shrinkwrap会生成一个包含依赖的具体版本的文件。