Node.js模組系統


為了讓Node.js的檔案可以互相調用,Node.js提供了一個簡單的模組系統。

模組是Node.js 應用程式的基本組成部分,檔案和模組是一一對應的。換言之,一個 Node.js 檔案就是一個模組,這個檔案可能是JavaScript 程式碼、JSON 或編譯過的C/C++ 擴充功能。

建立模組

在Node.js 中,建立一個模組非常簡單,如下我們建立一個'main.js' 文件,程式碼如下:

var hello = require('./hello');
hello.world();

以上實例中,程式碼require('./hello') 引進了目前目錄下的hello.js檔(./ 為目前目錄,node.js預設後綴為js)。

Node.js 提供了exports 和 require 兩個對象,其中 exports 是模組公開的接口,require 用於從外部獲取一個模組的接口,即所獲取模組的 exports 對象。

接下來我們就來創建hello.js文件,程式碼如下:

exports.world = function() {
  console.log('Hello World');
}

在以上範例中,hello.js 透過exports 物件把world 作為模組的存取接口,在main.js中透過require('./hello') 載入這個模組,然後就可以直接訪 問 hello.js 中 exports 物件的成員函數了。

有時候我們只是想把一個物件封裝到模組中,格式如下:

module.exports = function() {
  // ...
}

例如:

//hello.js 
function Hello() { 
	var name; 
	this.setName = function(thyName) { 
		name = thyName; 
	}; 
	this.sayHello = function() { 
		console.log('Hello ' + name); 
	}; 
}; 
module.exports = Hello;

這樣就可以直接取得這個物件了:

//main.js 
var Hello = require('./hello'); 
hello = new Hello(); 
hello.setName('BYVoid'); 
hello.sayHello();

模組介面的唯一變化是使用module.exports = Hello 取代了exports.world = function(){}。 在外部引用該模組時,其介面物件就是要輸出的 Hello 物件本身,而不是原先的 exports。


服務端的模組放在哪裡

也許你已經注意到,我們已經在程式碼中使用了模組了。像這樣:

var http = require("http");

...

http.createServer(...);

Node.js中自帶了一個叫做"http"的模組,我們在我們的程式碼中請求它並將返回值賦給一個本地變數。

這把我們的本地變數變成了一個擁有所有 http 模組所提供的公共方法的物件。

Node.js 的require方法中的檔案尋找策略如下:

由於Node.js中存在4個類別模組(原生模組和3種檔案模組),儘管require方法極為簡單,但是內部的載入卻是十分複雜的,其載入優先權也各自不同。如下圖所示:

nodejs-require

從檔案模組快取載入

儘管原生模組與檔案模組的優先權不同,但是都不會優先於從檔案模組的快取中加載已經存在的模組。

從原生模組載入

原生模組的優先權僅次於檔案模組快取的優先權。 require方法在解析檔案名稱之後,優先檢查模組是否在原生模組清單中。以http模組為例,儘管在目錄下存在一個http/http.js/http.node/http.json文件,而require("http")都不會從這些文件中加載,而是從原生模組中加載。

原生模組也有一個快取區,同樣也是優先從快取區載入。如果快取區沒有被載入過,則呼叫原生模組的載入方式進行載入和執行。

從檔案載入

當檔案模組快取中不存在,而且不是原生模組的時候,Node.js會解析require方法傳入的參數,並從檔案系統載入實際的文件,載入過程中的包裝和編譯細節在前一節中已經介紹過,這裡我們將詳細描述查找文件模組的過程,其中,也有一些細節值得知曉。

require方法接受下列幾種參數的傳遞:

  • http、fs、path等,原生模組。

  • ./mod或../mod,相對路徑的檔案模組。

  • /pathtomodule/mod,絕對路徑的檔案模組。

  • mod,非原生模組的檔案模組。