Node.js 的模塊有哪些

這篇文章給大家分享的是有關Node.js 的模塊有哪些的內容。小編覺得挺實用的，因此分享給大家做個參考。一起跟隨小編過來看看吧。

Node.js 的模塊

JavaScript 做為一門為網頁添加交互功能的簡單腳本語言問世，在開始并不包含模塊系統，隨著 JavaScript 解決問題越來越復雜，把所有代碼寫在一個文件內，用 function 區分功能單元已經不能支撐復雜應用開發了，ES6 帶來了大部分高級語言都有的 class 和 module，方便開發者組織代碼

import _ from 'lodash';

class Fun {}

export default Fun;

上面三行代碼展示了一個模塊系統最重要的兩個要素 import 和 export

• export用于規定模塊的對外接口

• import用于輸入其他模塊提供的功能

而在 ES6 之前，社區出現了很多模塊加載方案，最主要的有 CommonJS 和 AMD 兩種，Node.js 誕生早于 ES6，模塊系統使用的是類似 CommonJS 的實現，遵從幾個原則

• 一個文件是一個模塊，文件內的變量作用域都在模塊內

• 使用 module.exports 對象導出模塊對外接口

• 使用 require 引入其它模塊

circle.js

const { PI } = Math;

module.exports = function area(r) {
  PI * r ** 2;
};

上面代碼就實現了 Node.js 的一個模塊，模塊沒有依賴其它模塊，導出了方法 area 計算圓的面積

test.js

const area = require('./circle.js');
console.log(`半徑為 4 的圓的面積是 ${area(4)}`);

模塊依賴了 circle.js，使用其對外暴露的 area 方法，計算圓的面積

module.exports

模塊對外暴露接口使用 module.exports，常見的有兩種用法：為其添加屬性或賦值到新對象
test.js

// 添加屬性
module.exports.prop1 = xxx;
module.exports.funA = xxx;
module.exports.funB = xxx;

// 賦值到全新對象
module.exports = {
  prop1,
	funA,
  funB,
};

兩種寫法是等價的，使用時候沒區別

const mod = require('./test.js');

console.log(mod.prop1);
console.log(mod.funA());

還有另外一種直接使用 exports 對象的方法，但是只能對其添加屬性，不能賦值到新對象，后面會介紹原因

// 正確的寫法：添加屬性
exports.prop1 = xxx;
exports.funA = xxx;
exports.funB = xxx;

// 賦值到全新對象
module.exports = {
  prop1,
	funA,
  funB,
};

require('id')

模塊類型

require 用法比較簡單，id 支持模塊名和文件路徑兩種類型

模塊名

const fs = require('fs');
const _ = require('lodash');

示例中的 fs、lodash 都是模塊名，fs 是 Node.js 內置的核心模塊，lodash 是通過 npm 安裝到 node_modules 下的第三方模塊，如果出現重名，優先使用系統內置模塊

因為一個項目內可能會包含多個 node_modules 文件夾（Node.js 比較失敗的設計），第三方模塊查找過程會遵循就近原則逐層上溯（可以在程序中打印 module.paths 查看具體查找路徑），直到根據 NODE_PATH 環境變量查找到文件系統根目錄，具體過程可以參考官方文檔

此外，Node.js 還會搜索以下的全局目錄列表：

• $HOME/.node_modules
• $HOME/.node_libraries
• $PREFIX/lib/node

其中 $HOME 是用戶的主目錄， $PREFIX 是 Node.js 里配置的 node_prefix。強烈建議將所有的依賴放在本地的 node_modules 目錄，這樣將會更快地加載，且更可靠

文件路徑

模塊還可以可以使用文件路徑加載，這是項目內自定義模塊的通用加載方式，路徑可以省略拓展名，會按照 .js、.json、.node 順序嘗試

• 以 '/' 為前綴的模塊是文件的絕對路徑，按照系統路徑查找模塊
• 以 './' 為前綴的模塊是相對于當前調用 require 方法的文件，不受后續模塊在哪里被使用到影響

單次加載 & 循環依賴

模塊在第一次加載后會被緩存到 Module._cache ，如果每次調用 require('foo') 都解析到同一文件，則返回相同的對象，同時多次調用 require(foo) 不會導致模塊的代碼被執行多次。 Node.js 根據實際的文件名緩存模塊，因此從不同層級目錄引用相同模塊不會重復加載。

理解的模塊單次加載機制方便我們理解模塊循環依賴后的現象
a.js

console.log('a 開始');
exports.done = false;
const b = require('./b.js');
console.log('在 a 中，b.done = %j', b.done);
exports.done = true;
console.log('a 結束');

b.js

console.log('b 開始');
exports.done = false;
const a = require('./a.js');
console.log('在 b 中，a.done = %j', a.done);
exports.done = true;
console.log('b 結束');

main.js:

console.log('main 開始');
const a = require('./a.js');
const b = require('./b.js');
console.log('在 main 中，a.done=%j，b.done=%j', a.done, b.done);

當 main.js 加載 a.js 時，a.js 又加載 b.js,此時，b.js 會嘗試去加載 a.js

為了防止無限的循環會返回一個 a.js 的 exports 對象的 未完成的副本 給 b.js 模塊，然后 b.js 完成加載，并將 exports 對象提供給 a.js 模塊

因此示例的輸出是

main 開始
a 開始
b 開始
在 b 中，a.done = false
b 結束
在 a 中，b.done = true
a 結束
在 main 中，a.done=true，b.done=true

看不懂上面的過程也沒關系，日常工作根本用不到，即使看懂了也不要在項目中使用循環依賴！

工作原理

Node.js 每個文件都是一個模塊，模塊內的變量都是局部變量，不會污染全局變量，在執行模塊代碼之前，Node.js 會使用一個如下的函數封裝器將模塊封裝

(function(exports, require, module, __filename, __dirname) {
	// 模塊的代碼實際上在這里
});

• __filename：當前模塊文件的絕對路徑
• __dirname：當前模塊文件據所在目錄的絕對路徑
• module：當前的模塊實例
• require：加載其它模塊的方法，module.require 的快捷方式
• exports：導出模塊接口的對象，module.exports 的快捷方式

回頭看看最開始的問題，為什么 exports 對象不支持賦值為其它對象？把上面函數添加一句 exports 對象來源就很簡單了

const exports = module.exports;
(function(exports, require, module, __filename, __dirname) {
	// 模塊的代碼實際上在這里
});

其它模塊 require 到的肯定是模塊的 module.exports 對象，如果吧 exports 對象賦值給其它對象，就和 module.exports 對象斷開了連接，自然就沒用了

在 Node.js 中使用 ES Module

隨著 ES6 使用越來越廣泛，Node.js 也支持了 ES6 Module，有幾種方法

babel 構建

使用 babel 構建是在 v12 之前版本最簡單、通用的方式，具體配置參考 @babel/preset-env（https://babeljs.io/docs/en/babel-preset-env）

.babelrc

{
  "presets": [
    ["@babel/preset-env", {
      "targets": {
        "node": "8.9.0",
        "esmodules": true
      }      
    }]
  ]
}

原生支持

在 v12 后可以使用原生方式支持 ES Module

• 開啟 --experimental-modules

• 模塊名修改為 .mjs （強烈不推薦使用）或者 package.json 中設置 "type": module

感謝各位的閱讀！關于Node.js 的模塊有哪些就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！