模塊路徑解析規(guī)則

有經(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

包

我們已經(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 找到入口模塊所在位置。

最新評論