mcpField
F
frontend-react-best-practices

frontend-react-best-practices

github.com/sergiodxa开发921.2k 次安装38 周前更新
代码仓库

关于 frontend-react-best-practices

frontend-react-best-practices 汇集 React 组件性能优化与组合模式指南,面向编写、审查或重构 React 代码的开发者。33 条规则分为 6 类,涉及重渲染、打包体积、渲染、Hooks 与组件组合。

主要功能

  1. 0133 条规则分为 6 类
  2. 02优化打包体积与模块加载
  3. 03减少不必要的重渲染
  4. 04改进渲染与水合处理
  5. 05提供 Hooks 使用建议
  6. 06说明组件组合模式

适用场景

  1. 01编写新的 React 组件时查阅规则
  2. 02审查并定位性能问题
  3. 03重构 Hooks 与组件状态逻辑
  4. 04优化应用打包体积

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/sergiodxa/agent-skills --skill frontend-react-best-practices

安装后在 Claude Code 中输入/frontend-react-best-practices确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rules/
bundle-barrel-imports.md
bundle-conditional.md
bundle-preload.md
client-localstorage-schema.md
client-passive-event-listeners.md
composition-avoid-boolean-props.md
composition-avoid-overabstraction.md
composition-children-over-render-props.md
composition-compound-components.md
composition-explicit-variants.md
composition-state-provider.md
composition-typescript-namespaces.md
fault-tolerant-error-boundaries.md
hooks-limit-useeffect.md
hooks-useeffect-named-functions.md
rendering-animate-svg-wrapper.md
rendering-client-only.md
rendering-conditional-render.md
rendering-content-visibility.md
rendering-hoist-jsx.md
rendering-hydration-no-flicker.md
rendering-hydration-suppress-warning.md
rendering-svg-precision.md
rendering-use-hydrated.md
rendering-usetransition-loading.md
rerender-dependencies.md
rerender-derived-state-no-effect.md
rerender-derived-state.md
rerender-functional-setstate.md
rerender-lazy-state-init.md

详细介绍

React 最佳实践

React 组件的性能优化与组合模式。包含 6 个类别中的 33 条规则,重点在于减少重新渲染、优化打包体积、组件组合以及避免常见的 React 陷阱。

适用场景

在以下情况下参考这些指南:

  • 编写新的 React 组件
  • 审查代码中的性能问题
  • 重构现有的 React 代码
  • 优化打包体积
  • 使用 Hooks 和状态

规则摘要

打包体积优化(关键)
bundle-barrel-imports - @rules/bundle-barrel-imports.md

直接从源文件导入,避免使用汇总文件。

// Bad: loads entire library (200-800ms)
import { Check, X } from "lucide-react";

// Good: loads only what you need
import Check from "lucide-react/dist/esm/icons/check";
import X from "lucide-react/dist/esm/icons/x";
bundle-conditional - @rules/bundle-conditional.md

仅在功能启用时加载模块。

useEffect(() => {
  if (enabled && typeof window !== "undefined") {
    import("./heavy-module").then((mod) => setModule(mod));
  }
}, [enabled]);
bundle-preload - @rules/bundle-preload.md

在悬停或聚焦时预加载,提升感知速度。

<button
  onMouseEnter={() => import("./editor")}
  onFocus={() => import("./editor")}
  onClick={openEditor}
>
  Open Editor
</button>
重新渲染优化(中)
rerender-functional-setstate - @rules/rerender-functional-setstate.md

使用函数式 setState,以保持回调稳定。

// Bad: stale closure risk, recreates on items change
const addItem = useCallback(
  (item) => {
    setItems([...items, item]);
  },
  [items],
);

// Good: always uses latest state, stable reference
const addItem = useCallback((item) => {
  setItems((curr) => [...curr, item]);
}, []);
rerender-derived-state-no-effect - @rules/rerender-derived-state-no-effect.md

在渲染期间派生状态,而不是在 Effect 中派生。

// Bad: extra state and effect, extra render
const [fullName, setFullName] = useState("");
useEffect(() => {
  setFullName(firstName + " " + lastName);
}, [firstName, lastName]);

// Good: derived directly during render
const fullName = firstName + " " + lastName;
rerender-lazy-state-init - @rules/rerender-lazy-state-init.md

对于开销较大的初始值,向 useState 传递函数。

// Bad: runs expensiveComputation() on every render
const [data] = useState(expensiveComputation());

// Good: runs only on initial render
const [data] = useState(() => expensiveComputation());
rerender-dependencies - @rules/rerender-dependencies.md

在 Effect 中使用原始类型作为依赖项。

// Bad: runs on any user field change
useEffect(() => {
  console.log(user.id);
}, [user]);

// Good: runs only when id changes
useEffect(() => {
  console.log(user.id);
}, [user.id]);
rerender-derived-state - @rules/rerender-derived-state.md

订阅派生布尔值,而不是原始值。

// Bad: re-renders on every pixel change
const width = useWindowWidth();
const isMobile = width < 768;

// Good: re-renders only when boolean changes
const isMobile = useMediaQuery("(max-width: 767px)");
rerender-memo - @rules/rerender-memo.md

将开销较大的操作提取到经过记忆化的组件中。

// Good: skips computation when loading
const UserAvatar = memo(function UserAvatar({ user }) {
  let id = useMemo(() => computeAvatarId(user), [user]);
  return <Avatar id={id} />;
});

function Profile({ user, loading }) {
  if (loading) return <Skeleton />;
  return <UserAvatar user={user} />;
}
rerender-memo-with-default-value - @rules/rerender-memo-with-default-value.md

将默认的非原始类型属性提升为常量。

// Bad: breaks memoization (new function each render)
const Button = memo(({ onClick = () => {} }) => ...)

// Good: stable default value
const NOOP = () => {}
const Button = memo(({ onClick = NOOP }) => ...)
rerender-simple-expression-in-memo - @rules/rerender-simple-expression-in-memo.md

不要用 useMemo 包装简单的原始类型表达式。

// Bad: useMemo overhead > expression cost
const isLoading = useMemo(() => a.loading || b.loading, [a.loading, b.loading]);

// Good: just compute it
const isLoading = a.loading || b.loading;
rerender-move-effect-to-event - @rules/rerender-move-effect-to-event.md

将交互逻辑放在事件处理程序中,而不是 Effect 中。

// Bad: effect re-runs on theme change
useEffect(() => {
  if (submitted) post("/api/register");
}, [submitted, theme]);

// Good: in handler
const handleSubmit = () => post("/api/register");
rerender-transitions - @rules/rerender-transitions.md

对非紧急更新使用 startTransition。

// Good: non-blocking scroll tracking
const handler = () => {
  startTransition(() => setScrollY(window.scrollY));
};
rerender-use-ref-transient-values - @rules/rerender-use-ref-transient-values.md

使用 ref 保存频繁变化的临时值。

// Good: no re-render, direct DOM update
const lastXRef = useRef(0);
const dotRef = useRef<HTMLDivElement>(null);

useEffect(() => {
  let onMove = (e) => {
    lastXRef.current = e.clientX;
    dotRef.current?.style.transform = `translateX(${e.clientX}px)`;
  };
  window.addEventListener("mousemove", onMove);
  return () => window.removeEventListener("mousemove", onMove);
}, []);
渲染性能(中)
rendering-conditional-render - @rules/rendering-conditional-render.md

条件判断涉及数字时,使用三元运算符,而不是 &&。

// Bad: renders "0" when count is 0
{
  count && <Badge>{count}</Badge>;
}

// Good: renders nothing when count is 0
{
  count > 0 ? <Badge>{count}</Badge> : null;
}
rendering-hoist-jsx - @rules/rendering-hoist-jsx.md

将静态 JSX 提取到组件外部。

// Good: reuses same element, especially for large SVGs
const skeleton = <div className="animate-pulse h-20 bg-gray-200" />;

function Container({ loading }) {
  return loading ? skeleton : <Content />;
}
rendering-content-visibility - @rules/rendering-content-visibility.md

对长列表使用 content-visibility。

.list-item {
  content-visibility: auto;
  contain-intrinsic-size: 0 80px;
}
rendering-animate-svg-wrapper - @rules/rendering-animate-svg-wrapper.md

为实现 GPU 加速,动画应作用于包装用的 div,而不是 SVG 元素。

// Good: hardware accelerated
<div className="animate-spin">
  <svg>...</svg>
</div>
rendering-svg-precision - @rules/rendering-svg-precision.md

使用 SVGO 降低 SVG 坐标精度。

npx svgo --precision=1 --multipass icon.svg
rendering-hydration-no-flicker - @rules/rendering-hydration-no-flicker.md

使用内联脚本处理仅客户端数据,以防止闪烁。

<div id="theme-wrapper">{children}</div>
<script dangerouslySetInnerHTML={{ __html: `
  var theme = localStorage.getItem('theme') || 'light';
  document.getElementById('theme-wrapper').className = theme;
` }} />
rendering-hydration-suppress-warning - @rules/rendering-hydration-suppress-warning.md

抑制预期会出现的水合不匹配警告。

<span suppressHydrationWarning>{new Date().toLocaleString()}</span>
rendering-client-only - @rules/rendering-client-only.md

使用 ClientOnly 和后备内容渲染仅限浏览器的组件。

<ClientOnly fallback={<Skeleton />}>
  {() => <Map />}
</ClientOnly>
rendering-use-hydrated - @rules/rendering-use-hydrated.md

对于 SSR/CSR 差异,使用 useHydrated。

let hydrated = useHydrated();
return hydrated ? <Widget /> : <Skeleton />;
rendering-usetransition-loading - @rules/rendering-usetransition-loading.md

优先使用 useTransition,而不是手动管理加载状态。

const [isPending, startTransition] = useTransition();

let handleSearch = (value) => {
  startTransition(async () => {
    let data = await fetchResults(value);
    setResults(data);
  });
};
fault-tolerant-error-boundaries - @rules/fault-tolerant-error-boundaries.md

在功能边界处设置错误边界。

<ErrorBoundary fallback={<SidebarError />}>
  <Sidebar />
</ErrorBoundary>
客户端模式(中)
client-passive-event-listeners - @rules/client-passive-event-listeners.md

滚动和触摸事件应使用被动监听器。

document.addEventListener("wheel", handler, { passive: true });
document.addEventListener("touchstart", handler, { passive: true });
client-localstorage-schema - @rules/client-localstorage-schema.md

为 localStorage 数据添加版本,并尽量精简。

const VERSION = "v2";

function saveConfig(config: Config) {
  try {
    localStorage.setItem(`config:${VERSION}`, JSON.stringify(config));
  } catch {} // Handle incognito/quota exceeded
}
Hooks(高优先级)
hooks-limit-useeffect - @rules/hooks-limit-useeffect.md

仅在绝对必要时使用 useEffect。优先使用派生状态或事件处理函数。

// Bad: useEffect to derive state
let [filtered, setFiltered] = useState(items);
useEffect(() => {
  setFiltered(items.filter((i) => i.active));
}, [items]);

// Good: derive during render
let filtered = items.filter((i) => i.active);

// Good: useMemo if expensive
let filtered = useMemo(() => items.filter((i) => i.active), [items]);
hooks-useeffect-named-functions - @rules/hooks-useeffect-named-functions.md

在 useEffect 中使用具名函数声明,以便更好地调试和自我说明。

// Bad: anonymous arrow function
useEffect(() => {
  document.title = title;
}, [title]);

// Good: named function
useEffect(
  function syncDocumentTitle() {
    document.title = title;
  },
  [title],
);

// Good: also name cleanup functions
useEffect(function subscribeToOnlineStatus() {
  window.addEventListener("online", handleOnline);
  return function unsubscribeFromOnlineStatus() {
    window.removeEventListener("online", handleOnline);
  };
}, []);
组合模式(高优先级)
composition-avoid-boolean-props - @rules/composition-avoid-boolean-props.md

不要添加布尔属性来自定义行为,应改用组合。

// Bad: boolean prop explosion
<Composer isThread isEditing={false} showAttachments />

// Good: explicit variants
<ThreadComposer channelId="abc" />
<EditComposer messageId="xyz" />
composition-compound-components - @rules/composition-compound-components.md

将复杂组件构建为共享上下文的复合组件。

// Good: compound components
<Composer.Provider state={state} actions={actions}>
  <Composer.Frame>
    <Composer.Input />
    <Composer.Footer>
      <Composer.Submit />
    </Composer.Footer>
  </Composer.Frame>
</Composer.Provider>
composition-state-provider - @rules/composition-state-provider.md

将状态提升到 Provider 组件中,以便跨组件访问。

// Good: state in provider, accessible anywhere inside
<ForwardMessageProvider>
  <Dialog>
    <Composer.Input />
    <MessagePreview /> {/* Can read state */}
    <ForwardButton /> {/* Can call submit */}
  </Dialog>
</ForwardMessageProvider>
composition-explicit-variants - @rules/composition-explicit-variants.md

创建明确的变体组件,而不是组合属性。

// Good: self-documenting variants
function ThreadComposer({ channelId }) {
  return (
    <ThreadProvider channelId={channelId}>
      <Composer.Frame>
        <Composer.Input />
        <AlsoSendToChannelField />
        <Composer.Submit />
      </Composer.Frame>
    </ThreadProvider>
  );
}
composition-children-over-render-props - @rules/composition-children-over-render-props.md

组合时优先使用 children。仅在需要传回数据时使用 render props。

// Good: children for structure
<Card>
  <Card.Header>Title</Card.Header>
  <Card.Body>Content</Card.Body>
</Card>

// OK: render props when passing data
<List renderItem={({ item }) => <Item {...item} />} />
composition-avoid-overabstraction - @rules/composition-avoid-overabstraction.md

避免使用僵化的配置属性;优先采用可组合的 children API。

<Select value="abc" onChange={...}>
  <Option value="abc">ABC</Option>
  <Option value="xyz">XYZ</Option>
</Select>
composition-typescript-namespaces - @rules/composition-typescript-namespaces.md

使用 TypeScript 命名空间将组件及其类型组合在一起,以便通过单次导入访问。

// components/button.tsx
export namespace Button {
  export type Variant = "solid" | "ghost" | "outline";
  export interface Props {
    variant?: Variant;
    children: React.ReactNode;
  }
}

export function Button({ variant = "solid", children }: Button.Props) {
  // ...
}

// Usage: single import
import { Button } from "~/components/button";

<Button variant="ghost">Click</Button>
function wrap(props: Button.Props) { ... }

**重要:**命名空间中只能包含类型,不能包含运行时代码。

评论

支持 Markdown