代碼的組織和部署
有經(jīng)驗的C程序員在編寫一個新程序時首先從make文件寫起。同樣的，使用NodeJS編寫程序前，為了有個良好的開端，首先需要準備好代碼的目錄結構和部署方式，就如同修房子要先搭腳手架。本章將介紹與之相關的各種知識。
模塊路徑解析規(guī)則
我們已經(jīng)知道，require函數(shù)支持斜杠（/）或盤符（C:）開頭的絕對路徑，也支持./開頭的相對路徑。但這兩種路徑在模塊之間建立了強耦合關系，一旦某個模塊文件的存放位置需要變更，使用該模塊的其它模塊的代碼也需要跟著調(diào)整，變得牽一發(fā)動全身。因此，require函數(shù)支持第三種形式的路徑，寫法類似于foo/bar，并依次按照以下規(guī)則解析路徑，直到找到模塊位置。
-
內(nèi)置模塊
如果傳遞給require函數(shù)的是NodeJS內(nèi)置模塊名稱，不做路徑解析，直接返回內(nèi)部模塊的導出對象，例如require('fs')。
-
node_modules目錄
NodeJS定義了一個特殊的node_modules目錄用于存放模塊。例如某個模塊的絕對路徑是/home/user/hello.js，在該模塊中使用require('foo/bar')方式加載模塊時，則NodeJS依次嘗試使用以下路徑。
1 | /home/user/node_modules/foo/bar |
2 | /home/node_modules/foo/bar |
-
NODE_PATH環(huán)境變量
與PATH環(huán)境變量類似，NodeJS允許通過NODE_PATH環(huán)境變量來指定額外的模塊搜索路徑。NODE_PATH環(huán)境變量中包含一到多個目錄路徑，路徑之間在*nix下使用:分隔，在Windows下使用;分隔。例如定義了以下NODE_PATH環(huán)境變量：
1 | NODE_PATH=/home/user/lib:/home/lib |
當使用require('foo/bar')的方式加載模塊時，則NodeJS依次嘗試以下路徑。
包（package）
我們已經(jīng)知道了JS模塊的基本單位是單個JS文件，但復雜些的模塊往往由多個子模塊組成。為了便于管理和使用，我們可以把由多個子模塊組成的大模塊稱做包，并把所有子模塊放在同一個目錄里。
在組成一個包的所有子模塊中，需要有一個入口模塊，入口模塊的導出對象被作為包的導出對象。例如有以下目錄結構。
其中cat目錄定義了一個包，其中包含了3個子模塊。main.js作為入口模塊，其內(nèi)容如下：
01 | var head = require('./head'); |
02 | var body = require('./body'); |
04 | exports.create = function (name) { |
在其它模塊里使用包的時候，需要加載包的入口模塊。接著上例，使用require('/home/user/lib/cat/main')能達到目的，但是入口模塊名稱出現(xiàn)在路徑里看上去不是個好主意。因此我們需要做點額外的工作，讓包使用起來更像是單個模塊。
index.js
當模塊的文件名是index.js，加載模塊時可以使用模塊所在目錄的路徑代替模塊文件路徑，因此接著上例，以下兩條語句等價。
1 | var cat = require('/home/user/lib/cat'); |
2 | var cat = require('/home/user/lib/cat/index'); |
這樣處理后，就只需要把包目錄路徑傳遞給require函數(shù)，感覺上整個目錄被當作單個模塊使用，更有整體感。
package.json
如果想自定義入口模塊的文件名和存放位置，就需要在包目錄下包含一個package.json文件，并在其中指定入口模塊的路徑。上例中的cat模塊可以重構如下。
其中package.json內(nèi)容如下。
3 | "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這個位置。為了在任何目錄下都能運行該程序，我們需要使用以下終端命令。
1 | $ node /home/user/bin/node-echo.js Hello World |
這種使用方式看起來不怎么像是一個命令行程序，下邊的才是我們期望的方式。
*nix
在*nix系統(tǒng)下，我們可以把JS文件當作shell腳本來運行，從而達到上述目的，具體步驟如下：
-
在shell腳本中，可以通過#!注釋來指定當前腳本使用的解析器。所以我們首先在node-echo.js文件頂部增加以下一行注釋，表明當前腳本使用NodeJS解析。
NodeJS會忽略掉位于JS模塊首行的#!注釋，不必擔心這行注釋是非法語句。
-
然后，我們使用以下命令賦予node-echo.js文件執(zhí)行權限。
1 | $ chmod +x /home/user/bin/node-echo.js |
-
最后，我們在PATH環(huán)境變量中指定的某個目錄下，例如在/usr/local/bin下邊創(chuàng)建一個軟鏈文件，文件名與我們希望使用的終端命令同名，命令如下：
1 | $ sudo ln -s /home/user/bin/node-echo.js /usr/local/bin/node-echo |
這樣處理后，我們就可以在任何目錄下使用node-echo命令了。
Windows
在Windows系統(tǒng)下的做法完全不同，我們得靠.cmd文件來解決問題。假設node-echo.js存放在C:\Users\user\bin目錄，并且該目錄已經(jīng)添加到PATH環(huán)境變量里了。接下來需要在該目錄下新建一個名為node-echo.cmd的文件，文件內(nèi)容如下：
1 | @node "C:\User\user\bin\node-echo.js" %* |
這樣處理后，我們就可以在任何目錄下使用node-echo命令了。
工程目錄
了解了以上知識后，現(xiàn)在我們可以來完整地規(guī)劃一個工程目錄了。以編寫一個命令行程序為例，一般我們會同時提供命令行模式和API模式兩種使用方式，并且我們會借助三方包來編寫代碼。除了代碼外，一個完整的程序也應該有自己的文檔和測試用例。因此，一個標準的工程目錄都看起來像下邊這樣。
01 | - /home/user/workspace/node-echo/ # 工程目錄 |
07 | - node_modules/ # 存放三方包 |
10 | package.json # 元數(shù)據(jù)文件 |
其中部分文件內(nèi)容如下：
02 | var argv = require('argv'), |
03 | echo = require('../lib/echo'); |
04 | console.log(echo(argv.join(' '))); |
07 | module.exports = function (message) { |
14 | "main": "./lib/echo.js" |
以上例子中分類存放了不同類型的文件，并通過node_moudles目錄直接使用三方包名加載模塊。此外，定義了package.json之后，node-echo目錄也可被當作一個包來使用。
NPM
NPM是隨同NodeJS一起安裝的包管理工具，能解決NodeJS代碼部署上的很多問題，常見的使用場景有以下幾種：
-
允許用戶從NPM服務器下載別人編寫的三方包到本地使用。
-
允許用戶從NPM服務器下載并安裝別人編寫的命令行程序到本地使用。
-
允許用戶將自己編寫的包或命令行程序上傳到NPM服務器供別人使用。
可以看到，NPM建立了一個NodeJS生態(tài)圈，NodeJS開發(fā)者和用戶可以在里邊互通有無。以下分別介紹這三種場景下怎樣使用NPM。
下載三方包
需要使用三方包時，首先得知道有哪些包可用。雖然提供了個搜索框可以根據(jù)包名來搜索，但如果連想使用的三方包的名字都不確定的話，就請百度一下吧。知道了包名后，比如上邊例子中的argv，就可以在工程目錄下打開終端，使用以下命令來下載三方包。
3 | argv@0.0.2 node_modules\argv |
下載好之后，argv包就放在了工程目錄下的node_modules目錄中，因此在代碼中只需要通過require('argv')的方式就好，無需指定三方包路徑。
以上命令默認下載最新版三方包，如果想要下載指定版本的話，可以在包名后邊加上@<version>，例如通過以下命令可下載0.0.1版的argv。
1 | $ npm install argv@0.0.1 |
3 | argv@0.0.1 node_modules\argv |
如果使用到的三方包比較多，在終端下一個包一條命令地安裝未免太人肉了。因此NPM對package.json的字段做了擴展，允許在其中申明三方包依賴。因此，上邊例子中的package.json可以改寫如下：
3 | "main": "./lib/echo.js", |
這樣處理后，在工程目錄下就可以使用npm install命令批量安裝三方包了。更重要的是，當以后node-echo也上傳到了NPM服務器，別人下載這個包時，NPM會根據(jù)包中申明的三方包依賴自動下載進一步依賴的三方包。例如，使用npm install node-echo命令時，NPM會自動創(chuàng)建以下目錄結構。
如此一來，用戶只需關心自己直接使用的三方包，不需要自己去解決所有包的依賴關系。
安裝命令行程序
從NPM服務上下載安裝一個命令行程序的方法與三方包類似。例如上例中的node-echo提供了命令行使用方式，只要node-echo自己配置好了相關的package.json字段，對于用戶而言，只需要使用以下命令安裝程序。
1 | $ npm install node-echo -g |
參數(shù)中的-g表示全局安裝，因此node-echo會默認安裝到以下位置，并且NPM會自動創(chuàng)建好*nix系統(tǒng)下需要的軟鏈文件或Windows系統(tǒng)下需要的.cmd文件。
01 | - /usr/local/ # *nix系統(tǒng)下 |
10 | - %APPDATA%\npm\ # Windows系統(tǒng)下 |
發(fā)布代碼
第一次使用NPM發(fā)布代碼前需要注冊一個賬號。終端下運行npm adduser，之后按照提示做即可。賬號搞定后，接著我們需要編輯package.json文件，加入NPM必需的字段。接著上邊node-echo的例子，package.json里必要的字段如下。
02 | "name": "node-echo", # 包名，在NPM服務器上須要保持唯一 |
03 | "version": "1.0.0", # 當前版本號 |
04 | "dependencies": { # 三方包依賴，需要指定包名和版本號 |
07 | "main": "./lib/echo.js", # 入口模塊位置 |
09 | "node-echo": "./bin/node-echo" # 命令行程序名和主模塊位置 |
之后，我們就可以在package.json所在目錄下運行npm publish發(fā)布代碼了。
版本號
使用NPM下載和發(fā)布代碼時都會接觸到版本號。NPM使用語義版本號來管理代碼，這里簡單介紹一下。
語義版本號分為X.Y.Z三位，分別代表主版本號、次版本號和補丁版本號。當代碼變更時，版本號按以下原則更新。
3 | + 如果是新增了功能，但是向下兼容，需要更新Y位。 |
版本號有了這個保證后，在申明三方包依賴時，除了可依賴于一個固定版本號外，還可依賴于某個范圍的版本號。例如"argv": "0.0.x"表示依賴于0.0.x系列的最新版argv。NPM支持的所有版本號范圍指定方式可以查看官方文檔。
靈機一點
除了本章介紹的部分外，NPM還提供了很多功能，package.json里也有很多其它有用的字段。除了可以在/doc/查看官方文檔外，這里再介紹一些NPM常用命令。
-
NPM提供了很多命令，例如install和publish，使用npm help可查看所有命令。
-
使用npm help <command>可查看某條命令的詳細幫助，例如npm help install。
-
在package.json所在目錄下使用npm install . -g可先在本地安裝當前命令行程序，可用于發(fā)布前的本地測試。
-
使用npm update <package>可以把當前目錄下node_modules子目錄里邊的對應模塊更新至最新版本。
-
使用npm update <package> -g可以把全局安裝的對應命令行程序更新至最新版。
-
使用npm cache clear可以清空NPM本地緩存，用于對付使用相同版本號發(fā)布新版本代碼的人。
-
使用npm unpublish <package>@<version>可以撤銷發(fā)布自己發(fā)布過的某個版本代碼。
小結
本章介紹了使用NodeJS編寫代碼前需要做的準備工作，總結起來有以下幾點：
-
編寫代碼前先規(guī)劃好目錄結構，才能做到有條不紊。
-
捎大些的程序可以將代碼拆分為多個模塊管理，更大些的程序可以使用包來組織模塊。
-
合理使用node_modules和NODE_PATH來解耦包的使用方式和物理路徑。
-
使用NPM加入NodeJS生態(tài)圈互通有無。
-
想到了心儀的包名時請?zhí)崆霸贜PM上搶注。
|
