10個(gè)技巧,讓你在 2017 年成為更好的Node開(kāi)發(fā)者
在2012年,我加入了Storify并開(kāi)始使用Node作為我的主要語(yǔ)言。從那以后,我從未回首過(guò)去并覺(jué)得我錯(cuò)過(guò)了Python,Ruby,Java以及PHP,這些在過(guò)去10年里,我在web開(kāi)發(fā)過(guò)程中使用的語(yǔ)言。下面我將列出10條建議,這些建議可以幫助你在2017年成為一個(gè)更好的Node開(kāi)發(fā)者。其中一些建議是我在日常實(shí)踐中所學(xué)到的,另一些是從那些寫(xiě)了最流行的Node和npm模塊的人們身上學(xué)到的。 下面是我們將要介紹的內(nèi)容:
本文是由我們的客座作者Azat Mardan寫(xiě)的。SitePoint引入客座帖子的目的是希望能給你帶來(lái)web社區(qū)里著名作者和演講者的有趣內(nèi)容。
在2012年,我加入了Storify并開(kāi)始使用Node作為我的主要語(yǔ)言。從那以后,我從未回首過(guò)去并覺(jué)得我錯(cuò)過(guò)了Python,Ruby,Java以及PHP,這些在過(guò)去10年里,我在web開(kāi)發(fā)過(guò)程中使用的語(yǔ)言。
Storify提供給我一個(gè)很有趣的工作,因?yàn)镾torify和其他的公司不太一樣,Storify之前(可能到現(xiàn)在也是)所有的代碼都是由JavaScript編寫(xiě)的。而大多數(shù)公司,特別是大公司,例如PayPal,Walmart(沃爾瑪)或者Capital One(第一資本),只是在某一些特定的部分使用了Node。通常,他們使用Node作為API接口或者用在業(yè)務(wù)流程層,這樣做是很好的。但是作為一個(gè)軟件工程師,沒(méi)什么比得上能夠完全沉浸在Node環(huán)境里。
下面我將列出10條建議,這些建議可以幫助你在2017年成為一個(gè)更好的Node開(kāi)發(fā)者。其中一些建議是我在日常實(shí)踐中所學(xué)到的,另一些是從那些寫(xiě)了最流行的Node和npm模塊的人們身上學(xué)到的。 下面是我們將要介紹的內(nèi)容:
-
避免復(fù)雜性 — 盡可能將你的代碼塊拆到最小,要小到極致。
-
使用異步編程 — 像躲避瘟疫般避免使用同步代碼。
-
避免require阻塞 — 把你所有的require聲明都放在文件的頂部,因?yàn)閞equire是同步的,會(huì)阻塞代碼運(yùn)行。
-
了解require緩存 — 了解它則可以利用它,否則它可能會(huì)帶來(lái)bug。
-
始終檢查錯(cuò)誤 — 錯(cuò)誤不是足球,任何時(shí)候都不要拋出錯(cuò)誤或者跳過(guò)錯(cuò)誤檢查。
-
只在同步代碼中使用try…catch — 在異步代碼中try...catch是沒(méi)有作用的。V8引擎針對(duì)try...catch無(wú)法進(jìn)行優(yōu)化。
-
返回callbacks或者使用if … else — 返回一個(gè)callback只是為了確保不繼續(xù)執(zhí)行。
-
監(jiān)聽(tīng)錯(cuò)誤事件 — 幾乎所有的Node的類/對(duì)象都有event emitter(觀察者模式)并且會(huì)廣播error事件,確保你監(jiān)聽(tīng)了它們。
-
了解你的npm — 使用-S或者-D來(lái)安裝模塊來(lái)代替--save或者--save-dev`。
-
在package.json中使用精確的版本號(hào): npm在使用-S來(lái)安裝模塊時(shí)會(huì)自動(dòng)使用默認(rèn)的版本號(hào),你需要手動(dòng)修改去鎖定版本號(hào)。除非是開(kāi)源模塊,否者不要相信你的項(xiàng)目中的SemVer(語(yǔ)義化版本標(biāo)準(zhǔn))。
-
加分 — 使用不同的依賴。把項(xiàng)目在開(kāi)發(fā)階段需要的東西放在 devDependencies 中,記得使用 npm i --production。多余的依賴越多,出現(xiàn)問(wèn)題的風(fēng)險(xiǎn)就越大。
好的,接下來(lái)讓我們一個(gè)個(gè)單獨(dú)地去了解上面的每一點(diǎn)。
避免復(fù)雜性
讓我看一眼npm的創(chuàng)造者Isaac Z. Schlueter寫(xiě)的一些模塊,例如,use-strict,這個(gè)模塊是用來(lái)在Javascript中強(qiáng)制使用嚴(yán)格模式,這個(gè)模塊僅僅只有三行代碼:
所以我們?yōu)槭裁匆苊鈴?fù)雜性呢? 一個(gè)起源于美國(guó)海軍的著名短語(yǔ):KEEP IT SIMPLE STUPID(或者是“Keep it simple, stupid”)。這就是原因。事實(shí)說(shuō)明,人類大腦在任何一個(gè)時(shí)間只能在其工作記憶中保持五到七個(gè)項(xiàng)目。
把你的代碼模塊化成一個(gè)更加小的部分,你和其他的開(kāi)發(fā)者會(huì)更加好的理解它。你也可以更加好的去測(cè)試它。如下例子,
或者是
我相信大多數(shù)人都會(huì)喜歡第二個(gè)例子,特別是光看名字就能了解其作用。當(dāng)日,在你編寫(xiě)代碼的時(shí)候,你可能認(rèn)為你知道代碼是如何運(yùn)行的。甚至你想要展示你把幾個(gè)功能連接在一起寫(xiě)在同一行中是多么的機(jī)智。但是,這樣你是寫(xiě)了一段愚蠢的代碼。如果你思考的很復(fù)雜去寫(xiě)這代碼,那么今后你再去看這段代碼將會(huì)很難去理解。保證你的代碼簡(jiǎn)單,特別是在Node的異步代碼中。
當(dāng)然也會(huì)有left-pad 事件,但是其實(shí)它只是影響了依賴于left-pad模塊的項(xiàng)目而且11分鐘后就發(fā)布了替代品。代碼的最小化帶來(lái)的好處超過(guò)了它的缺點(diǎn)。npm已經(jīng)改變了發(fā)布策略,任何重要的項(xiàng)目都應(yīng)該使用緩存或私有的源(作為臨時(shí)解決方案)。
使用異步編程
在Node中同步代碼只要很小的一部分。這些代碼大多數(shù)都是用于命令行工具或者其他與web應(yīng)用無(wú)關(guān)的腳本。Node開(kāi)發(fā)者大多數(shù)都是編寫(xiě)web應(yīng)用,因此使用異步代碼可以避免阻塞現(xiàn)場(chǎng)。
例如,當(dāng)你在編寫(xiě)一個(gè)數(shù)據(jù)庫(kù)的腳本或者是一個(gè)不需要控制并行的任務(wù)時(shí),下面這種寫(xiě)法可能是可以的:
但是當(dāng)你創(chuàng)建一個(gè)web應(yīng)用時(shí),下面這個(gè)寫(xiě)法會(huì)更好:
這個(gè)區(qū)別在于你是否需要編寫(xiě)一個(gè)并發(fā)(通常是長(zhǎng)期運(yùn)行)或者非并發(fā)(短期運(yùn)行)的系統(tǒng)。根據(jù)經(jīng)驗(yàn)來(lái)說(shuō),總是要在Node中使用異步代碼。
避免require阻塞
Node有一個(gè)使用了CommonJS模塊格式的簡(jiǎn)單的模塊加載系統(tǒng)。它是基于require函數(shù),require函數(shù)可以很方便的在不同的文件中引入模塊。和AMD/requirejs不同,Node/CommonJS的模塊加載時(shí)同步的。require的工作方式是:引入一個(gè)模塊或者一個(gè)文件export的內(nèi)容:
但是大多數(shù)的開(kāi)發(fā)者并不知道require是會(huì)被緩存的。因此,只要解析的文件名(resolved filename)沒(méi)有劇烈的變化(比如npm模塊不存在的情況),模塊的代碼只會(huì)被執(zhí)行并存入變量中一次(在當(dāng)前進(jìn)程中)。這是一個(gè)很好的優(yōu)化。當(dāng)然,即使有了緩存,你最好還是把你的require聲明寫(xiě)在開(kāi)頭。下面這段代碼,它在路由中真正使用到了axios模塊的時(shí)候才加載。當(dāng)請(qǐng)求發(fā)送的時(shí)候/connect會(huì)因?yàn)樾枰虞d模塊所以會(huì)變得慢。
一個(gè)更好,性能更優(yōu)的方式是在服務(wù)定義之前就引入模塊而不是在路由中:
知道require會(huì)被緩存
我在上面一節(jié)已經(jīng)提到了require會(huì)被緩存,但是有趣的是我們?cè)趍odule.exports之外也會(huì)有代碼。舉例來(lái)說(shuō):
從中我們了解到有一些代碼只會(huì)運(yùn)行一次,你可以使用這個(gè)特性來(lái)優(yōu)化你的代碼。
始終檢查錯(cuò)誤
Node不是Java。在Java中,你可以拋出錯(cuò)誤,因?yàn)槿绻l(fā)生了錯(cuò)誤那么你會(huì)希望應(yīng)用不在繼續(xù)執(zhí)行。在Java中,你可以在外層僅僅使用一個(gè)簡(jiǎn)單的try...catch就可以處理多個(gè)錯(cuò)誤。
但是在Node中并不是這樣的。自從Node使用了事件循環(huán)和異步執(zhí)行后,任何的錯(cuò)誤發(fā)生時(shí)都會(huì)與錯(cuò)誤處理器(例如try...catch)的上下文分離,下面這樣做在Node中是沒(méi)有用的:
但是try...catch在同步代碼中是可以被用的。前面的代碼片段可以被更好的重構(gòu)為:
如果我們無(wú)法將request的返回內(nèi)容包裹在try...catch中,那么我們將沒(méi)有辦法去處理請(qǐng)求的錯(cuò)誤。Node的開(kāi)發(fā)者通過(guò)在返回的參數(shù)里面加上error來(lái)解決了這個(gè)問(wèn)題。因此,我們需要在每一個(gè)回調(diào)中手動(dòng)去處理錯(cuò)誤。你可以去檢查這些錯(cuò)誤(判斷error不是null),然后展示錯(cuò)誤信息給用戶或者展示在客戶端上并且記錄它, 或者你可以通過(guò)調(diào)用 callback ,給它傳 error 參數(shù),將錯(cuò)誤傳回給上一級(jí)調(diào)用棧(如果你在調(diào)用棧之上有另一個(gè)回調(diào)函數(shù))。
一個(gè)小技巧是你可以使用okay庫(kù)。你可以像下面的例子一樣使用它去避免在回調(diào)地獄中手動(dòng)去檢查錯(cuò)誤(你好, 回調(diào)地獄).
返回回調(diào)或者使用if … else
Node是并行的。但是如果你不夠細(xì)心也會(huì)因?yàn)檫@個(gè)特性產(chǎn)生bug。 為了安全起見(jiàn),應(yīng)該要使用return來(lái)終止代碼的繼續(xù)執(zhí)行:
這樣可以避免一些因?yàn)榇a邏輯的處理不當(dāng)導(dǎo)致一些不應(yīng)該執(zhí)行的內(nèi)容(或者錯(cuò)誤)被執(zhí)行。
請(qǐng)確保使用return去阻止代碼的繼續(xù)執(zhí)行。
監(jiān)聽(tīng) error 事件
Node中幾乎所有的類/對(duì)象都有事件分發(fā)器(觀察者模式)并且會(huì)廣播 error 事件。 這是一個(gè)很好的特性,可以使開(kāi)發(fā)者在這些討厭的錯(cuò)誤造成巨大后果之前捕捉到它們。
養(yǎng)成一個(gè)通過(guò).on()來(lái)創(chuàng)建error事件監(jiān)聽(tīng)的好習(xí)慣:
了解你的npm
很多的Node和前端的開(kāi)發(fā)者知道在安裝模塊的時(shí)候使用--save會(huì)在安裝模塊的同時(shí),會(huì)在package.json保存一條含有模塊版本信息的條目。當(dāng)然,還有--save-dev可以用于安裝devDependencies(在生成環(huán)境中不需要的模塊)。但是你知道用-S和-D是否可以代替--save 和--save-dev么?答案是可以的。
當(dāng)你安裝模塊的時(shí)候,你需要?jiǎng)h除-S和-D自動(dòng)為你模塊的版本號(hào)添加的^標(biāo)簽。否者當(dāng)你使用npm install(或者npm i)安裝模塊的時(shí)候,就會(huì)自動(dòng)拉取最新的鏡像(版本號(hào)的第二位數(shù)字)。例如v6.1.0就是v6.2.0的一個(gè)鏡像分支。
npm團(tuán)隊(duì)推薦使用semver,但是你最好不要這樣。npm團(tuán)隊(duì)認(rèn)為開(kāi)源開(kāi)發(fā)者會(huì)遵守semver所以他們?cè)趎pm安裝時(shí)自動(dòng)加上了^。沒(méi)有人可以去保證,所以最好是鎖定你的版本號(hào)。更好的辦法是使用shrinkwrap:npm shrinkwrap會(huì)生成一個(gè)包含依賴的具體版本的文件。