Skip toc为什么这么快用 Go 而不是 JavaScript从零开始写,没有历史包袱尽量少做 AST 遍历内存布局优化安装与基本使用JavaScript API同步构建异步构建监听模式开发服务器常用配置项详解entryPoints - 入口文件loader - 文件类型处理define - 全局常量替换external - 排除依赖alias - 路径别名target - 目标环境代码分割插件开发基本结构实战:处理 YAML 文件实战:环境变量注入实战:Vue SFC 简易处理与 TypeScript 配合tsconfig.json 支持类型检查装饰器与 React 配合JSX 配置完整的 React 项目配置性能优化技巧减少入口点排除大型依赖使用增量构建并行处理多个构建当前限制不支持的特性插件生态生产环境使用与其他工具对比常见问题1. 构建后引入路径错误2. 第三方库报错3. 动态 import 不工作4. Node.js 内置模块报错参考资料Table of Contents为什么这么快用 Go 而不是 JavaScript从零开始写,没有历史包袱尽量少做 AST 遍历内存布局优化安装与基本使用JavaScript API同步构建异步构建监听模式开发服务器常用配置项详解entryPoints - 入口文件loader - 文件类型处理define - 全局常量替换external - 排除依赖alias - 路径别名target - 目标环境代码分割插件开发基本结构实战:处理 YAML 文件实战:环境变量注入实战:Vue SFC 简易处理与 TypeScript 配合tsconfig.json 支持类型检查装饰器与 React 配合JSX 配置完整的 React 项目配置性能优化技巧减少入口点排除大型依赖使用增量构建并行处理多个构建当前限制不支持的特性插件生态生产环境使用与其他工具对比常见问题1. 构建后引入路径错误2. 第三方库报错3. 动态 import 不工作4. Node.js 内置模块报错参考资料esbuild 是 Evan Wallace(Figma 的联合创始人)用 Go 语言写的 JavaScript/TypeScript 打包器。它的速度快到什么程度?官方给的数据是比 Webpack 快 10-100 倍。
这个数字不是吹的。在一个中等规模的项目里,Webpack 需要 30 秒完成的构建,esbuild 可能 300 毫秒就搞定了。Vite 的开发服务器之所以启动飞快,底层就是用 esbuild 做依赖预构建。
为什么这么快#
esbuild 快的原因不是什么黑魔法,而是做对了几件事:
用 Go 而不是 JavaScript#
JavaScript 是单线程的,虽然有 Worker,但进程间通信开销大。Go 天生支持并发,可以充分利用多核 CPU。esbuild 的解析、转换、代码生成都是并行执行的。
从零开始写,没有历史包袱#
Webpack 的架构是十年前设计的,为了兼容各种场景,代码路径非常复杂。esbuild 没有这些负担,可以针对现代 JavaScript 生态做极致优化。
尽量少做 AST 遍历#
传统打包器的流程是:解析代码生成 AST → 各种插件遍历 AST 做转换 → 生成代码。每个插件都要遍历一遍,效率很低。
esbuild 把常用的转换(TypeScript、JSX、压缩等)全部内置,一次遍历搞定所有事情。
内存布局优化#
esbuild 对内存的使用非常克制,数据结构紧凑,GC 压力小。这在处理大型项目时效果明显。
安装与基本使用#
Terminal window# 安装npm install esbuild --save-dev
# 或者全局安装npm install -g esbuild
最简单的用法,打包一个文件:
Terminal window# 打包 app.js,输出到 out.jsesbuild app.js --bundle --outfile=out.js
常用的命令行参数:
Terminal window# 开启压缩esbuild app.js --bundle --minify --outfile=out.js
# 生成 source mapesbuild app.js --bundle --sourcemap --outfile=out.js
# 指定目标环境esbuild app.js --bundle --target=es2020 --outfile=out.js
# 指定输出格式(esm/cjs/iife)esbuild app.js --bundle --format=esm --outfile=out.js
# 处理 JSXesbuild app.jsx --bundle --loader:.jsx=jsx --outfile=out.js
JavaScript API#
命令行适合简单场景,复杂项目还是用 API 更灵活。
同步构建#
build.jsconst esbuild = require('esbuild')
const result = esbuild.buildSync({ entryPoints: ['src/index.js'], bundle: true, minify: true, sourcemap: true, target: ['es2020'], outfile: 'dist/bundle.js',})
console.log('构建完成')
异步构建#
build.jsconst esbuild = require('esbuild')
async function build() { const result = await esbuild.build({ entryPoints: ['src/index.js'], bundle: true, minify: true, sourcemap: true, outdir: 'dist', splitting: true, // 代码分割,需要 format: 'esm' format: 'esm', })
console.log('构建完成', result)}
build()
监听模式#
watch.jsconst esbuild = require('esbuild')
async function watch() { const ctx = await esbuild.context({ entryPoints: ['src/index.js'], bundle: true, outdir: 'dist', })
// 开启监听 await ctx.watch() console.log('监听文件变化中...')
// 需要停止时调用 // await ctx.dispose()}
watch()
开发服务器#
esbuild 内置了一个简单的开发服务器:
serve.jsconst esbuild = require('esbuild')
async function serve() { const ctx = await esbuild.context({ entryPoints: ['src/index.js'], bundle: true, outdir: 'public', })
const { host, port } = await ctx.serve({ servedir: 'public', port: 3000, })
console.log(`服务器运行在 http://${host}:${port}`)}
serve()
这个服务器比较简陋,没有 HMR,只有 Live Reload。生产项目建议用 Vite。
常用配置项详解#
entryPoints - 入口文件#
// 单入口entryPoints: ['src/index.js']
// 多入口entryPoints: ['src/index.js', 'src/admin.js']
// 指定输出名称entryPoints: { main: 'src/index.js', admin: 'src/admin.js',}
loader - 文件类型处理#
esbuild 通过 loader 来处理不同类型的文件:
{ loader: { '.js': 'jsx', // 把 .js 文件当作 JSX 处理 '.png': 'file', // 图片输出为文件 '.svg': 'text', // SVG 作为文本导入 '.json': 'json', // JSON 文件 '.css': 'css', // CSS 文件 }}
内置的 loader 类型:
Loader说明jsJavaScriptjsxJSXtsTypeScripttsxTypeScript + JSXjsonJSON 文件cssCSS 文件text作为字符串导入file输出为文件,返回 URLdataurl转为 Data URLbinary作为 Uint8Array 导入base64作为 Base64 字符串导入copy复制文件,不做处理
define - 全局常量替换#
{ define: { 'process.env.NODE_ENV': '"production"', '__DEV__': 'false', 'API_URL': '"https://api.example.com"', }}
注意值需要是 JavaScript 表达式的字符串形式,所以字符串要用引号包裹。
external - 排除依赖#
{ external: [ 'react', 'react-dom', // 排除所有 node_modules './node_modules/*', ]}
被排除的依赖不会被打包,而是保留 import/require 语句。
alias - 路径别名#
{ alias: { '@': './src', '@components': './src/components', '@utils': './src/utils', }}
target - 目标环境#
// 指定 ES 版本target: ['es2020']
// 指定浏览器版本target: ['chrome80', 'firefox78', 'safari14']
// 指定 Node 版本target: ['node16']
esbuild 会根据目标环境自动转换语法,比如把箭头函数转成普通函数。
代码分割#
{ entryPoints: ['src/index.js', 'src/admin.js'], bundle: true, splitting: true, // 开启代码分割 format: 'esm', // 必须是 esm 格式 outdir: 'dist', // 必须用 outdir,不能用 outfile chunkNames: 'chunks/[name]-[hash]', // 分割出的 chunk 命名规则}
插件开发#
esbuild 的插件 API 相对简单,主要是两个钩子:onResolve 和 onLoad。
基本结构#
const myPlugin = { name: 'my-plugin', setup(build) { // 解析模块路径时触发 build.onResolve({ filter: /.*/ }, (args) => { console.log('解析:', args.path) return null // 返回 null 表示不处理 })
// 加载模块内容时触发 build.onLoad({ filter: /.*/ }, (args) => { console.log('加载:', args.path) return null }) },}
// 使用插件esbuild.build({ entryPoints: ['src/index.js'], bundle: true, plugins: [myPlugin], outfile: 'dist/bundle.js',})
实战:处理 YAML 文件#
const yaml = require('js-yaml')const fs = require('fs')
const yamlPlugin = { name: 'yaml', setup(build) { build.onLoad({ filter: /\.ya?ml$/ }, async (args) => { const content = await fs.promises.readFile(args.path, 'utf8') const data = yaml.load(content)
return { contents: `export default ${JSON.stringify(data)}`, loader: 'js', } }) },}
实战:环境变量注入#
const envPlugin = { name: 'env', setup(build) { build.onResolve({ filter: /^env$/ }, (args) => ({ path: args.path, namespace: 'env-ns', }))
build.onLoad({ filter: /.*/, namespace: 'env-ns' }, () => ({ contents: JSON.stringify(process.env), loader: 'json', })) },}
// 使用// import env from 'env'// console.log(env.NODE_ENV)
实战:Vue SFC 简易处理#
const vuePlugin = { name: 'vue', setup(build) { build.onLoad({ filter: /\.vue$/ }, async (args) => { const source = await fs.promises.readFile(args.path, 'utf8')
// 简单解析,实际需要用 @vue/compiler-sfc const templateMatch = source.match(/([\s\S]*)<\/template>/) const scriptMatch = source.match(/