#构建性能分析

进行构建性能分析可以帮助你确定项目中的性能瓶颈，从而采取针对性的优化。

#使用 Rsdoctor

Rsdoctor 是一个构建分析工具，能够可视化地展示各个 loaders 和 plugins 的编译耗时。

请参考 使用 Rsdoctor 了解更多。

#Node.js profiling

当 Rsbuild 执行一次构建时，会包含 JavaScript 和 Rust 两侧的代码运行开销，以及 JavaScript 和 Rust 之间的数据通信开销。

通常而言，JavaScript 侧的性能开销会大于 Rust 侧，你可以使用 Node.js 的 profiling 来分析 JS 侧的开销，这有助于发现 JS 侧的性能瓶颈。

例如，进行 CPU profiling 分析，在项目根目录执行以下命令：

# dev
node --cpu-prof ./node_modules/@rsbuild/core/bin/rsbuild.js dev

# build
node --cpu-prof ./node_modules/@rsbuild/core/bin/rsbuild.js build

以上命令执行后会生成一个 *.cpuprofile 文件，我们可以使用 speedscope 来可视化查看该文件：

# 安装 speedscope
npm install -g speedscope

# 查看 cpuprofile 内容
# 请将文件名替换为本地文件的名称
speedscope CPU.date.000000.00000.0.001.cpuprofile

#Rspack profiling

Rsbuild 支持使用 RSPACK_PROFILE 环境变量来对 Rspack 进行构建性能分析。

{
  "scripts": {
    "dev:profile": "RSPACK_PROFILE=ALL rsbuild dev",
    "build:profile": "RSPACK_PROFILE=ALL rsbuild build"
  }
}

由于 Windows 不支持上述用法，你也可以使用 cross-env 来设置环境变量，这可以确保在不同的操作系统中都能正常使用：

{
  "scripts": {
    "dev:profile": "cross-env RSPACK_PROFILE=ALL rsbuild dev",
    "build:profile": "cross-env RSPACK_PROFILE=ALL rsbuild build"
  },
  "devDependencies": {
    "cross-env": "^7.0.0"
  }
}

当 build 命令执行完成，或是 dev server 被关闭时，Rsbuild 会在产物目录下生成一个 rspack-profile-${timestamp} 文件夹，该文件夹下会包含 logging.json、trace.json 和 jscpuprofile.json 三个文件：

• trace.json：使用 tracing 细粒度地记录了 Rust 侧各个阶段的耗时，可以使用 ui.perfetto.dev 进行查看。
• jscpuprofile.json：使用 Node.js inspector 细粒度地记录了 JavaScript 侧的各个阶段的耗时，可以使用 speedscope.app 进行查看。
• logging.json：包含一些日志信息，粗粒度地记录了构建的各个阶段耗时（开发模式下暂不支持）。