Nodejs的模塊機制及require用法

　最近接手了一個js開發的web項目，后端nodejs開發的，看代碼的時候發現這邊全忘光了，復習一下順便做個筆記。

node中的文件和模塊是一一對應的。一個node.js文件就是一個模塊，但是這個文件可能是js代碼，JSON或者編譯過的C/C++拓展。

1.模塊機制

Nodejs中提供了exports和require兩個對象，exports是模塊公開的接口，require用於從外部獲取一個模塊的接口，即所獲取的模塊的exports對象。

有關exports和module.exports的區別

正常對外暴露屬性或者方法，使用exports

如需要暴露對象（類似class，包含了很多屬性和方法），就使用module.exports

 

具體可以參考https://www.runoob.com/nodejs/nodejs-module-system.html

main.js

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

　　代碼require引入了當前目錄下的hello.js文件，使用了模塊exports出來的對象或者方法

hello.js

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

　　hello.js中通過exports對象將world作為模塊的訪問接口，在main.js內通過require加載這個模塊，然后就可以直接訪問hello.js里的exports對象的成員函數了。

 

修改hello.js和main.js

//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。

 

2.require查找機制

Node.js 的 require 方法中的文件查找策略如下：

 

 

從文件模塊緩存中加載

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

從原生模塊加載

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

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

從文件加載

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

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

• http、fs、path等，原生模塊。
• ./mod或../mod，相對路徑的文件模塊。
• /pathtomodule/mod，絕對路徑的文件模塊。
• mod，非原生模塊的文件模塊。

 

下面是一個完整的，在路徑 Y 下執行 require(X) 語句執行順序：

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.json 為 JavaScript 對象並停止執行。
4. 如果 X.node 是一個文件, 將 X.node 作為二進制插件載入並停止執行。

LOAD_INDEX(X)
1. 如果 X/index.js 是一個文件,  將 X/index.js 作為 JavaScript 文本載入並停止執行。
2. 如果 X/index.json 是一個文件, 解析 X/index.json 為 JavaScript 對象並停止執行。
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