关于 react-best-practices
由 Vercel 维护的 React 和 Next.js 性能指南 Skill,包含按影响优先级组织的 64 条规则,分为八类。适用于编写、审查或重构应用的开发者和编码 Agent。
主要功能
- 01涵盖八类共 64 条规则
- 02按性能影响确定优化优先级
- 03提供异步处理与包体积建议
- 04涵盖服务端和客户端数据获取
- 05优化渲染与重复渲染性能
适用场景
- 01审查 React 代码中的性能问题
- 02重构 Next.js 数据获取流程
- 03缩减包体积和加载时间
- 04指导自动化代码生成
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openai/ plugins --skill react-best-practices安装后在 Claude Code 中输入/react-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonREADME.mdagents/openai.yamlrules/_sections.md_template.mdadvanced-event-handler-refs.mdadvanced-init-once.mdadvanced-use-latest.mdasync-api-routes.mdasync-defer-await.mdasync-dependencies.mdasync-parallel.mdasync-suspense-boundaries.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.mdjs-early-exit.mdjs-flatmap-filter.md详细介绍
Vercel React 最佳实践
面向 React 和 Next.js 应用的全面性能优化指南,由 Vercel 维护。包含 8 个类别中的 64 条规则,并按影响优先级排序,旨在指导自动重构和代码生成。
适用场景
在以下情况下参考这些指南:
- 编写新的 React 组件或 Next.js 页面
- 实现数据获取(客户端或服务器端)
- 检查代码中的性能问题
- 重构现有 React/Next.js 代码
- 优化打包体积或加载时间
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 消除瀑布流 | CRITICAL | async- |
| 2 | 打包体积优化 | CRITICAL | bundle- |
| 3 | 服务端性能 | HIGH | server- |
| 4 | 客户端数据获取 | MEDIUM-HIGH | client- |
| 5 | 重新渲染优化 | MEDIUM | rerender- |
| 6 | 渲染性能 | MEDIUM | rendering- |
| 7 | JavaScript 性能 | LOW-MEDIUM | js- |
| 8 | 高级模式 | LOW | advanced- |
快速参考
1. 消除瀑布流(CRITICAL)
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-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- 使用 LRU 缓存实现跨请求缓存server-dedup-props- 避免在 RSC 属性中重复序列化server-hoist-static-io- 将静态 I/O(字体、Logo)提升到模块级别server-serialization- 尽量减少传递给客户端组件的数据server-parallel-fetching- 重构组件以并行获取数据server-after-nonblocking- 使用 after() 执行非阻塞操作
4. 客户端数据获取(MEDIUM-HIGH)
client-swr-dedup- 使用 SWR 自动对请求去重client-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- 对非紧急更新使用 startTransitionrerender-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- 条件渲染使用三元表达式,而不是 &&rendering-usetransition-loading- 加载状态优先使用 useTransitionrendering-resource-hints- 使用 React DOM 资源提示进行预加载rendering-script-defer-async- 在 script 标签上使用 defer 或 async
7. JavaScript 性能(LOW-MEDIUM)
js-batch-dom-css- 通过类名或 cssText 批量修改 CSSjs-index-maps- 为重复查找构建 Mapjs-cache-property-access- 在循环中缓存对象属性js-cache-function-results- 在模块级 Map 中缓存函数结果js-cache-storage- 缓存 localStorage/sessionStorage 的读取结果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 在一次遍历中完成映射和过滤
8. 高级模式(LOW)
advanced-event-handler-refs- 将事件处理函数存储在 ref 中advanced-init-once- 每次应用加载时只初始化一次advanced-use-latest- 使用 useLatest 获得稳定的回调 ref
如何使用
阅读各个规则文件以获取详细说明和代码示例:
rules/async-parallel.md
rules/bundle-barrel-imports.md
每个规则文件包含:
- 对其重要性的简要说明
- 带有说明的错误代码示例
- 带有说明的正确代码示例
- 额外的背景信息和参考
完整汇编文档
如需展开全部规则的完整指南:AGENTS.md
评论
支持 Markdown