在Node.js中使用原生的ES模块

从版本8.5.0开始，通过一个命令行选项，Node.js就能支持原生的ES模块。这个新功能主要归功于Bradley Farias。

本文将会解释其中的细节。

Demo

demo的版本库结构如下：

esm-demo/
    lib.mjs
    main.mjs

lib.mjs：

export function add(x, y) {
    return x + y;
}

main.mjs：

import {add} from './lib.mjs';

console.log('Result: '+add(2, 3));

运行demo：

$ node --experimental-modules main.mjs
Result: 5

注意事项

ES模块：

• 不支持动态导入模块。但是动态import()运算符已经在开发中，应该不久就能使用了。
• 没有元变量，如__dirname和__filename。然而，Domenic Denicola提出的“import.meta”可以为ES模块提供类似的功能。看起来可能长这样： console.log(import.meta.url);
• 所有模块说明符现在都是URL（这是Node.js的新增特性）：
  • 对等文件（Peer files）——具有文件扩展名的相对路径：'../util/tools.mjs'
  • 库（Library）——没有文件扩展名的裸路径（bare path）：'lodash'
  • 如何使浏览器能够用上 npm 安装的库（不使用bundler）仍有待观察。有一种可能是引入RequireJS风格的配置数据，将裸路径映射到实际路径。目前，在浏览器中还不能用裸路径作为模块说明符。

与CJS模块的互操作性：

• 您可以导入CJS模块，但它们始终只有一个默认的export，也就是module.exports的值。让CJS模块支持命名导出（例如，通过文件开头的pragma）已经被提上日程，但可能需要在等一段时间。如果您能帮忙，那就开始干吧。 import fs1 from 'fs'; console.log(Object.keys(fs1).length); // 86 import * as fs2 from 'fs'; console.log(Object.keys(fs2)); // ['default']
• 您不能在ES模块中使用require()。主要原因是：
  • 路径解析工作略有不同：ESM不支持NODE_PATH和require.extensions。而且，ESM的说明符始终是URL这一事实也会导致一些细微差异。
  • ES模块始终以异步方式加载，这确保了与Web的最大兼容性。这种加载方式无法与通过require()同步加载CJS模块的方式混用。
  • 禁止同步模块加载也使得在ES模块中实现顶级await成为可能（这属于当前正在考虑的功能）。

旧版Node.js上的ES模块

如果要在8.5.0之前的Node.js版本上使用ES模块，请查看John-David Dalton的@std/esm。

提示：如果您不解锁额外的新功能，则能完全兼容Node.js原生的ES模块。

FAQ

ES模块什么时候可以无需命令行选项就能启用？

目前的计划是在Node.js 10 LTS中默认支持ES模块。

小手一抖，资料全有。长按二维码关注京程一灯，阅读更多技术文章和业界动态。