node 处理 esm 模块总结 #

本文介绍特定业务场景下，node处理esm模块.

业务场景：我之前在开发vscode插件中，需要读区用户配置指定路径下的ES模块中的JSON对象，开始使用node当成文件来读区，发现处理起来比较繁琐，还需要兼容处理太多异常场景。如果可以在node段直接读区解析ESM就非常简单了，可以直接处理变量与数据。

node与CommonJS规范 #

我们知道NodeJS是遵循CommonJS规范规范的。它有四个重要的环境变量为模块化的实现提供支持：module、exports、require、global。实际使用时，用module.exports定义当前模块对外输出的接口（不推荐直接用exports），用require加载模块。

// 定义模块util.js
var count = 0;
function add(a, b) {
  return a + b;
}
module.exports = { //在这里写上需要向外暴露的函数、变量
  add: add,
  count: count
}

/** 必须加./路径，不加的话只会去node_modules文件找 **/
// 引用自定义的模块时，参数包含路径，可省略.js
var math = require('./util');
math.add(1, 2);

// 引用核心模块时，不需要带路径
var http = require('http');
http.createService(...).listen(3000);

CommonJS用同步的方式加载模块。在服务端，模块文件都存放在本地磁盘，读取非常快，所以这样做不会有问题。但是在浏览器端，限于网络原因，更合理的方案是使用异步加载。

ESM模块化规范 #

ESM模块化规范也叫ES6模块化规范，在语言标准的层面上，实现了模块功能，而且实现得相当简单，旨在成为浏览器和服务器通用的模块解决方案。其模块功能主要由两个命令构成：export和import。export命令用于规定模块的对外接口，import命令用于输入其他模块提供的功能。

/** 定义模块 math.js **/
var count = 0;
var add = function (a, b) {
    return a + b;
};
export { count, add };

/** 引用模块 **/
import { count, add } from './math';
const testNum = add(99 + count);
console.log('testNum:',testNum);

如上例所示，使用import命令的时候，用户需要知道所要加载的变量名或函数名。其实ES6还提供了export default命令，为模块指定默认输出，对应的import语句不需要使用大括号。

ESM 模块与 CommonJS 模块的差异 #

CommonJS 模块输出的是一个值的拷贝，ES6 模块输出的是值的引用。 #

• CommonJS 模块输出的是值的拷贝，也就是说，一旦输出一个值，模块内部的变化就影响不到这个值。
• ES6 模块的运行机制与 CommonJS 不一样。JS 引擎对脚本静态分析的时候，遇到模块加载命令import，就会生成一个只读引用。等到脚本真正执行时，再根据这个只读引用，到被加载的那个模块里面去取值。换句话说，ES6 的import有点像 Unix 系统的“符号连接”，原始值变了，import加载的值也会跟着变。因此，ES6 模块是动态引用，并且不会缓存值，模块里面的变量绑定其所在的模块。

CommonJS 模块是运行时加载，ES6 模块是编译时输出接口 #

• 运行时加载: CommonJS 模块就是对象；即在输入时是先加载整个模块，生成一个对象，然后再从这个对象上面读取方法，这种加载称为“运行时加载”。
• 编译时加载: ES6 模块不是对象，而是通过 export 命令显式指定输出的代码，import时采用静态命令的形式。即在import时可以指定加载某个输出值，而不是加载整个模块，这种加载称为“编译时加载”。

CommonJS 加载的是一个对象（即module.exports属性），该对象只有在脚本运行完才会生成。而 ES6 模块不是对象，它的对外接口只是一种静态定义，在代码静态解析阶段就会生成。

如何在NodeJs中使用ESM #

使用mjs作为后缀（不推荐） #

// hi.msj
export function sayHi(name) {
    return "Hi, " + name + "!"
}

// main.mjs
import { sayHi } from './hi.mjs'

// 执行shell node runner.mjs

在package.json中配置module(推荐) #

指定type为module，配置好以后就可以直接在项目中使用ESM模块化规范了

使用ESM library #

可以引入npm包esm

// index.js code
require = require("esm")(module);
module.exports = require("./main.js");

下面是我写的Demo

• 新建文件夹 然后npm init -y
• npm i esm -D -s

新建main.js （es模块）

// 测试注释干扰
const testJson = {
  name: '章三', // 注释测试
  age: '18',
  desc: '备注'
}

export default testJson;
// 测试注释干扰

新建index.js (CommonJS)

var require = require("esm")(module);
var data = require("./main.js").default;
console.log('data=====:', data);

执行 node index.js可以看到node成功读区到esm模块信息。

如何在ESM规范下使用CommonJs规范 #

导入createRequire从module模块(自带的)

import {createRequire} from "module";

const require = createRequire(import.meta.url);

//获取PackgeJson文件信息
let pkgManifest = require(path.join(cwd(), 'package.json'));