Community编程与开发github.com

react-data-hook

在 React + TypeScript 组件中获取服务器数据时使用——编写或审查自定义数据获取 hook,包含类型化响应、加载/错误状态、请求取消以及卸载后不更新状态,或替代临时的 useEffect + fetch。触发关键词包括:“在 React 中获取数据”、“useEffect fetch”、“加载状态”、“自定义 hook”、“组件中的 API 调用”、“useFetch”、“fetch 中的竞态条件”、“卸载时取消请求”。

react-data-hook 是什么?

这是一个面向 React 开发者的技能,指导如何正确地在 React 组件中获取服务器数据:通过自定义 hook 封装 fetch 逻辑,确保数据获取是类型化、可取消的,并且始终处理加载和错误状态。核心原则包括:将数据获取逻辑放入 hook 而非组件中;使用判别联合类型明确建模 loading、error 和 data 三种状态;利用 AbortController 在组件卸载或输入变化时取消正在进行中的请求,避免竞态条件;强类型响应数据,杜绝 any 类型。技能提供了零依赖的基础 useFetch 实现,并建议在已有 TanStack Query 或 SWR 的项目中优先使用这些成熟库而非手写。它还能帮助避免常见错误,如未处理加载/错误状态、依赖数组不稳定、fetch 不检查非 2xx 响应等。该技能适用于任何使用 React + TypeScript 的项目,尤其推荐给希望建立稳健数据获取模式、减少组件 bug 的开发者。

兼容平台~Claude Code~Codex CLI~Cursor
Part ofReact
npx skills add https://github.com/karthik1210100/agent-skills/tree/main/skills/react-data-hook

Installed? Explore more 编程与开发 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

React 数据 Hook

一个以正确方式在 React 中获取服务器数据的攻略:类型化、可取消,并始终处理加载和错误状态。

原则

  • 组件应该渲染状态,而不是编排获取请求。将 fetch 放入 hook 中,让组件保持声明式。
  • 始终建模三种状态——loading、error、data。永远不要假定请求已成功。
  • 当组件卸载或输入变化时,取消正在进行的请求。一个滞后的响应更新了已卸载或过时 UI 是一个真正的 bug(闪烁、数据错误、React 警告),而不是理论上的问题。
  • 为响应数据指定类型。一个返回 any 的 hook 只是将 bug 推向了下游。

首先:当项目已有数据层库时优先使用

如果项目已经使用了 TanStack Query (React Query) 或 SWR,请直接使用它们——不要在它们旁边手写获取逻辑。它们免费提供了缓存、去重、重试和取消能力:

const { data, isLoading, error } = useQuery({
  queryKey: ["article", id],
  queryFn: ({ signal }) => fetchArticle(id, signal),
});

仅当项目没有数据层并且你不想添加一个时才构建下面的 hook。

基础类型化 hook(零依赖)

// useFetch.ts
import { useEffect, useState } from "react";

type State<T> =
  | { status: "loading"; data: null; error: null }
  | { status: "success"; data: T; error: null }
  | { status: "error"; data: null; error: Error };

export function useFetch<T>(url: string, init?: RequestInit): State<T> {
  const [state, setState] = useState<State<T>>({
    status: "loading",
    data: null,
    error: null,
  });

  useEffect(() => {
    const controller = new AbortController();
    setState({ status: "loading", data: null, error: null });

    fetch(url, { ...init, signal: controller.signal })
      .then(async (res) => {
        if (!res.ok) throw new Error(`Request failed: ${res.status}`);
        return (await res.json()) as T;
      })
      .then((data) => setState({ status: "success", data, error: null }))
      .catch((err: unknown) => {
        if (err instanceof DOMException && err.name === "AbortError") return; // 预期行为
        setState({
          status: "error",
          data: null,
          error: err instanceof Error ? err : new Error(String(err)),
        });
      });

    return () => controller.abort(); // 卸载或 url 变化时取消
  }, [url]); // 仅当请求标识变化时重新执行

  return state;
}

为什么这是正确的:

  • 判别联合类型使非法状态不可表示——在 loading 状态下无法读取 data。
  • AbortController 加上清理函数取消前一个请求后再启动新请求,消除了经典竞态问题(响应以错误顺序返回)。
  • AbortError 分支保持静默,因此正常的取消永远不会触发错误闪现。

使用它——渲染所有三种状态

function Article({ id }: { id: string }) {
  const result = useFetch<ArticleDto>(`/api/v1/articles/${id}`);

  if (result.status === "loading") return <Spinner aria-label="正在加载文章" />;
  if (result.status === "error") return <ErrorBanner message={result.error.message} />;

  return <ArticleView article={result.data} />;
}

渲染加载和错误分支并非可选的装饰——它是空白屏幕与可用界面之间的区别。

该技能可预防的常见错误

  • useEffect(() => { fetch(url).then(r => r.json()).then(setData) }, [])——没有加载状态、没有错误处理、没有取消,并且 [] 忽略了变化的 url。
  • 将非稳定值(对象/数组字面量、内联的 init)放入依赖数组,导致无限重新请求循环。对它们进行记忆化或依赖原始类型。
  • 卸载后 setData 仍然触发。清理函数 abort() 使得延迟的 .then 在 AbortError 上短路。
  • 吞掉非 2xx 响应——fetch 仅在网络故障时拒绝,因此你必须自己检查 res.ok。

在宣布完成前的检查清单

  • 数据获取逻辑位于 hook 中;组件仅读取状态。
  • 加载、错误和数据状态都被涵盖并在渲染中体现。
  • 响应数据有类型(无 any);非 2xx 状态被转化为错误。
  • 使用 AbortController 在卸载和输入变化时取消请求。
  • 依赖数组只包含定义请求的稳定值。
  • 如果项目使用了 React Query / SWR,优先使用它们而非此 hook。

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

相关技能