ES模块和commonJS两种标准下中实现__dirname?一篇文章教你理清楚

CommonJS / ESM 中 __dirname 的实现方式

开头先了解一下console.log(import.meta)的输出结果和node版本 node-v 指令 以便更好了解。

一、CommonJS(默认,package.json 无 "type":"module"

1. 内置全局变量,直接使用

无需导入任何模块,文件内原生存在 __dirname / __filename

js

lua 复制代码
// webpack.config.cjs / index.js(CJS)
const path = require('path');

// 当前文件所在文件夹绝对路径
console.log(__dirname);
// 当前文件完整绝对路径
console.log(__filename);

module.exports = {
  output: {
    path: path.resolve(__dirname, 'dist')
  }
};

特点

  1. 所有 .js 文件默认识别为 CJS
  2. 自带全局 __dirname__filename,零配置
  3. 使用 require()module.exports / exports
  4. 不会出现 URL、fileURLToPath 相关报错

适用场景

webpack 学习、后端 Node 脚本、旧项目,最推荐新手


二、ESM(package.json 添加 "type": "module"

核心特性

  1. 所有 .js 文件都是 ES Module
  2. 无内置 __dirname__filename,必须手动计算
  3. 只能使用 import / export default,不能用 requiremodule.exports

方式 1:兼容全 Node 版本(通用稳定写法,webpack 配置首选)

依赖内置 url + path 模块,import.meta.url 是文件自带 file:// 协议地址

js

javascript 复制代码
// webpack.config.js(ESM)
import path from 'path';
import { fileURLToPath } from 'url';
import { dirname } from 'path';

// 把 file:// 链接转为本地文件绝对路径,这里取__filename1,避免混淆
const __filename1 = fileURLToPath(import.meta.url);
// 从文件路径取出所在目录 = __dirname
const __dirname = dirname(__filename1);

export default {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist')
  }
};
关键禁忌
  • fileURLToPath 只能接收 import.meta.url
  • 不能传入 import.meta.dirname(已经是字符串,会报 URL 协议错误)

方式 2:Node 20.11+ 简化写法(简写,不兼容低版本)

Node20 新增 import.meta.dirname 语法糖,直接等价上面整套代码

js

javascript 复制代码
import path from 'path';

const __dirname = import.meta.dirname;

export default {
  output: {
    path: path.resolve(__dirname, 'dist')
  }
};
缺点

换 Node18/16 环境直接报错,不适合通用项目

三、关键踩坑区分

1. ESM 报错 Cannot use import statement outside a module

package.json 没加 "type":"module",但文件用了 import → 切换 CJS 或开启 type:module

2. ESM 报错 __dirname is not defined

开启 type:module 后,原生全局变量消失,必须手动用 fileURLToPath 生成

3. 报错 ERR_INVALID_URL_SCHEME

错误写法:fileURLToPath(import.meta.dirname)原因:import.meta.dirname 是本地路径字符串,不是 file:// URL,只能传 import.meta.url


四、两种规范对比表

表格

对比项 CommonJS(无 type:module) ESM("type":"module")
__dirname 全局自带,直接用 无,需手动计算
导入导出 require() / module.exports import / export default
路径获取 __dirname fileURLToPath(import.meta.url)
Node 版本兼容 全版本兼容 Node14.13+ 完整支持
webpack 配置推荐度 ⭐⭐⭐⭐⭐ 新手首选 ⭐⭐⭐ 需额外处理路径
浏览器代码能否用 Node 模块 同样不能 同样不能
相关推荐
犹豫的大炮1 小时前
jQuery最核心的基础设施之一——数据缓存模块进化史
前端·缓存·jquery
小碗细面1 小时前
从 PRD 到上线:SpecKit 如何让 AI 真正参与前端交付
前端·ai编程·claude
WL学习笔记1 小时前
链式队列(数据结构)
前端·数据结构·jquery
我是大卫1 小时前
React源码解析-第三部分:协调与提交
前端·react.js·源码
都想学1 小时前
我把 12 个在线工具关掉了,换成了一个 Chrome 扩展
前端·chrome
xiaogai_gai2 小时前
钉钉数据集成到金蝶云星空案例分享:传给钉钉后,回传金蝶字段
java·前端·钉钉
步步为营DotNet2 小时前
借助 Semantic Kernel 与 Blazor 构建智能交互式前端应用
前端
Highcharts2 小时前
从 ECharts 平滑迁移 Highcharts的配置映射与踩坑手册
前端·javascript
梨子同志2 小时前
Node.js
前端