Node-CJS和ESM混合开发

Node — CJS和ESM混合开发

在JavaScript中，有两种主要的模块系统：CommonJS和ES Modules（ESM）。
CJS通过require引入，module.exports导出
ESM通过import引入，export导出

判断JS使用CJS还是ESM

• .cjs后缀的文件是使用CommonJS规范
• .mjs后缀的文件是使用ES Modules规范。
• .js后缀则以package.json中的type字段为准。

package.json 中的 type 字段用来指定包的类型，默认为commonjs

• “commonjs”: 表示该包是一个 CommonJS 模块（即 Node.js 默认的模块格式）。
• “module”: 表示该包是一个 ES 模块（即标准的 ECMAScript 模块格式）。
• “json”: 表示该包仅包含 JSON 数据，可以通过 require() 函数或 ES6 的 import 语句来导入。

为什么需要混合开发？

很简单，比如当前js中需要引入多个库，A库的语法是CJS，B库的语法是ESM，因此需要实现混合开发。

CJS兼容ESM

(async function() {
  const esm = await import('esm');
  esm.a();
  esm.b();
})();

ESM兼容CJS（推荐）

ESM可以直接importCJS模块，越来越多的库使用ESM，建议新项目优先使用ESM规范。

import { a, b } from 'cjs';
a();
b():

dirname-filename-esm库

ESM中没有注入__dirname、__filename全局变量，可以通过dirname-filename-esm库获取

• __dirname：当前文件所在目录的绝对路径，不包括当前文件名

import { dirname } from 'dirname-filename-esm'

// 拿到当前文件所在目录的绝对路径
const __dirname = dirname(import.meta)
console.log(__dirname)

• __filename：当前文件的绝对路径

import { filename } from 'dirname-filename-esm'
// 获取文件绝对路径
const __filename = filename(import.meta)

// 手动实现
// import { fileURLToPath } from 'node:url'
// const __filename = fileURLToPath(import.meta.url)