代碼的組織和部署
有經(jīng)驗的C程序員在編寫一個新程序時首先從make文件寫起劝堪。同樣的法挨，使用NodeJS編寫程序前，為了有個良好的開端幅聘，首先需要準備好代碼的目錄結(jié)構(gòu)和部署方式，就如同修房子要先搭腳手架窃植。本章將介紹與之相關(guān)的各種知識帝蒿。
模塊路徑解析規(guī)則
我們已經(jīng)知道，require函數(shù)支持斜杠（/）或盤符（C:）開頭的絕對路徑巷怜，也支持./開頭的相對路徑葛超。但這兩種路徑在模塊之間建立了強耦合關(guān)系，一旦某個模塊文件的存放位置需要變更延塑，使用該模塊的其它模塊的代碼也需要跟著調(diào)整绣张，變得牽一發(fā)動全身。因此关带，require函數(shù)支持第三種形式的路徑侥涵，寫法類似于foo/bar，并依次按照以下規(guī)則解析路徑宋雏，直到找到模塊位置芜飘。
-
內(nèi)置模塊
如果傳遞給
require函數(shù)的是NodeJS內(nèi)置模塊名稱，不做路徑解析磨总，直接返回內(nèi)部模塊的導(dǎo)出對象嗦明，例如require('fs')。 -
node_modules目錄
NodeJS定義了一個特殊的
node_modules目錄用于存放模塊蚪燕。例如某個模塊的絕對路徑是/home/user/hello.js娶牌，在該模塊中使用require('foo/bar')方式加載模塊時，則NodeJS依次嘗試使用以下路徑馆纳。/home/user/node_modules/foo/bar /home/node_modules/foo/bar /node_modules/foo/bar -
NODE_PATH環(huán)境變量
與PATH環(huán)境變量類似诗良，NodeJS允許通過NODE_PATH環(huán)境變量來指定額外的模塊搜索路徑。NODE_PATH環(huán)境變量中包含一到多個目錄路徑厕诡，路徑之間在Linux下使用
:分隔累榜，在Windows下使用;分隔。例如定義了以下NODE_PATH環(huán)境變量：NODE_PATH=/home/user/lib:/home/lib當使用
require('foo/bar')的方式加載模塊時灵嫌，則NodeJS依次嘗試以下路徑壹罚。/home/user/lib/foo/bar /home/lib/foo/bar
包（package）
我們已經(jīng)知道了JS模塊的基本單位是單個JS文件，但復(fù)雜些的模塊往往由多個子模塊組成寿羞。為了便于管理和使用猖凛，我們可以把由多個子模塊組成的大模塊稱做包，并把所有子模塊放在同一個目錄里辨泳。
在組成一個包的所有子模塊中，需要有一個入口模塊第岖，入口模塊的導(dǎo)出對象被作為包的導(dǎo)出對象试溯。例如有以下目錄結(jié)構(gòu)。
- /home/user/lib/
- cat/
head.js
body.js
main.js
其中cat目錄定義了一個包键袱，其中包含了3個子模塊蹄咖。main.js作為入口模塊，其內(nèi)容如下：
var head = require('./head');
var body = require('./body');
exports.create = function (name) {
return {
name: name,
head: head.create(),
body: body.create()
};
};
在其它模塊里使用包的時候澜汤，需要加載包的入口模塊银亲。接著上例纽匙，使用require('/home/user/lib/cat/main')能達到目的，但是入口模塊名稱出現(xiàn)在路徑里看上去不是個好主意馏段。因此我們需要做點額外的工作践瓷，讓包使用起來更像是單個模塊。
index.js
當模塊的文件名是index.js喷舀，加載模塊時可以使用模塊所在目錄的路徑代替模塊文件路徑硫麻，因此接著上例樊卓，以下兩條語句等價。
var cat = require('/home/user/lib/cat');
var cat = require('/home/user/lib/cat/index');
這樣處理后浇辜，就只需要把包目錄路徑傳遞給require函數(shù)，感覺上整個目錄被當作單個模塊使用待诅，更有整體感熊镣。
package.json
如果想自定義入口模塊的文件名和存放位置，就需要在包目錄下包含一個package.json文件，并在其中指定入口模塊的路徑毕箍。上例中的cat模塊可以重構(gòu)如下道盏。
- /home/user/lib/
- cat/
+ doc/
- lib/
head.js
body.js
main.js
+ tests/
package.json
其中package.json內(nèi)容如下。
{
"name": "cat",
"main": "./lib/main.js"
}
如此一來媒咳，就同樣可以使用require('/home/user/lib/cat')的方式加載模塊涩澡。NodeJS會根據(jù)包目錄下的package.json找到入口模塊所在位置坠敷。
命令行程序
使用NodeJS編寫的東西，要么是一個包粥帚，要么是一個命令行程序芒涡，而前者最終也會用于開發(fā)后者卖漫。因此我們在部署代碼時需要一些技巧，讓用戶覺得自己是在使用一個命令行程序依啰。
例如我們用NodeJS寫了個程序店枣，可以把命令行參數(shù)原樣打印出來。該程序很簡單闷旧，在主模塊內(nèi)實現(xiàn)了所有功能。并且寫好后匠襟，我們把該程序部署在/home/user/bin/node-echo.js這個位置该园。為了在任何目錄下都能運行該程序里初，我們需要使用以下終端命令。
$ node /home/user/bin/node-echo.js Hello World
Hello World
這種使用方式看起來不怎么像是一個命令行程序淮阐，下邊的才是我們期望的方式刁品。
$ node-echo Hello World
Linux
在Linux系統(tǒng)下挑随，我們可以把JS文件當作shell腳本來運行，從而達到上述目的竞阐，具體步驟如下：
-
在shell腳本中暑劝，可以通過
#!注釋來指定當前腳本使用的解析器。所以我們首先在node-echo.js文件頂部增加以下一行注釋幕垦，表明當前腳本使用NodeJS解析先改。#! /usr/bin/env nodeNodeJS會忽略掉位于JS模塊首行的
#!注釋蒸走，不必擔心這行注釋是非法語句。 -
然后该溯，我們使用以下命令賦予
node-echo.js文件執(zhí)行權(quán)限。$ chmod +x /home/user/bin/node-echo.js -
最后夫椭，我們在PATH環(huán)境變量中指定的某個目錄下氯庆，例如在
/usr/local/bin下邊創(chuàng)建一個軟鏈文件，文件名與我們希望使用的終端命令同名仁讨，命令如下：$ sudo ln -s /home/user/bin/node-echo.js /usr/local/bin/node-echo
這樣處理后陪竿，我們就可以在任何目錄下使用node-echo命令了屠橄。
Windows
在Windows系統(tǒng)下的做法完全不同锐墙，我們得靠.cmd文件來解決問題长酗。假設(shè)node-echo.js存放在C:\Users\user\bin目錄，并且該目錄已經(jīng)添加到PATH環(huán)境變量里了之拨。接下來需要在該目錄下新建一個名為node-echo.cmd的文件咧叭，文件內(nèi)容如下：
@node "C:\User\user\bin\node-echo.js" %*
這樣處理后，我們就可以在任何目錄下使用node-echo命令了吉挣。
工程目錄
了解了以上知識后睬魂，現(xiàn)在我們可以來完整地規(guī)劃一個工程目錄了镀赌。以編寫一個命令行程序為例焰雕，一般我們會同時提供命令行模式和API模式兩種使用方式，并且我們會借助三方包來編寫代碼容客。除了代碼外蛾扇，一個完整的程序也應(yīng)該有自己的文檔和測試用例舔痕。因此伯复，一個標準的工程目錄都看起來像下邊這樣。
- /home/user/workspace/node-echo/ # 工程目錄
- bin/ # 存放命令行相關(guān)代碼
node-echo
+ doc/ # 存放文檔
- lib/ # 存放API相關(guān)代碼
echo.js
- node_modules/ # 存放三方包
+ argv/
+ tests/ # 存放測試用例
package.json # 元數(shù)據(jù)文件
README.md # 說明文件
其中部分文件內(nèi)容如下：
/* bin/node-echo */
var argv = require('argv'),
echo = require('../lib/echo');
console.log(echo(argv.join(' ')));
/* lib/echo.js */
module.exports = function (message) {
return message;
};
/* package.json */
{
"name": "node-echo",
"main": "./lib/echo.js"
}
以上例子中分類存放了不同類型的文件侍匙，并通過node_moudles目錄直接使用三方包名加載模塊想暗。此外帘不，定義了package.json之后寞焙，node-echo目錄也可被當作一個包來使用。
NPM
NPM是隨同NodeJS一起安裝的包管理工具辽狈，能解決NodeJS代碼部署上的很多問題呛牲，常見的使用場景有以下幾種：
允許用戶從NPM服務(wù)器下載別人編寫的三方包到本地使用。
允許用戶從NPM服務(wù)器下載并安裝別人編寫的命令行程序到本地使用尊勿。
允許用戶將自己編寫的包或命令行程序上傳到NPM服務(wù)器供別人使用元扔。
可以看到旋膳，NPM建立了一個NodeJS生態(tài)圈，NodeJS開發(fā)者和用戶可以在里邊互通有無擅羞。以下分別介紹這三種場景下怎樣使用NPM减俏。
下載三方包
需要使用三方包時，首先得知道有哪些包可用奏夫。雖然npmjs.org提供了個搜索框可以根據(jù)包名來搜索历筝，但如果連想使用的三方包的名字都不確定的話梳猪，就請百度一下吧。知道了包名后呛哟，比如上邊例子中的argv匿沛，就可以在工程目錄下打開終端，使用以下命令來下載三方包。
$ npm install argv
...
argv@0.0.2 node_modules\argv
下載好之后蜘渣，argv包就放在了工程目錄下的node_modules目錄中肺然，因此在代碼中只需要通過require('argv')的方式就好，無需指定三方包路徑拾碌。
以上命令默認下載最新版三方包校翔，如果想要下載指定版本的話灾前，可以在包名后邊加上@<version>，例如通過以下命令可下載0.0.1版的argv蔫敲。
$ npm install argv@0.0.1
...
argv@0.0.1 node_modules\argv
如果使用到的三方包比較多貌虾，在終端下一個包一條命令地安裝未免太人肉了尽狠。因此NPM對package.json的字段做了擴展伯诬，允許在其中申明三方包依賴盗似。因此，上邊例子中的package.json可以改寫如下：
{
"name": "node-echo",
"main": "./lib/echo.js",
"dependencies": {
"argv": "0.0.2"
}
}
這樣處理后悍及，在工程目錄下就可以使用npm install命令批量安裝三方包了心赶。更重要的是缺猛，當以后node-echo也上傳到了NPM服務(wù)器，別人下載這個包時耻姥，NPM會根據(jù)包中申明的三方包依賴自動下載進一步依賴的三方包有咨。例如，使用npm install node-echo命令時婉商，NPM會自動創(chuàng)建以下目錄結(jié)構(gòu)丈秩。
- project/
- node_modules/
- node-echo/
- node_modules/
+ argv/
...
...
如此一來淳衙，用戶只需關(guān)心自己直接使用的三方包挽唉，不需要自己去解決所有包的依賴關(guān)系瓶籽。
安裝命令行程序
從NPM服務(wù)上下載安裝一個命令行程序的方法與三方包類似塑顺。例如上例中的node-echo提供了命令行使用方式俏险，只要node-echo自己配置好了相關(guān)的package.json字段，對于用戶而言裤唠，只需要使用以下命令安裝程序种蘸。
$ npm install node-echo -g
參數(shù)中的-g表示全局安裝竞膳，因此node-echo會默認安裝到以下位置，并且NPM會自動創(chuàng)建好Linux系統(tǒng)下需要的軟鏈文件或Windows系統(tǒng)下需要的.cmd文件刊侯。
- /usr/local/ # Linux系統(tǒng)下
- lib/node_modules/
+ node-echo/
...
- bin/
node-echo
...
...
- %APPDATA%\npm\ # Windows系統(tǒng)下
- node_modules\
+ node-echo\
...
node-echo.cmd
...
發(fā)布代碼
第一次使用NPM發(fā)布代碼前需要注冊一個賬號滨彻。終端下運行npm adduser挪蹭，之后按照提示做即可。賬號搞定后冬骚，接著我們需要編輯package.json文件懂算，加入NPM必需的字段计技。接著上邊node-echo的例子山橄，package.json里必要的字段如下。
{
"name": "node-echo", # 包名睡雇，在NPM服務(wù)器上須要保持唯一
"version": "1.0.0", # 當前版本號
"dependencies": { # 三方包依賴它抱，需要指定包名和版本號
"argv": "0.0.2"
},
"main": "./lib/echo.js", # 入口模塊位置
"bin" : {
"node-echo": "./bin/node-echo" # 命令行程序名和主模塊位置
}
}
之后，我們就可以在package.json所在目錄下運行npm publish發(fā)布代碼了混移。
版本號
使用NPM下載和發(fā)布代碼時都會接觸到版本號歌径。NPM使用語義版本號來管理代碼亲茅，這里簡單介紹一下。
語義版本號分為X.Y.Z三位勺届，分別代表主版本號娶耍、次版本號和補丁版本號。當代碼變更時胚膊，版本號按以下原則更新紊婉。
+ 如果只是修復(fù)bug辑舷，需要更新Z位。
+ 如果是新增了功能肢础，但是向下兼容碌廓，需要更新Y位。
+ 如果有大變動慨蛙，向下不兼容，需要更新X位跟匆。
版本號有了這個保證后通砍，在申明三方包依賴時，除了可依賴于一個固定版本號外垢揩，還可依賴于某個范圍的版本號叁巨。例如"argv": "0.0.x"表示依賴于0.0.x系列的最新版argv呐籽。NPM支持的所有版本號范圍指定方式可以查看官方文檔。
靈機一點
除了本章介紹的部分外庶橱，NPM還提供了很多功能贪惹，package.json里也有很多其它有用的字段。除了可以在npmjs.org/doc/查看官方文檔外枫绅，這里再介紹一些NPM常用命令并淋。
NPM提供了很多命令珍昨，例如
install和publish，使用npm help可查看所有命令兔毙。使用
npm help <command>可查看某條命令的詳細幫助瞒御，例如npm help install神郊。在
package.json所在目錄下使用npm install . -g可先在本地安裝當前命令行程序，可用于發(fā)布前的本地測試涌乳。使用
npm update <package>可以把當前目錄下node_modules子目錄里邊的對應(yīng)模塊更新至最新版本。使用
npm update <package> -g可以把全局安裝的對應(yīng)命令行程序更新至最新版宛乃。使用
npm cache clear可以清空NPM本地緩存征炼，用于對付使用相同版本號發(fā)布新版本代碼的人躬贡。使用
npm unpublish <package>@<version>可以撤銷發(fā)布自己發(fā)布過的某個版本代碼。
小結(jié)
本章介紹了使用NodeJS編寫代碼前需要做的準備工作酸些，總結(jié)起來有以下幾點：
編寫代碼前先規(guī)劃好目錄結(jié)構(gòu)魄懂，才能做到有條不紊闯第。
稍大些的程序可以將代碼拆分為多個模塊管理，更大些的程序可以使用包來組織模塊肃廓。
合理使用
node_modules和NODE_PATH來解耦包的使用方式和物理路徑盲赊。使用NPM加入NodeJS生態(tài)圈互通有無敷扫。
想到了心儀的包名時請?zhí)崆霸贜PM上搶注。
