Like Share Discussion Bookmark Smile

J.J. Huang   2020-01-25   Node.js   瀏覽次數:

Node.js | Module System(模組系統)

簡介

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

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

建立模組

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

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

以上範例中,程式require('./hello')引入了當前目錄下的hello.js文件(./為當前目錄,node.js默認後綴為js)。

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

接著建立hello.js,程式如下:

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

在以上範例中,hello.js通過exports對象把world作為模組的訪問接口,在main.js中通過require('./hello')加載這個模組,然後就可以直接訪問hello.jsexports對象的成員函數了。

如果只是想把一個對象封裝到模組中,格式如下:

1
2
3
module.exports = function() {
  // ...
}

例如:

1
2
3
4
5
6
7
8
9
10
11
//hello.js
function Hello() {
    var name;
    this.setName = function(thyName) {
        name = thyName;
    };
    this.sayHello = function() {
        console.log('Hello ' + name);
    };
};
module.exports = Hello;

這樣就可以直接獲得這個對象了:

1
2
3
4
5
//main.js
var Hello = require('./hello');
hello = new Hello();
hello.setName('byMorose');
hello.sayHello();

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

服務端的模組放在哪裡

我們已經在程式中使用了模組了。

例如:

1
2
3
4
5
var http = require("http");

...

http.createServer(...);

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

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

Node.jsrequire方法中的文件查找策略如下:

由於Node.js中存在4類模組(原生模組和3種文件模組),儘管require方法極其簡單,但是內部的加載卻是十分複雜的,其加載優先級也各自不同。

如下圖所示:

從文件模組緩存中加載

儘管原生模組與文件模組的優先級不同,但是都會優先從文件模組的緩存中加載已經存在的模組。

從原生模組加載

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

原生模組也有一個緩存區,同樣也是優先從緩存區加載。如果緩存區沒有被加載過,則調用原生模組的加載方式進行加載和執行。

從文件加載

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

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

  • httpfspath等,原生模組。
  • ./mod../mod,相對路徑的文件模組。
  • /pathtomodule/mod,絕對路徑的文件模組。
  • mod,非原生模組的文件模組。

在路徑Y下執行require(X)語句執行順序:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
1. 如果 X 是內置模組
   a. 返回內置模組
   b. 停止執行
2. 如果 X 以 '/' 開頭
   a. 設置 Y 為文件根路徑
3. 如果 X 以 './' 或 '/' or '../' 開頭
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
4. LOAD_NODE_MODULES(X, dirname(Y))
5. 拋出異常 "not found"

LOAD_AS_FILE(X)
1. 如果 X 是一個文件, 將 X 作為 JavaScript 文本載入並停止執行。
2. 如果 X.js 是一個文件, 將 X.js 作為 JavaScript 文本載入並停止執行。
3. 如果 X.json 是一個文件, 解析 X.jsonJavaScript 對象並停止執行。
4. 如果 X.node 是一個文件, 將 X.node 作為二進制插件載入並停止執行。

LOAD_INDEX(X)
1. 如果 X/index.js 是一個文件, 將 X/index.js 作為 JavaScript 文本載入並停止執行。
2. 如果 X/index.json 是一個文件, 解析 X/index.jsonJavaScript 對象並停止執行。
3. 如果 X/index.node 是一個文件, 將 X/index.node 作為二進制插件載入並停止執行。

LOAD_AS_DIRECTORY(X)
1. 如果 X/package.json 是一個文件,
   a. 解析 X/package.json, 並查找 "main" 字段。
   b. let M = X + (json main 字段)
   c. LOAD_AS_FILE(M)
   d. LOAD_INDEX(M)
2. LOAD_INDEX(X)

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS

exports 和 module.exports 的使用
如果要對外暴露屬性或方法,就用 exports 就行,要暴露對象(類似class,包含了很多屬性和方法),就用 module.exports。


註:以上參考了
Node.js模块系统