Node.js 如何处理 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;

五、同时支持两种格式的模块

一个模块同时要支持 CommonJS 和 ES6 两种格式，也很容易。

如果原始模块是 ES6 格式，那么需要给出一个整体输出接口，比如 export default obj ，使得 CommonJS 可以用 import() 进行加载。

如果原始模块是 CommonJS 格式，那么可以加一个包装层。

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

上面代码先整体输入 CommonJS 模块，然后再根据需要输出具名接口。

你可以把这个文件的后缀名改为 .mjs ，或者将它放在一个子目录，再在这个子目录里面放一个单独的 package.json 文件，指明 { type: "module" } 。

另一种做法是在 package.json 文件的 exports 字段，指明两种格式模块各自的加载入口。

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

上面代码指定 require() 和 import ，加载该模块会自动切换到不一样的入口文件。

写的很好，浅显易懂：

总结为一句话：.mjs文件总是以 ES6 模块加载，.cjs文件总是以 CommonJS 模块加载，.js文件的加载取决于package.json里面type字段的设置。

注意，ES6 模块与 CommonJS 模块尽量不要混用。require命令不能加载.mjs文件，会报错，只有import命令才可以加载.mjs文件。反过来，.mjs文件里面也不能使用require命令，必须使用import。

我个人通过收集整理，整理出以下几种在Node旧版或者新版中使用ESM的方式，不知是否有误，请老师及各位帮忙过目一下。

1.使用babel，npm i @babel/core @babel/register @babel/preset-env -D，并增加新的入口文件，代码内容如下：
注：该方法会影响应用启动速度，因为在启动时babel需要编译

require(‘@babel/register’) ({
Presets: [‘@babel/preset-env’]

module.exports = require(‘./index.js’)

2.旧版Node，使用Node的试验特性，在启动时使用命令node --experimental-modules，并配合如下的其中一种模式与之配合开启：
注：使用该试验特性后，所有的import都要写完整文件的名称，不能省略文件拓展名

1.ES6的模块文件拓展名改为mjs

2.修改package.json的type属性为如下值（每个目录都支持以放置package.json文件并通过type字段告诉node该以哪种方式处理模块）：
注：该模式虽然方便，但是可能会影响老项目的兼容性
Module
Commonjs

3.正式支持esm的Node版本，可以通过以下几种方式开启：
1.ES6的模块文件拓展名改为mjs

2.Package.json的type属性修改为module（每个目录都支持以放置package.json文件的形式，单独开启该目录的处理）

3.在启动时使用命令node --input-type=module