# CommonJS模組 和 ECMAScript模組

最近我在3A平臺購買了伺服器。

> CommonJS模組(下面簡稱 cjs) 是為Node.js打包JavaScript程式碼的原始方法。使用 require 和 exports（module.exports的簡寫） 語句定義模組。 參見 [nodejs cjs](https://link.segmentfault.com/?enc=opdpwpYsy%2Bgeq%2BX66l9Ufw%3D%3D.pK3m9kIgsGSzT%2B0N1b%2FJfAE0CSqJGqaWd6USqfAkx3tUQpCyvE8dq9u2Go8%2FfE9ICjgoG8J1e8KMwOLyp%2F2TTg%3D%3D)
>
> ECMAScript模組(下面簡稱 esm)是ecma262標準下封裝的JavaScript程式碼重用的官方標準格式。使用 import 和export 語句定義模組。參見[node esm](https://link.segmentfault.com/?enc=reIVoFOOIt1kfMYlZaDnrw%3D%3D.yuSJGgLBEi1vBTyVPRvpvZEwpmSr3JPH4nNUH1duMRqLGqPBJsRFGgxARYDS86H8j%2FPNW0QgUJI7bNbzr8jxsQ%3D%3D)

-cjs只有在node.js環境使用。
-esm在node.js和瀏覽器環境都可以使用

### 1、commonjs

在node.js中，每個檔案都被視為一個單獨的模組。模組的區域性變數是私有的，只有exports出去的變數，才能被外界訪問。

預設情況下，node.js會將以下情形視為 cjs模組:

- 副檔名為.cjs的檔案；
- 副檔名為.js的檔案，且離自己最近的package.json檔案包含一個頂級欄位“type”，其值為“commonjs”；
- 副檔名為.js的檔案，且離自己最近的package.json檔案不包含一個頂級欄位“type”(建議明確指定 type值，而不是不定義)；
- 副檔名不為.mjs, .cjs, .json, .node, .js的檔案，且離自己最近的package.json檔案包含一個頂級欄位“type”，其值為“module”，但是這些檔案透過require引入。

呼叫require（）時，始終使用cjs模組載入器，
require採用同步方式載入，可以在程式碼的任意位置使用。
由於require（）的同步特性，無法使用它載入ECMAScript模組檔案。嘗試這樣做將丟擲ERR_REQUIRE_ESM錯誤。請改用import（）。

要獲取呼叫require（）時將載入的確切檔名，請使用require.resolve（）函式。

1)、對於一個檔案，匯出的是物件的引用。如果內部的屬性變化了，外部也會變化。
2)、對於再次引入同一個檔案，如果檔名一模一樣，則從快取裡面取
3)、還有種方式，要使模組多次執行程式碼，請匯出函式並呼叫該函式。

匯出一個原始值

```javascript
//child.js
var counter = 3;
function incCounter() {
  counter++;
}
module.exports = {
  counter: counter,
  incCounter: incCounter,
};

//parent.js
let child = require('./child.js')
console.log(child.counter);  // 3
child.incCounter();
console.log(child.counter); // 3沒變
```

匯出一個物件

```javascript
//child.js
var obj = {
    counter:3
};
function incCounter() {
    obj.counter++;
}
module.exports = {
  obj: obj,
  incCounter: incCounter,
};
//parent.js
let child = require('./child.js')
console.log(child.obj.counter);  // 3
test.incCounter();
console.log(child.obj.counter); // 4 變了
```

匯出一個物件，多個檔案，會從快取裡獲取

```javascript
//child.js
var obj = {
    counter:3
};
function incCounter() {
    obj.counter++;
}
module.exports = {
  obj: obj,
  incCounter: incCounter,
};
//parent.js
let child = require('./child.js')
let child1 = require('./child.js')
console.log(child.obj.counter);  // 3
test.incCounter();
console.log(child.obj.counter); // 4 變了
console.log(child1.obj.counter); // 4 變了
```

如果require載入的是個資料夾，那麼node.js預設會嘗試載入 index.js 或者 index.node

#### 動態匯入

import() 既支援cjs，又支援 esm

```coffeescript
import('./lib.js').then((res)=>{
    //res.default  
}) 
```

### 2、es module

呼叫 import（）時，始終使用esm模組載入器，

預設情況下，node.js會將以下情形視為 esm 模組:
副檔名為 .mjs 的檔案；
副檔名為.js的檔案，且離自己最近的package.json檔案包含一個頂級欄位“type”，其值為“module”；

1)、對於一個檔案，匯出的是物件的引用。如果內部的屬性變化了，外部也會變化。
2)、對於再次引入同一個檔案，如果檔名一模一樣，則從快取裡面取。如果檔名加了query，則重新載入檔案，不會快取裡取
3)、還有種方式，要使模組多次執行程式碼，請匯出函式並呼叫該函式。

單次匯入，匯入基本型別

```javascript
//child.mjs
var counter = 3;
function incCounter() {
  counter++;
}
export default {
  counter: counter,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs";
console.log(child.counter); // 3
child.incCounter();
console.log(child.counter); // 3沒變
```

多次匯入，匯入引用型別

```javascript
//child.mjs
var obj = {
  counter: 3,
};
function incCounter() {
  obj.counter++;
}
export default {
  obj: obj,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs";
import child1 from "./lib.mjs";  //從快取裡面取
console.log(child.obj.counter); // 3
child.incCounter();
console.log(child.obj.counter); // 4變了

console.log(child1.obj.counter); // 4變了，拿的快取裡的
```

多次匯入，避免快取

```javascript
//child.mjs
var obj = {
  counter: 3,
};
function incCounter() {
  obj.counter++;
}
export default {
  obj: obj,
  incCounter: incCounter,
};

//index.mjs
import child from "./lib.mjs?time=1";
import child1 from "./lib.mjs?time=2";  //增加query避免快取
console.log(child.obj.counter); // 3
child.incCounter();
console.log(child.obj.counter); // 4變了
console.log(child1.obj.counter); // 3沒變，重新載入的檔案
```

#### import.meta.url

當前檔案檔案模組的 url地址。

```javascript
import { readFileSync } from 'node:fs';
const buffer = readFileSync(new URL('./data.proto', import.meta.url));
```

import.meta.resolve 實驗功能

```dart
await import.meta.resolve('./dep', import.meta.url);
const dependencyAsset = await import.meta.resolve('component-lib/asset.css');
```

#### 在esm中使用 require

```javascript
import { createRequire } from 'node:module';  
const require = createRequire(import.meta.url);

// sibling-module.js is a CommonJS module.
const siblingModule = require('./sibling-module');
```

注意： 從node.js v16以後，使用node內建核心模組都採用node:xx， 比如 node:fs，它和fs的區別是，不能被require快取，而fs能被快取，可以檢視 [v16 changeLog-issue](https://link.segmentfault.com/?enc=paGkh1Qpgq5JWbbPwu8GKQ%3D%3D.TYtssgpe46eXaRtjgNaUnJ34x%2FQSphWzC4D0pz7YyZn56kP5jgITXsnAV1GNlGV6)

```javascript
const path = require('node:path');  //不被快取
const path = require('path');    //可以被快取
```

### 3、esm模組與cjs模組之間的差異

- esm使用import/export， 而cjs使用require/exports
- cjs可以使用 __filename 或者 __dirname，process, 而esm不行，esm只能使用 import.meta.url
- esm不支援本機模組。 但是可以改為透過 module.createRequire() or process.dlopen.載入
- cjs使用 require.resolve， 而esm使用new URL(), import.meta.resolve
- cjs可以透過環境變數指定的路徑，去查詢本機上對應位置的模組，而esm不行，
- cjs 是在執行時確定，而esm則在靜態編譯時確定。
- cjs可以同步執行，esm不行

共同點：模組匯出的都是引用。

注意：在esm中使用process，可以匯入
`import process from 'node:process';`

CommonJS模組和 ECMAScript模組

相關文章

CommonJS模組 和 ECMAScript模組

相關文章

CommonJS模組和 ECMAScript模組