NodeJS入門（二）代碼的組織和部署 · NodeJS入門

使用NodeJS編寫程序前，為了有個良好的開端，首先需要準備好代碼的目錄結構和部署方式，就如同修房子要先搭腳手架。 ## 2.1 模塊路徑解析規則我們已經知道，require函數支持斜杠（/）或盤符（C:）開頭的絕對路徑，也支持（./）開頭的相對路徑。但這兩種路徑在模塊之間建立了強耦合關系，一旦某個模塊文件的存放位置需要變更，使用該模塊的其它模塊的代碼也需要跟著調整，變得牽一發動全身。因此，require函數支持第三種形式的路徑，寫法類似于foo/bar，并依次按照以下規則解析路徑，直到找到模塊位置。 **（1）內置模塊** 如果傳遞給 require 函數的是 NodeJS 內置模塊名稱，不做路徑解析，直接返回內部模塊的導出對象，例如` require('fs')`。 **（2）node_modules 目錄** NodeJS 定義了一個特殊的 node_modules 目錄用于存放模塊。例如某個模塊的絕對路徑是` /NodeJS/util/hello.js`，在該模塊中使用` require('foo/bar') `方式加載模塊時，則 NodeJS 依次嘗試使用以下路徑。 ~~~ /NodeJS/util/node_modules/foo/bar /NodeJS/node_modules/foo/bar /node_modules/foo/bar ~~~ **（3）NODE_PATH 環境變量** 與 PATH 環境變量類似，NodeJS 允許通過 NODE_PATH 環境變量來指定額外的模塊搜索路徑。NODE_PATH 環境變量中包含一到多個目錄路徑，路徑之間在 Linux 下使用`:`分隔，在 Windows 下使用`;`分隔。例如定義了以下 NODE_PATH 環境變量： ~~~ NODE_PATH=/home/user/lib:/home/lib ~~~ 當使用`require('foo/bar')`的方式加載模塊時，則 NodeJS 依次嘗試以下路徑。 ~~~ /home/user/lib/foo/bar /home/lib/foo/bar ~~~ ## 2.2 包我們已經知道了JS模塊的基本單位是單個JS文件，但復雜些的模塊往往由多個子模塊組成。為了便于管理和使用，把**由多個子模塊組成的大模塊稱做包**，并把所有子模塊放在同一個目錄里。在組成一個包的所有子模塊中，需要有一個入口模塊，入口模塊的導出對象被作為包的導出對象。例如有以下目錄結構。 ~~~ - /home/user/lib/ - cat/ head.js body.js main.js ~~~ 其中cat目錄定義了一個包，其中包含了3個子模塊。main.js作為入口模塊，其內容如下： ~~~javascript 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')`能達到目的，但是入口模塊名稱出現在路徑里看上去不是個好主意。因此我們需要做點額外的工作，讓包使用起來更像是單個模塊。 **index.js** 當模塊的文件名是index.js，加載模塊時可以使用模塊所在目錄的路徑代替模塊文件路徑，因此接著上例，以下兩條語句等價。 ~~~javascript var cat = require('/home/user/lib/cat'); var cat = require('/home/user/lib/cat/index'); ~~~ 這樣處理后，就只需要把包目錄路徑傳遞給require函數，感覺上整個目錄被當作單個模塊使用，更有整體感。 **package.json** 如果想自定義入口模塊的文件名和存放位置，就需要在包目錄下包含一個package.json文件，并在其中指定入口模塊的路徑。上例中的cat模塊可以重構如下。 ~~~ - /home/user/lib/ - cat/ + doc/ - lib/ head.js body.js main.js + tests/ package.json ~~~ 其中package.json內容如下。 ~~~javascript { "name": "cat", "main": "./lib/main.js" } ~~~ 如此一來，就同樣可以使用`require('/home/user/lib/cat')`的方式加載模塊。NodeJS會根據包目錄下的package.json找到入口模塊所在位置。 ### 2.2.1 工程目錄了解了以上知識后，現在我們可以來完整地規劃一個工程目錄了。以編寫一個命令行程序為例，一般我們會同時提供命令行模式和API模式兩種使用方式，并且我們會借助三方包來編寫代碼。除了代碼外，一個完整的程序也應該有自己的文檔和測試用例。因此，一個標準的工程目錄都看起來像下邊這樣。 ~~~ - /home/user/workspace/node-echo/ # 工程目錄 - bin/ # 存放命令行相關代碼 node-echo + doc/ # 存放文檔 - lib/ # 存放API相關代碼 echo.js - node_modules/ # 存放三方包 + argv/ + tests/ # 存放測試用例 package.json # 元數據文件 README.md # 說明文件 ~~~ 其中部分文件內容如下： ~~~javascript /* 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目錄也可被當作一個包來使用。 ## 2.3 NPM NPM是隨同NodeJS一起安裝的包管理工具，能解決NodeJS代碼部署上的很多問題，常見的使用場景有以下幾種： * 允許用戶從NPM服務器下載別人編寫的三方包到本地使用。 * 允許用戶從NPM服務器下載并安裝別人編寫的命令行程序到本地使用。 * 允許用戶將自己編寫的包或命令行程序上傳到NPM服務器供別人使用。可以看到，NPM建立了一個NodeJS生態圈，NodeJS開發者和用戶可以在里邊互通有無。以下分別介紹這三種場景下怎樣使用NPM。 **（1）下載三方包** 需要使用三方包時，首先得知道有哪些包可用。雖然npmjs.org提供了個搜索框可以根據包名來搜索，但如果連想使用的三方包的名字都不確定的話，就請百度一下吧。知道了包名后，比如上邊例子中的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可以改寫如下： ~~~javascript { "name": "node-echo", "main": "./lib/echo.js", "dependencies": { "argv": "0.0.2" } } ~~~ 這樣處理后，在工程目錄下就可以使用npm install命令批量安裝三方包了。更重要的是，當以后node-echo也上傳到了NPM服務器，別人下載這個包時，NPM會根據包中申明的三方包依賴自動下載進一步依賴的三方包。例如，使用`npm install node-echo`命令時，NPM會自動創建以下目錄結構。 ~~~ - project/ - node_modules/ - node-echo/ - node_modules/ + argv/ ... ... ~~~ 如此一來，用戶只需關心自己直接使用的三方包，不需要自己去解決所有包的依賴關系。 **（2）安裝命令行程序** 從NPM服務上下載安裝一個命令行程序的方法與三方包類似。例如上例中的node-echo提供了命令行使用方式，只要node-echo自己配置好了相關的package.json字段，對于用戶而言，只需要使用以下命令安裝程序。 ~~~ $ npm install node-echo -g ~~~ 參數中的-g表示全局安裝，因此node-echo會默認安裝到以下位置，并且NPM會自動創建好Linux系統下需要的軟鏈文件或Windows系統下需要的.cmd文件。 ~~~ - /usr/local/ # Linux系統下 - lib/node_modules/ + node-echo/ ... - bin/ node-echo ... ... - %APPDATA%\npm\ # Windows系統下 - node_modules\ + node-echo\ ... node-echo.cmd ... ~~~ **（3）發布代碼** 第一次使用NPM發布代碼前需要注冊一個賬號。終端下運行npm adduser，之后按照提示做即可。賬號搞定后，接著我們需要編輯package.json文件，加入NPM必需的字段。接著上邊node-echo的例子，package.json里必要的字段如下。 ~~~javascript { "name": "node-echo", # 包名，在NPM服務器上須要保持唯一 "version": "1.0.0", # 當前版本號 "dependencies": { # 三方包依賴，需要指定包名和版本號 "argv": "0.0.2" }, "main": "./lib/echo.js", # 入口模塊位置 "bin" : { "node-echo": "./bin/node-echo" # 命令行程序名和主模塊位置 } } ~~~ 之后，我們就可以在package.json所在目錄下運行npm publish發布代碼了。 ### 2.3.1 版本號使用NPM下載和發布代碼時都會接觸到版本號。NPM使用語義版本號來管理代碼，這里簡單介紹一下。語義版本號分為X.Y.Z三位，分別代表主版本號、次版本號和補丁版本號。當代碼變更時，版本號按以下原則更新。 * 如果只是修復bug，需要更新Z位。 * 如果是新增了功能，但是向下兼容，需要更新Y位。 * 如果有大變動，向下不兼容，需要更新X位。版本號有了這個保證后，在申明三方包依賴時，除了可依賴于一個固定版本號外，還可依賴于某個范圍的版本號。例如"argv": "0.0.x"表示依賴于0.0.x系列的最新版argv。NPM支持的所有版本號范圍指定方式可以查看官方文檔。 ### 2.3.2 其他除了本章介紹的部分外，NPM還提供了很多功能，package.json里也有很多其它有用的字段。除了可以查看[官方文檔](https://docs.npmjs.com/)外，這里再介紹一些NPM常用命令。 * NPM提供了很多命令，例如install和publish，使用`npm help`可查看所有命令。 * 使用`npm help <command>`可查看某條命令的詳細幫助，例如`npm help install`。 * 在package.json所在目錄下使用`npm install . -g`可先在本地安裝當前命令行程序，可用于發布前的本地測試。 * 使用`npm update <package>`可以把當前目錄下node_modules子目錄里邊的對應模塊更新至最新版本。 * 使用`npm update <package> -g`可以把全局安裝的對應命令行程序更新至最新版。 * 使用`npm cache clear`可以清空NPM本地緩存，用于對付使用相同版本號發布新版本代碼的人。 * 使用`npm unpublish <package>@<version>`可以撤銷發布自己發布過的某個版本代碼。