vercel-react-best-practices
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseVercel React Best Practices
Vercel React 最佳实践
Comprehensive performance optimization guide for React and Next.js applications, maintained by Vercel. Contains 57 rules across 8 categories, prioritized by impact to guide automated refactoring and code generation.
由 Vercel 维护的 React 与 Next.js 应用性能优化综合指南。包含 8 个类别下的 57 条规则,按影响优先级排序,可指导自动化重构与代码生成。
When to Apply
适用场景
Reference these guidelines when:
- Writing new React components or Next.js pages
- Implementing data fetching (client or server-side)
- Reviewing code for performance issues
- Refactoring existing React/Next.js code
- Optimizing bundle size or load times
在以下场景中参考本指南:
- 编写新的 React 组件或 Next.js 页面
- 实现数据获取(客户端或服务端)
- 审查代码以排查性能问题
- 重构现有 React/Next.js 代码
- 优化包体积或加载时间
Rule Categories by Priority
按优先级划分的规则类别
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | Eliminating Waterfalls | CRITICAL | |
| 2 | Bundle Size Optimization | CRITICAL | |
| 3 | Server-Side Performance | HIGH | |
| 4 | Client-Side Data Fetching | MEDIUM-HIGH | |
| 5 | Re-render Optimization | MEDIUM | |
| 6 | Rendering Performance | MEDIUM | |
| 7 | JavaScript Performance | LOW-MEDIUM | |
| 8 | Advanced Patterns | LOW | |
| 优先级 | 类别 | 影响级别 | 前缀 |
|---|---|---|---|
| 1 | 消除请求瀑布 | 关键 | |
| 2 | 包体积优化 | 关键 | |
| 3 | 服务端性能 | 高 | |
| 4 | 客户端数据获取 | 中高 | |
| 5 | 重渲染优化 | 中 | |
| 6 | 渲染性能 | 中 | |
| 7 | JavaScript 性能 | 中低 | |
| 8 | 进阶模式 | 低 | |
Quick Reference
快速参考
1. Eliminating Waterfalls (CRITICAL)
1. 消除请求瀑布(关键)
- - Move await into branches where actually used
async-defer-await - - Use Promise.all() for independent operations
async-parallel - - Use better-all for partial dependencies
async-dependencies - - Start promises early, await late in API routes
async-api-routes - - Use Suspense to stream content
async-suspense-boundaries
- - 将 await 移至实际需要使用的分支中
async-defer-await - - 对独立操作使用 Promise.all()
async-parallel - - 使用 better-all 处理部分依赖
async-dependencies - - 在 API 路由中尽早启动 Promise,延迟 await 执行
async-api-routes - - 使用 Suspense 流式传输内容
async-suspense-boundaries
2. Bundle Size Optimization (CRITICAL)
2. 包体积优化(关键)
- - Import directly, avoid barrel files
bundle-barrel-imports - - Use next/dynamic for heavy components
bundle-dynamic-imports - - Load analytics/logging after hydration
bundle-defer-third-party - - Load modules only when feature is activated
bundle-conditional - - Preload on hover/focus for perceived speed
bundle-preload
- - 直接导入,避免使用桶文件
bundle-barrel-imports - - 对大型组件使用 next/dynamic
bundle-dynamic-imports - - 在 hydration 完成后加载分析/日志工具
bundle-defer-third-party - - 仅在功能激活时加载模块
bundle-conditional - - 在鼠标悬停/聚焦时预加载资源以提升感知速度
bundle-preload
3. Server-Side Performance (HIGH)
3. 服务端性能(高)
- - Authenticate server actions like API routes
server-auth-actions - - Use React.cache() for per-request deduplication
server-cache-react - - Use LRU cache for cross-request caching
server-cache-lru - - Avoid duplicate serialization in RSC props
server-dedup-props - - Minimize data passed to client components
server-serialization - - Restructure components to parallelize fetches
server-parallel-fetching - - Use after() for non-blocking operations
server-after-nonblocking
- - 像验证 API 路由一样验证服务端操作
server-auth-actions - - 使用 React.cache() 实现请求内重复请求消除
server-cache-react - - 使用 LRU 缓存实现跨请求缓存
server-cache-lru - - 避免在 RSC props 中重复序列化数据
server-dedup-props - - 最小化传递给客户端组件的数据量
server-serialization - - 重构组件以并行化数据获取
server-parallel-fetching - - 使用 after() 处理非阻塞操作
server-after-nonblocking
4. Client-Side Data Fetching (MEDIUM-HIGH)
4. 客户端数据获取(中高)
- - Use SWR for automatic request deduplication
client-swr-dedup - - Deduplicate global event listeners
client-event-listeners - - Use passive listeners for scroll
client-passive-event-listeners - - Version and minimize localStorage data
client-localstorage-schema
- - 使用 SWR 自动消除重复请求
client-swr-dedup - - 消除全局事件监听器的重复注册
client-event-listeners - - 对滚动事件使用被动监听器
client-passive-event-listeners - - 对 localStorage 数据进行版本控制并最小化存储量
client-localstorage-schema
5. Re-render Optimization (MEDIUM)
5. 重渲染优化(中)
- - Don't subscribe to state only used in callbacks
rerender-defer-reads - - Extract expensive work into memoized components
rerender-memo - - Hoist default non-primitive props
rerender-memo-with-default-value - - Use primitive dependencies in effects
rerender-dependencies - - Subscribe to derived booleans, not raw values
rerender-derived-state - - Derive state during render, not effects
rerender-derived-state-no-effect - - Use functional setState for stable callbacks
rerender-functional-setstate - - Pass function to useState for expensive values
rerender-lazy-state-init - - Avoid memo for simple primitives
rerender-simple-expression-in-memo - - Put interaction logic in event handlers
rerender-move-effect-to-event - - Use startTransition for non-urgent updates
rerender-transitions - - Use refs for transient frequent values
rerender-use-ref-transient-values
- - 不要仅为回调函数使用的状态订阅
rerender-defer-reads - - 将昂贵的逻辑提取到 memoized 组件中
rerender-memo - - 将非原始类型的默认属性提升到外部
rerender-memo-with-default-value - - 在 effects 中使用原始类型依赖
rerender-dependencies - - 订阅派生的布尔值而非原始值
rerender-derived-state - - 在渲染期间派生状态,而非在 effects 中
rerender-derived-state-no-effect - - 使用函数式 setState 以获得稳定的回调
rerender-functional-setstate - - 为 useState 传入函数以处理昂贵的初始化值
rerender-lazy-state-init - - 避免为简单原始类型使用 memo
rerender-simple-expression-in-memo - - 将交互逻辑放入事件处理函数中
rerender-move-effect-to-event - - 使用 startTransition 处理非紧急更新
rerender-transitions - - 使用 refs 存储频繁变化的临时值
rerender-use-ref-transient-values
6. Rendering Performance (MEDIUM)
6. 渲染性能(中)
- - Animate div wrapper, not SVG element
rendering-animate-svg-wrapper - - Use content-visibility for long lists
rendering-content-visibility - - Extract static JSX outside components
rendering-hoist-jsx - - Reduce SVG coordinate precision
rendering-svg-precision - - Use inline script for client-only data
rendering-hydration-no-flicker - - Suppress expected mismatches
rendering-hydration-suppress-warning - - Use Activity component for show/hide
rendering-activity - - Use ternary, not && for conditionals
rendering-conditional-render - - Prefer useTransition for loading state
rendering-usetransition-loading
- - 为 div 容器添加动画,而非直接为 SVG 元素添加
rendering-animate-svg-wrapper - - 对长列表使用 content-visibility
rendering-content-visibility - - 将静态 JSX 提取到组件外部
rendering-hoist-jsx - - 降低 SVG 坐标精度
rendering-svg-precision - - 使用内联脚本传递客户端专属数据
rendering-hydration-no-flicker - - 抑制预期的不匹配警告
rendering-hydration-suppress-warning - - 使用 Activity 组件处理显示/隐藏逻辑
rendering-activity - - 使用三元表达式而非 && 进行条件渲染
rendering-conditional-render - - 优先使用 useTransition 处理加载状态
rendering-usetransition-loading
7. JavaScript Performance (LOW-MEDIUM)
7. JavaScript 性能(中低)
- - Group CSS changes via classes or cssText
js-batch-dom-css - - Build Map for repeated lookups
js-index-maps - - Cache object properties in loops
js-cache-property-access - - Cache function results in module-level Map
js-cache-function-results - - Cache localStorage/sessionStorage reads
js-cache-storage - - Combine multiple filter/map into one loop
js-combine-iterations - - Check array length before expensive comparison
js-length-check-first - - Return early from functions
js-early-exit - - Hoist RegExp creation outside loops
js-hoist-regexp - - Use loop for min/max instead of sort
js-min-max-loop - - Use Set/Map for O(1) lookups
js-set-map-lookups - - Use toSorted() for immutability
js-tosorted-immutable
- - 通过类名或 cssText 批量修改 CSS
js-batch-dom-css - - 构建 Map 以实现重复查找
js-index-maps - - 在循环中缓存对象属性
js-cache-property-access - - 在模块级 Map 中缓存函数结果
js-cache-function-results - - 缓存 localStorage/sessionStorage 的读取结果
js-cache-storage - - 将多个 filter/map 合并为单次循环
js-combine-iterations - - 在进行昂贵的比较前先检查数组长度
js-length-check-first - - 提前从函数返回
js-early-exit - - 将 RegExp 创建逻辑提升到循环外部
js-hoist-regexp - - 使用循环而非排序来获取最小值/最大值
js-min-max-loop - - 使用 Set/Map 实现 O(1) 时间复杂度的查找
js-set-map-lookups - - 使用 toSorted() 实现不可变排序
js-tosorted-immutable
8. Advanced Patterns (LOW)
8. 进阶模式(低)
- - Store event handlers in refs
advanced-event-handler-refs - - Initialize app once per app load
advanced-init-once - - useLatest for stable callback refs
advanced-use-latest
- - 将事件处理函数存储在 refs 中
advanced-event-handler-refs - - 每个应用加载周期仅初始化一次应用
advanced-init-once - - 使用 useLatest 获得稳定的回调 refs
advanced-use-latest
How to Use
使用方法
Read individual rule files for detailed explanations and code examples:
rules/async-parallel.md
rules/bundle-barrel-imports.mdEach rule file contains:
- Brief explanation of why it matters
- Incorrect code example with explanation
- Correct code example with explanation
- Additional context and references
阅读单个规则文件以获取详细说明和代码示例:
rules/async-parallel.md
rules/bundle-barrel-imports.md每个规则文件包含:
- 该规则重要性的简要说明
- 错误代码示例及解释
- 正确代码示例及解释
- 额外背景信息与参考资料
Full Compiled Document
完整编译文档
For the complete guide with all rules expanded:
AGENTS.md如需查看包含所有规则详细内容的完整指南,请参阅:
AGENTS.md