DIV CSS 佈局教程網

Node.js 極簡入門(一):模組機制與載入規則
編輯:關於JavaScript     

JavaScript 的語言規範(ECMAScript)並未定義一套完善、能適用於多數應用程式的標準庫。CommonJS 針對這點提出了一套標準庫規範,而 Node 正是它的實作。理解 Node 的模組機制,是寫好 Node 程式的第一步。

模組基礎

在 Node 中,一個檔案就是一個模組,兩者一一對應。定義一個模組:

// circle.js
var PI = Math.PI;

// 導出函式 area
exports.area = function(r) {
  return PI * r * r;
}

// 導出函式 circumference
exports.circumference = function(r) {
  return 2 * PI * r;
};

把要對外公開的東西掛到 exports 物件上即可。模組內部的區域變數外部無法存取——例如上例中的 PI,使用 circle 模組的人拿不到它。這正是模組化的核心價值:明確區分公開介面與內部實作。

載入模組:

var circle = require('./circle.js');
console.log('半徑 4 的圓面積為 ' + circle.area(4));

另外補充一點:每個模組中都存在一個 module 物件代表模組本身,而 exports 只是 module 的一個屬性。

模組的載入與快取

Node 會快取已載入的模組,避免重複載入的成本:

// test.js
console.log("我在這裡");

多次載入同一個模組:

// 只會輸出一次「我在這裡」
require('./test');
require('./test');

第二次 require 直接從快取回傳,不會重新執行檔案。

副檔名的自動補全

當 require 的路徑沒有副檔名時,Node 會依序嘗試:

  1. .js:JavaScript 原始檔
  2. .node:C/C++ 撰寫的原生擴充模組
  3. .json:JSON 檔

模組的三種類型

1. 核心模組

已被編譯進 Node 二進位檔中,原始碼可在 Node 的 lib 目錄找到。常見的有 net、http、fs 等。

2. 檔案模組

透過相對路徑或絕對路徑載入,例如前面的 circle.js。

3. 自定義模組

放在 node_modules 目錄中,也就是 npm 安裝的各種套件所在位置。

載入優先順序

核心模組永遠優先。即使你在 node_modules 裡放了一個叫 http 的自定義模組,require('http') 仍會載入核心模組。

載入自定義模組時,Node 會先找當前目錄的 node_modules,再往上一層找,一層層往上直到根目錄。這個「向上遞歸」的規則解釋了為什麼專案中的套件能被子目錄的檔案找到。

包(package)

當 require 載入的目標是一個目錄而非檔案時,這個目錄就叫作「包」。包中應有一個 package.json 描述檔:

{
  "name" : "some-library",
  "main" : "./lib/some-library.js"
}

其中 main 指定實際要被載入的進入點。若包中沒有 package.json,或其中有描述檔但未指定 main,Node 會嘗試載入 index.js、index.node、index.json。

模組其實被包在一個函式裡

Node 在執行模組前,會把它包進一個函式:

function (exports, require, module, __filename, __dirname) {
  // 你的 JavaScript 模組內容
}

模組中能直接使用的 exports、require、module、__filename、__dirname,實際上都是這個函式的參數。正因為有這層包裹,模組的區域變數才不會外洩,也才不會污染全域。

一個常見的困惑

// test1.js
exports = {
  name: 'Name5566',
}
// test2.js
module.exports = {
  name: 'Name5566',
}
var test1 = require('./test1.js');
console.log(test1.name);  // undefined
var test2 = require('./test2.js');
console.log(test2.name);  // Name5566

為什麼差這麼多?因為 exports 只是傳進來的參數。exports.xxx = ... 是在這個物件上加屬性,有效;但 exports = {...} 只是把區域變數 exports 重新指向另一個物件,原始的 module.exports 完全沒被動到。

結論很簡單:

  • 要增加屬性,用 exports
  • 要整體取代,用 module.exports

實務上為了避免混淆,很多人乾脆只用 module.exports 一種寫法。

包的結構慣例

依 CommonJS 規範,一個完整的包應包含:

  1. package.json 描述檔
  2. bin 目錄:可執行檔
  3. lib 目錄:JavaScript 程式碼
  4. doc 目錄:文件
  5. test 目錄:測試程式

NPM 常用指令

# 查詢指令文件,例如 install 的用法
npm help install

# 安裝套件,會放到當前目錄的 node_modules
npm install redis

# 移除套件
npm remove redis

NPM 是 Node 的套件管理工具。理解模組的載入規則與 exports/module.exports 的差別,就能避開 Node 入門階段最常見的幾個坑。ES Module(import/export)是後來加入的另一套標準,規則略有不同(例如不支援上述的副檔名自動補全、且載入為非同步),兩者並存於今日的生態系中,值得另外理解。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved