Skip to content

内联公共 chunk ​

内联公共 chunk 可以减少自动代码分割生成的小型公共 chunk 数量。Rolldown 会将这些 chunk 中的代码复制到使用它们的 chunk 中,并移除独立的公共 chunk 文件。共享运行时会让这些副本使用相同的模块状态和导出。

用法 ​

rolldown.config.mjs
js
import { defineConfig } from 'rolldown';

export default defineConfig({
  input: ['src/a.js', 'src/b.js', 'src/c.js'],
  preserveEntrySignatures: false,
  output: {
    dir: 'dist',
    format: 'es',
    codeSplitting: {
      experimentalInlineCommonChunks: {
        maxSize: 10 * 1024, // < 10 KiB
      },
    },
  },
});

maxSize 使用转换后的源代码大小,并在渲染、代码压缩和传输压缩前按 chunk 求和。默认值为 0(禁用);Infinity 表示取消大小限制。

入口和手动 chunk 不会被内联。动态导入也会加载的公共 chunk 可以内联到静态导入它的 chunk 中;之后动态导入会加载一个只负责注册该模块的文件(参见由 import() 加载的模块)。只要 exclude 与任一模块匹配,整个公共 chunk 都不会被内联。

内联需要满足以下条件:

工作原理 ​

自动代码分割遵循从 Rollup 输出模型继承的两条规则:

  1. 一个模块的代码只会出现在一个输出 chunk 中。
  2. 一个入口只会加载从该入口可达的应用模块。

用法中的配置定义了三个入口:A、B 和 C。三个入口都会导入一个大型库;A 和 B 还会导入一个带计数器的小型辅助模块:

js
import './library.js';
import { inc } from './helper.js';

console.log(inc());
js
import './library.js';
js
console.log('helper initialized');
let count = 0;
export function inc() {
  return ++count;
}

无论大小如何,库和辅助模块都会进入不同的公共 chunk,因为导入它们的入口集合不同。动态导入目标也会被视为入口,因此惰性加载的路由之间也会出现相同的情况。

手动代码分割可以将它们合并,但这样 C 也会加载辅助模块。内联会把辅助模块复制到 A 和 B 中。假设辅助模块小于 maxSize,而库大于该值:

cluster_beforeSeparate common chunkscluster_afterHelper inlinedaAhelperhelpera->helperlibrarylibrarya->librarybBb->helperb->librarycCc->librarya_inlineA + helperlibrary_inlinelibrarya_inline->library_inlineb_inlineB + helperb_inline->library_inlinec_inlineCc_inline->library_inline
cluster_beforeSeparate common chunkscluster_afterHelper inlinedaAhelperhelpera->helperlibrarylibrarya->librarybBb->helperb->librarycCc->librarya_inlineA + helperlibrary_inlinelibrarya_inline->library_inlineb_inlineB + helperb_inline->library_inlinec_inlineCc_inline->library_inline

箭头表示导入;图中省略了共享运行时。

在副本之间共享状态 ​

在同一个 JavaScript 环境中先加载 A 再加载 B,会得到以下输出:

text
helper initialized
1
2

如果将辅助模块的代码分别粘贴到两个文件中,就会创建两个计数器,且初始值都是 0。每个文件都会输出 helper initialized 和 1。导出的对象和函数也会具有不同的身份。

Rolldown 会用一个 工厂函数 包装公共 chunk,并通过共享运行时注册每个副本。A 和 B 中都包含以下代码(名称已简化;省略了库导入和入口包装代码):

js
import {
  __share,
  __share_require,
  __share_export,
  __esmMin,
} from './rolldown-runtime.js';

__share('helper', (exports) => {
  let count;
  function inc() {
    return ++count;
  }
  const init_helper = __esmMin(() => {
    console.log('helper initialized');
    count = 0;
  });
  __share_export(exports, {
    inc: () => inc,
    init_helper: () => init_helper,
  });
});

const helper = __share_require('helper');
helper.init_helper();
console.log((0, helper.inc)());
运行时辅助函数行为
__share注册工厂函数,但不调用它。同一标识符的首次注册会生效。
__share_require首次使用时运行工厂函数,并缓存其导出对象。
__esmMin确保模块初始化函数只运行一次。
__share_export通过 getter 暴露导出,从而保留实时绑定。

A 调用 init_helper 初始化共享的 count,inc() 返回 1。B 会取得相同的函数:它的初始化函数不执行任何操作,而 inc() 返回 2。

将注册与模块初始化分开,可以在使用方运行之前提供工厂函数;strictExecutionOrder 则控制模块顶层代码的执行时机。

所有副本都必须导入同一个运行时 chunk,才能共享状态。

加载与缓存 ​

A 注册了辅助模块,并不会移除 B 文件中内嵌的副本;获取 B 时仍会传输这段代码。

加载场景独立的辅助 chunk内联到 A 和 B 中的辅助模块
首次加载 A单独获取辅助模块。在 A 中获取辅助模块。
随后加载 B复用已加载的辅助模块。在 B 中获取另一个副本。
加载已更新的 A,未变更的辅助模块已缓存复用缓存的辅助模块。在新的 A 中再次获取辅助模块。

少一次请求可能足以抵消复制小型辅助模块的成本。使用 maxSize: Infinity 时,A、B 和 C 共享的大型库也会面临同样的权衡:如果该库符合内联条件,加载三个入口就会传输三份库代码。运行时也会增加一个共享文件和执行开销。

maxSize 检查的是 chunk 的源代码大小,而不是副本为用户会话增加的总字节数。因此,chunk 数量减少并不保证加载更快。决定是否启用内联或提高阈值之前,请比较应用首次加载和后续导航时启用与未启用内联的加载时间,并考虑缓存复用。

优化 ​

避免不必要的副本 ​

A 和 B 都需要包含工厂函数,因为任一入口都可能先加载。现在假设两者都可以动态导入同样使用该辅助模块的 detail.js。动态导入开始时,A 或 B 已经注册了工厂函数,因此 detail.js 不需要再包含一个副本:

aA + helper factorydetaildetail.jsuses the registered factorya->detailimport()bB + helper factoryb->detailimport()
aA + helper factorydetaildetail.jsuses the registered factorya->detailimport()bB + helper factoryb->detailimport()
detail.js
js
import { __share_require } from './rolldown-runtime.js';

const helper = __share_require('helper');
helper.init_helper();
console.log((0, helper.inc)());

只有当从已配置入口或插件生成的入口出发的每条已知路径都会先提供工厂函数时,Rolldown 才会省略副本。更早加载的静态依赖也可以提供它。

由 import() 加载的模块 ​

一个入口可以静态导入某个模块,而另一个入口通过 import() 加载它:

js
import { inc } from './helper.js';

console.log(inc());
js
button.onclick = () => import('./helper.js').then((helper) => helper.inc());

辅助模块的代码会进入一个公共 chunk,供入口 A 和 import() 加载。内联该 chunk 后,A 会包含一份辅助模块副本,而 import() 加载的文件只会注册该模块,不导出任何内容。调用位置随后会从共享运行时读取辅助模块(名称已简化):

d.js
js
import { __share_require } from './rolldown-runtime.js';

button.onclick = () =>
  import('./helper.js')
    .then((n) => ((n = __share_require('helper')), n.init_helper(), n.helper_namespace))
    .then((helper) => helper.inc());

哪个副本先完成注册,所有调用方就会使用哪个副本,因此辅助模块只运行一次,其命名空间对象也会共享。A 不会请求辅助模块文件;只有在执行 import() 时,D 才会请求该文件,即使 A 已经注册了辅助模块也是如此。当所有调用 import() 的文件都已注册该辅助模块时,Rolldown 不会为它生成文件。

这要求将 import() 目标合并到公共 chunk 中。如果某个模块本身也是入口,或者构建中有模块使用顶层 await,那么该 import() 目标会保留自己的文件,并从公共 chunk 重新导出;此时公共 chunk 不会被内联。

让模块保持在同一作用域中 ​

Rolldown 会用一个工厂函数包装整个公共 chunk,因此其中的模块可以直接相互引用。压缩器可以在该作用域内重命名并内联代码。来自工厂函数外部的引用需要经过它的导出对象,这会限制跨越边界的优化。

兼容性 ​

chunk 选择 ​

即使公共 chunk 小于 maxSize,在以下情况下也不会内联:

  • 包含顶层 await,或静态依赖包含顶层 await 的模块。
  • 包含 tree shaking 后仍保留的 import.meta,但不包括 import.meta.ROLLDOWN_FILE_URL_referenceId。
  • 包含尚未解析的动态导入,或导入外部模块。
  • 另一个输出 chunk 重新导出了它的某个绑定。
  • 包含声明模块或内置的 asset、copy 模块。

涉及未内联 chunk 的直接 eval 和静态循环也可能阻止内联。

插件 ​

  • 一个内联模块会出现在每个包含其副本的 chunk 的 moduleIds 和 modules 中。CSS 提取和 SSR 清单插件必须考虑到一个模块可能属于多个 chunk。

    Vite

    对于 Vite 构建,请将此 exclude 匹配器添加到 experimentalInlineCommonChunks,以避免 CSS 在多个输出样式表中重复:

    js
    exclude: /\.(css|scss|sass|less|styl|stylus|pcss|postcss|sss)(\?|$)/,
  • Rolldown 会针对每个副本调用一次 resolveFileUrl,并传入包含该副本的 chunk 的 chunkId 和 relativePath。

  • 如果 renderChunk 或 resolveFileUrl hook 为不同副本提供了不同的值,则所有使用方都会采用第一个已注册副本的值。对于受影响的模块,请使用 exclude。

更多背景信息请参阅设计 RFC。欢迎在反馈 issue中分享应用效果和问题报告。

Was this page helpful?