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方法極其簡單,但是內部的加載卻是十分複雜的,其加載優先級也各自不同。 如下圖所示:
從文件模塊緩存中加載
儘管原生模塊與文件模塊的優先級不同,但是都不會優先於從文件模塊的緩存中加載已經存在的模塊。
從原生模塊加載
原生模塊的優先級僅次於文件模塊緩存的優先級。 require方法在解析文件名之後,優先檢查模塊是否在原生模塊列表中。 以http模塊為例,儘管在目錄下存在一個http/http.js/http.node/http.json文件,require("http")都不會從這些文件中加載,而是從原生模塊中加載。
原生模塊也有一個緩存區,同樣也是優先從緩存區加載。 如果緩存區沒有被加載過,則調用原生模塊的加載方式進行加載和執行。
從文件加載
當文件模塊緩存中不存在,而且不是原生模塊的時候,Node.js會解析require方法傳入的參數,並從文件系統中加載實際的文件,加載過程中的包裝和編譯細節在前一節中已經介紹過,這裡我們將詳細描述查找文件模塊的過程,其中,也有一些細節值得知曉。
require方法接受以下幾種參數的傳遞:
- http、fs、path等,原生模塊。
- ./mod或../mod,相對路徑的文件模塊。
- /pathtomodule/mod,絕對路徑的文件模塊。
- mod,非原生模塊的文件模塊。