Node.js 如何處理 ES6 模組

阮一峰發表於2020-08-20
Node.js

學習 JavaScript 語言，你會發現它有兩種格式的模組。

一種是 ES6 模組，簡稱 ESM；另一種是 Node.js 專用的 CommonJS 模組，簡稱 CJS。這兩種模組不相容。

很多人使用 Node.js，只會用require()載入模組，遇到 ES6 模組就不知道該怎麼辦。本文就來談談，ES6 模組在 Node.js 裡面怎麼使用。

一、兩種模組的差異

ES6 模組和 CommonJS 模組有很大的差異。

語法上面，CommonJS 模組使用require()載入和module.exports輸出，ES6 模組使用import和export。

用法上面，require()是同步載入，後面的程式碼必須等待這個命令執行完，才會執行。import命令則是非同步載入，或者更準確地說，ES6 模組有一個獨立的靜態解析階段，依賴關係的分析是在那個階段完成的，最底層的模組第一個執行。

二、Node.js 的區分

Node.js 要求 ES6 模組採用.mjs字尾檔名。也就是說，只要指令碼檔案裡面使用import或者export命令，那麼就必須採用.mjs字尾名。Node.js 遇到.mjs檔案，就認為它是 ES6 模組，預設啟用嚴格模式，不必在每個模組檔案頂部指定"use strict"。

如果不希望將字尾名改成.mjs，可以在專案的package.json檔案中，指定type欄位為module。


{
   "type": "module"
}

一旦設定了以後，該目錄裡面的 JS 指令碼，就被解釋用 ES6 模組。


# 解釋成 ES6 模組
$ node my-app.js

如果這時還要使用 CommonJS 模組，那麼需要將 CommonJS 指令碼的字尾名都改成.cjs。如果沒有type欄位，或者type欄位為commonjs，則.js指令碼會被解釋成 CommonJS 模組。

總結為一句話：.mjs檔案總是以 ES6 模組載入，.cjs檔案總是以 CommonJS 模組載入，.js檔案的載入取決於package.json裡面type欄位的設定。

注意，ES6 模組與 CommonJS 模組儘量不要混用。require命令不能載入.mjs檔案，會報錯，只有import命令才可以載入.mjs檔案。反過來，.mjs檔案裡面也不能使用require命令，必須使用import。

三、CommonJS 模組載入 ES6 模組

CommonJS 的require()命令不能載入 ES6 模組，會報錯，只能使用import()這個方法載入。


(async () => {
  await import('./my-app.mjs');
})();

上面程式碼可以在 CommonJS 模組中執行。

require()不支援 ES6 模組的一個原因是，它是同步載入，而 ES6 模組內部可以使用頂層await命令，導致無法被同步載入。

四、ES6 模組載入 CommonJS 模組

ES6 模組的import命令可以載入 CommonJS 模組，但是隻能整體載入，不能只載入單一的輸出項。


// 正確
import packageMain from 'commonjs-package';

// 報錯
import { method } from 'commonjs-package';

這是因為 ES6 模組需要支援靜態程式碼分析，而 CommonJS 模組的輸出介面是module.exports，是一個物件，無法被靜態分析，所以只能整體載入。

載入單一的輸出項，可以寫成下面這樣。


import packageMain from 'commonjs-package';
const { method } = packageMain;:w

五、同時支援兩種格式的模組

一個模組同時要支援 CommonJS 和 ES6 兩種格式，也很容易。

如果原始模組是 ES6 格式，那麼需要給出一個整體輸出介面，比如export default obj，使得 CommonJS 可以用import()進行載入。

如果原始模組是 CommonJS 格式，那麼可以加一個包裝層。


import cjsModule from '../index.js';
export const foo = cjsModule.foo;

上面程式碼先整體輸入 CommonJS 模組，然後再根據需要輸出具名介面。

你可以把這個檔案的字尾名改為.mjs，或者將它放在一個子目錄，再在這個子目錄裡面放一個單獨的package.json檔案，指明{ module: "type" }。

另一種做法是在package.json檔案的exports欄位，指明兩種格式模組各自的載入入口。


"exports"：{ 
    "require": "./index.js"，
    "import": "./esm/wrapper.js" 
}

上面程式碼指定require()和import，載入該模組會自動切換到不一樣的入口檔案。

（完）

相關文章