babel 宏通过 import .macro 文件在编译期执行同步计算并替换 ast,无需配置、开箱即用;宏是导出 default 函数的独立模块,可读取本地文件、生成字面量,适用于环境变量注入、资源路径预解析等场景。

直接在代码里写死计算结果,不如让 Babel 在编译时帮你算好——Babel 宏(babel-plugin-macros)就是干这个的:不改配置、不 eject、不写插件,只靠 import 一个 .macro 文件,就能把运行时计算提前到编译期展开。
为什么用宏而不是插件?
插件需要全局配置(比如往 babel.config.js 里加 plugins: ["preval"]),而 create-react-app 等零配置环境默认禁用自定义插件。宏则不同:
- create-react-app 已内置
babel-plugin-macros,开箱即用 - 宏文件以
.macro或.macro.js结尾,Babel 自动识别并执行 - 导入即生效,语义清晰:
import preval from 'preval.macro',一眼知道这是编译期行为 - 每个 macro 是独立模块,无副作用,不污染全局配置
怎么写出一个可运行的宏?
宏本质是一个导出 default 函数的模块,接收 Babel 的 api 和 opts,返回一个标准 Babel 插件对象(含 visitor)。关键点是:它运行在编译时,能读取本地文件、执行 Node.js 代码,并用结果替换 AST 节点。
- 文件名必须为
xxx.macro.js(如dotenv.macro.js) - 导出函数接收
{ types: t, template }等 Babel 工具,用于构建新 AST - 通过
path.replaceWith()把原始调用节点替换成字面量(如字符串、数字) - 可同步读取
.env、package.json或运行简单表达式,但不能依赖运行时变量或异步操作
典型场景与写法示例
常见用途不是炫技,而是解决真实痛点:
-
环境变量注入:从
.env提取指定 key,编译成字符串字面量,避免前端暴露全部配置 -
静态资源路径预解析:
import img from 'url.macro?./logo.png'→ 编译后直接是"data:image/png;base64,..."或相对路径 - 类型/Schema 预处理:读取 JSON Schema 文件,生成 TypeScript 接口或运行时校验函数
-
数学/逻辑预计算:如
import calc from 'calc.macro'; const PI2 = calc`Math.PI * 2`→ 编译后变成const PI2 = 6.141592653589793
注意事项和限制
宏很轻量,但不是万能的:
- 只能访问编译时存在的文件(如项目根目录下的
.env),不能读取用户上传或 API 返回的数据 - 不支持异步操作(
await、fetch),所有逻辑必须同步完成 - 错误会中断编译,建议加 try/catch 并抛出带位置信息的错误(用
@babel/code-frame格式化) - 不要在宏里做耗时操作(如遍历千个文件),否则拖慢构建速度
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











