Node.js 加载

概述

Node.js 对 ES6 模块的处理比较麻烦,因为它有自己的 CommonJS 模块格式,与 ES6 模块格式是不兼容的。目前的解决方案是,将两者分开,ES6 模块和 CommonJS 采用各自的加载方案。从 v13.2 版本开始,Node.js 已经默认打开了 ES6 模块支持。

Node.js 要求 ES6 模块采用.mjs后缀文件名。也就是说,只要脚本文件里面使用import或者export命令,那么就必须采用.mjs后缀名。Node.js 遇到.mjs文件,就认为它是 ES6 模块,默认启用严格模式,不必在每个模块文件顶部指定"use strict"

如果不希望将后缀名改成.mjs,可以在项目的package.json文件中,指定type字段为module

  1. {
  2. "type": "module"
  3. }

一旦设置了以后,该目录里面的 JS 脚本,就被解释用 ES6 模块。

  1. # 解释成 ES6 模块
  2. $ 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

main 字段

package.json文件有两个字段可以指定模块的入口文件:mainexports。比较简单的模块,可以只使用main字段,指定模块加载的入口文件。

  1. // ./node_modules/es-module-package/package.json
  2. {
  3. "type": "module",
  4. "main": "./src/index.js"
  5. }

上面代码指定项目的入口脚本为./src/index.js,它的格式为 ES6 模块。如果没有type字段,index.js就会被解释为 CommonJS 模块。

然后,import命令就可以加载这个模块。

  1. // ./my-app.mjs
  2. import { something } from 'es-module-package';
  3. // 实际加载的是 ./node_modules/es-module-package/src/index.js

上面代码中,运行该脚本以后,Node.js 就会到./node_modules目录下面,寻找es-module-package模块,然后根据该模块package.jsonmain字段去执行入口文件。

这时,如果用 CommonJS 模块的require()命令去加载es-module-package模块会报错,因为 CommonJS 模块不能处理export命令。

exports 字段

exports字段的优先级高于main字段。它有多种用法。

(1)子目录别名

package.json文件的exports字段可以指定脚本或子目录的别名。

  1. // ./node_modules/es-module-package/package.json
  2. {
  3. "exports": {
  4. "./submodule": "./src/submodule.js"
  5. }
  6. }

上面的代码指定src/submodule.js别名为submodule,然后就可以从别名加载这个文件。

  1. import submodule from 'es-module-package/submodule';
  2. // 加载 ./node_modules/es-module-package/src/submodule.js

下面是子目录别名的例子。

  1. // ./node_modules/es-module-package/package.json
  2. {
  3. "exports": {
  4. "./features/": "./src/features/"
  5. }
  6. }
  7. import feature from 'es-module-package/features/x.js';
  8. // 加载 ./node_modules/es-module-package/src/features/x.js

如果没有指定别名,就不能用“模块+脚本名”这种形式加载脚本。

  1. // 报错
  2. import submodule from 'es-module-package/private-module.js';
  3. // 不报错
  4. import submodule from './node_modules/es-module-package/private-module.js';

(2)main 的别名

exports字段的别名如果是.,就代表模块的主入口,优先级高于main字段,并且可以直接简写成exports字段的值。

  1. {
  2. "exports": {
  3. ".": "./main.js"
  4. }
  5. }
  6. // 等同于
  7. {
  8. "exports": "./main.js"
  9. }

由于exports字段只有支持 ES6 的 Node.js 才认识,所以可以用来兼容旧版本的 Node.js。

  1. {
  2. "main": "./main-legacy.cjs",
  3. "exports": {
  4. ".": "./main-modern.cjs"
  5. }
  6. }

上面代码中,老版本的 Node.js (不支持 ES6 模块)的入口文件是main-legacy.cjs,新版本的 Node.js 的入口文件是main-modern.cjs

(3)条件加载

利用.这个别名,可以为 ES6 模块和 CommonJS 指定不同的入口。目前,这个功能需要在 Node.js 运行的时候,打开--experimental-conditional-exports标志。

  1. {
  2. "type": "module",
  3. "exports": {
  4. ".": {
  5. "require": "./main.cjs",
  6. "default": "./main.js"
  7. }
  8. }
  9. }

上面代码中,别名.require条件指定require()命令的入口文件(即 CommonJS 的入口),default条件指定其他情况的入口(即 ES6 的入口)。

上面的写法可以简写如下。

  1. {
  2. "exports": {
  3. "require": "./main.cjs",
  4. "default": "./main.js"
  5. }
  6. }

注意,如果同时还有其他别名,就不能采用简写,否则或报错。

  1. {
  2. // 报错
  3. "exports": {
  4. "./feature": "./lib/feature.js",
  5. "require": "./main.cjs",
  6. "default": "./main.js"
  7. }
  8. }

ES6 模块加载 CommonJS 模块

目前,一个模块同时支持 ES6 和 CommonJS 两种格式的常见方法是,package.json文件的main字段指定 CommonJS 入口,给 Node.js 使用;module字段指定 ES6 模块入口,给打包工具使用,因为 Node.js 不认识module字段。

有了上一节的条件加载以后,Node.js 本身就可以同时处理两种模块。

  1. // ./node_modules/pkg/package.json
  2. {
  3. "type": "module",
  4. "main": "./index.cjs",
  5. "exports": {
  6. "require": "./index.cjs",
  7. "default": "./wrapper.mjs"
  8. }
  9. }

上面代码指定了 CommonJS 入口文件index.cjs,下面是这个文件的代码。

  1. // ./node_modules/pkg/index.cjs
  2. exports.name = 'value';

然后,ES6 模块可以加载这个文件。

  1. // ./node_modules/pkg/wrapper.mjs
  2. import cjsModule from './index.cjs';
  3. export const name = cjsModule.name;

注意,import命令加载 CommonJS 模块,只能整体加载,不能只加载单一的输出项。

  1. // 正确
  2. import packageMain from 'commonjs-package';
  3. // 报错
  4. import { method } from 'commonjs-package';

还有一种变通的加载方法,就是使用 Node.js 内置的module.createRequire()方法。

  1. // cjs.cjs
  2. module.exports = 'cjs';
  3. // esm.mjs
  4. import { createRequire } from 'module';
  5. const require = createRequire(import.meta.url);
  6. const cjs = require('./cjs.cjs');
  7. cjs === 'cjs'; // true

上面代码中,ES6 模块通过module.createRequire()方法可以加载 CommonJS 模块

CommonJS 模块加载 ES6 模块

CommonJS 的require命令不能加载 ES6 模块,会报错,只能使用import()这个方法加载。

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

上面代码可以在 CommonJS 模块中运行。

Node.js 的内置模块

Node.js 的内置模块可以整体加载,也可以加载指定的输出项。

  1. // 整体加载
  2. import EventEmitter from 'events';
  3. const e = new EventEmitter();
  4. // 加载指定的输出项
  5. import { readFile } from 'fs';
  6. readFile('./foo.txt', (err, source) => {
  7. if (err) {
  8. console.error(err);
  9. } else {
  10. console.log(source);
  11. }
  12. });

加载路径

ES6 模块的加载路径必须给出脚本的完整路径,不能省略脚本的后缀名。import命令和package.json文件的main字段如果省略脚本的后缀名,会报错。

  1. // ES6 模块中将报错
  2. import { something } from './index';

为了与浏览器的import加载规则相同,Node.js 的.mjs文件支持 URL 路径。

  1. import './foo.mjs?query=1'; // 加载 ./foo 传入参数 ?query=1

上面代码中,脚本路径带有参数?query=1,Node 会按 URL 规则解读。同一个脚本只要参数不同,就会被加载多次,并且保存成不同的缓存。由于这个原因,只要文件名中含有:%#?等特殊字符,最好对这些字符进行转义。

目前,Node.js 的import命令只支持加载本地模块(file:协议)和data:协议,不支持加载远程模块。另外,脚本路径只支持相对路径,不支持绝对路径(即以///开头的路径)。

最后,Node 的import命令是异步加载,这一点与浏览器的处理方法相同。

内部变量

ES6 模块应该是通用的,同一个模块不用修改,就可以用在浏览器环境和服务器环境。为了达到这个目标,Node 规定 ES6 模块之中不能使用 CommonJS 模块的特有的一些内部变量。

首先,就是this关键字。ES6 模块之中,顶层的this指向undefined;CommonJS 模块的顶层this指向当前模块,这是两者的一个重大差异。

其次,以下这些顶层变量在 ES6 模块之中都是不存在的。

  • arguments
  • require
  • module
  • exports
  • __filename
  • __dirname