关于 vercel-react-best-practices
这是一套由仓库维护的 React 和 Next.js 指南,面向开发、审查和优化相关应用的开发者。它要求先确认具体性能成本并保护正确性与工作范围,再以测量支持性能改进结论。
主要功能
- 01涵盖八类性能主题
- 02基于具体机制评估优化
- 03按条件提供缓存与依赖建议
- 04支持按需查阅规则和汇编指南
适用场景
- 01排查 React 或 Next.js 性能问题
- 02减少数据请求瀑布或打包体积
- 03评估缓存是否适用
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ marcellocurto/ skills --skill vercel-react-best-practices安装后在 Claude Code 中输入/vercel-react-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonREADME.mdrules/_sections.md_template.mdadvanced-effect-event-deps.mdadvanced-event-handler-refs.mdadvanced-init-once.mdadvanced-use-latest.mdasync-api-routes.mdasync-cheap-condition-before-await.mdasync-defer-await.mdasync-dependencies.mdasync-parallel.mdasync-suspense-boundaries.mdbundle-analyzable-paths.mdbundle-barrel-imports.mdbundle-conditional.mdbundle-defer-third-party.mdbundle-dynamic-imports.mdbundle-preload.mdclient-event-listeners.mdclient-localstorage-schema.mdclient-passive-event-listeners.mdclient-swr-dedup.mdjs-batch-dom-css.mdjs-cache-function-results.mdjs-cache-property-access.mdjs-cache-storage.mdjs-combine-iterations.md详细介绍
Vercel React 最佳实践
由仓库维护的 React 和 Next.js 指南,改编自 Vercel 的规则。请用它解决当前工作中具体的性能机制问题,而不是在整个应用中套用所有列出的模式。
优化前先确认相关性
确定受影响的路径、符合实际情况的工作负载,以及可避免的开销:依赖瀑布流、重复请求、过大的包、开销高昂的渲染或热点计算。使用代码和用法证据,或有代表性的跟踪记录/性能分析,来佐证相关机制。仅仅匹配某条规则或有影响等级标签,并不足以证明应当进行更改。
保留用户要求的范围、现有架构和正确性约定。优先使用现有功能或直接修改代码,再考虑添加库、缓存或抽象。如果现有代码已经足够,而拟议的优化没有明显的预期收益,就不要改动。正确性和安全性义务不取决于能否证明性能提升。
提出性能方面的主张时,应使用可比的工作负载和条件进行前后测量。如果无法测量,请说明有证据支持的机制,并将收益标注为预期或未经验证。不要把示例中的耗时、百分比或影响评级当作用户应用的实测结果。
依赖项与缓存归属
SWR、better-all、LRU 缓存和记忆化都是有条件的选项。如果项目现有的数据获取、调度或缓存功能可以满足需求,就应复用这些功能。只有在已证实的需求足以证明其维护和运行时成本合理时,才添加依赖;示例导入并不意味着必须安装该依赖。
添加缓存前,应确认是否存在重复工作、键的身份是否合适、缓存的所有者和生命周期、可接受的过期程度、失效机制、内存上限,以及数据是否需要按用户或租户隔离。选择范围最小且实用的缓存。缓存可变结果或依赖授权的结果时,不得破坏这些约定。
适用场景
在以下情况下,请参考这些指南:
- 编写新的 React 组件或 Next.js 页面
- 实现数据获取(客户端或服务端)
- 审查代码中的性能问题
- 重构现有 React/Next.js 代码
- 优化包体积或加载时间
按优先级划分的规则类别
这些评级表示在适用条件下调查问题的相对优先级。规则中的数值收益仅用于说明或源于特定场景,并非当前应用的保证或实测结果。审查时,应根据已证实的影响评估严重程度,而不要直接照搬规则评级。
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 消除瀑布流 | 严重 | async- |
| 2 | 优化包体积 | 严重 | bundle- |
| 3 | 服务端性能 | 高 | server- |
| 4 | 客户端数据获取 | 中高 | client- |
| 5 | 优化重新渲染 | 中 | rerender- |
| 6 | 渲染性能 | 中 | rendering- |
| 7 | JavaScript 性能 | 低至中 | js- |
| 8 | 高级模式 | 低 | advanced- |
快速参考
1. 消除瀑布流(严重)
async-cheap-condition-before-await- 在等待标志或远程值之前,先检查开销低的同步条件async-defer-await- 将 await 移入实际需要它的分支async-parallel- 使用 Promise.all() 并行执行互不依赖的操作async-dependencies- 直接表达实际依赖;确有必要时再考虑 better-allasync-api-routes- 在 API 路由中尽早启动 Promise,延后等待async-suspense-boundaries- 使用 Suspense 流式传输内容
2. 优化打包体积(CRITICAL)
bundle-barrel-imports- 直接导入,避免使用汇总文件bundle-analyzable-paths- 优先使用可静态分析的导入路径和文件系统路径,避免打包或跟踪范围过广bundle-dynamic-imports- 对大型组件使用 next/dynamicbundle-defer-third-party- 在 hydration 后加载分析和日志记录工具bundle-conditional- 仅在功能启用时加载模块bundle-preload- 在悬停或聚焦时预加载,提升感知速度
3. 服务端性能(HIGH)
server-auth-actions- 像验证 API 路由一样验证服务端操作server-cache-react- 对受支持的服务端渲染中重复执行的工作,考虑使用 React.cache()server-cache-lru- 在数据时效性和隔离性允许复用时,考虑使用有界跨请求缓存server-dedup-props- 避免在 RSC 属性中重复序列化server-hoist-static-io- 将静态 I/O(字体、徽标)提升到模块级别server-no-shared-module-state- 避免在 RSC/SSR 中使用模块级可变请求状态server-serialization- 尽量减少传递给客户端组件的数据server-parallel-fetching- 重构组件以并行获取数据server-parallel-nested-fetching- 使用 Promise.all 按项目串联嵌套数据获取server-after-nonblocking- 使用 after() 执行非阻塞操作
4. 客户端数据获取(MEDIUM-HIGH)
client-swr-dedup- 复用请求去重机制;如果适合项目的数据层,可考虑使用 SWRclient-event-listeners- 对全局事件监听器进行去重client-passive-event-listeners- 为滚动事件使用被动监听器client-localstorage-schema- 对 localStorage 数据进行版本管理并尽量精简
5. 重新渲染优化(MEDIUM)
rerender-defer-reads- 不要订阅仅在回调中使用的状态rerender-memo- 将开销较大的工作提取到经过记忆化的组件中rerender-memo-with-default-value- 将默认的非原始类型属性提升到组件外rerender-dependencies- 在 effect 中使用原始类型依赖项rerender-derived-state- 订阅派生布尔值,而不是原始值rerender-derived-state-no-effect- 在渲染期间派生状态,而不是在 effect 中rerender-functional-setstate- 使用函数式 setState 保持回调稳定rerender-lazy-state-init- 对开销较大的值,将函数传给 useStatererender-simple-expression-in-memo- 简单原始值无需使用 memorerender-split-combined-hooks- 拆分依赖项彼此独立的 hooksrerender-move-effect-to-event- 将交互逻辑放入事件处理程序rerender-transitions- 使用 startTransition 处理非紧急更新rerender-use-deferred-value- 延迟开销较大的渲染,保持输入响应灵敏rerender-use-ref-transient-values- 使用 ref 保存频繁变化的临时值rerender-no-inline-components- 不要在组件内部定义组件
6. 渲染性能(MEDIUM)
rendering-animate-svg-wrapper- 为 div 包装元素添加动画,而不是为 SVG 元素添加动画rendering-content-visibility- 对长列表使用 content-visibilityrendering-hoist-jsx- 将静态 JSX 提取到组件外rendering-svg-precision- 降低 SVG 坐标精度rendering-hydration-no-flicker- 使用内联脚本处理仅限客户端的数据rendering-hydration-suppress-warning- 抑制预期会出现的不匹配警告rendering-activity- 使用 Activity 组件控制显示和隐藏rendering-conditional-render- 当条件可能为 0、NaN 或其他会被渲染的假值时,使用三元表达式代替 &&rendering-usetransition-loading- 优先使用 useTransition 处理加载状态rendering-resource-hints- 使用 React DOM 资源提示进行预加载rendering-script-defer-async- 在 script 标签上使用 defer 或 async
7. JavaScript 性能(低至中)
js-batch-dom-css- 将布局读取与样式写入分开;连续写入本身已会批处理js-index-maps- 为重复查找构建 Mapjs-cache-property-access- 在循环中缓存对象属性js-cache-function-results- 仅在键和生命周期合适时缓存高开销的重复计算js-cache-storage- 仅在失效策略可靠时缓存频繁读取的存储数据js-combine-iterations- 将多个 filter/map 合并为一次循环js-length-check-first- 在进行高开销比较前检查数组长度js-early-exit- 尽早从函数返回js-hoist-regexp- 将 RegExp 的创建移到循环外js-min-max-loop- 使用循环求最小值/最大值,而非排序js-set-map-lookups- 使用 Set/Map 实现 O(1) 查找js-tosorted-immutable- 使用 toSorted() 实现不可变操作js-flatmap-filter- 使用 flatMap 一次完成映射和筛选js-request-idle-callback- 将非关键工作推迟到浏览器空闲时间
8. 高级模式(低)
advanced-effect-event-deps- 不要将useEffectEvent的结果放入 effect 依赖项advanced-event-handler-refs- 将事件处理程序存储在 ref 中advanced-init-once- 每次应用加载时只初始化一次advanced-use-latest- 使用 useLatest 获取稳定的回调 ref
使用方法
使用索引选择与已识别机制相关的规则。阅读对应的单独文件及其适用示例;仅在具体依赖或未解决的问题需要时才加载其他规则。默认情况下,不要阅读整个编译版指南。
rules/async-parallel.md
rules/bundle-barrel-imports.md
根据示例所声明的工作负载和假设来理解示例标签。调整示例时,保留框架/版本兼容性,以及实际的错误、顺序、缓存和所有权约定。
编译版参考
rules/ 包含规范指导。AGENTS.md 是供有意阅读完整指南时使用的编译版参考,并非运行时入口。维护规则时,请在同一次更改中同步其编译版章节,以及受影响的索引或元数据;维护详情请参阅此技能的 README.md。