Skip to Content

useRequest

Hook gọi một hàm bất đồng bộ khi component hiện ra và giữ data, loading, error để vẽ giao diện.

Cách dùng

app/orders/[id]/page.tsx
import { useParams } from "react-router-dom"; import { Card, Skeleton } from "antd"; import { useApiClient } from "app/api"; import { useRequest } from "app/hooks"; export default function OrderPage() { const { id } = useParams(); const api = useApiClient(); const { data, loading } = useRequest(() => api.orders.detail(Number(id)), { refreshDeps: [id], // id đổi thì gọi lại }); if (loading) return <Skeleton active />; return <Card title={`Đơn ${data?.id}`}>{data?.customerName}</Card>; }

Chữ ký

app/hooks.ts
function useRequest<T>( service: (...args: any[]) => Promise<T>, options?: { manual?: boolean; defaultData?: T; refreshDeps?: unknown[]; onSuccess?: (data: T) => void; onError?: (error: Error) => void; }, ): { data: T | undefined; loading: boolean; error: Error | undefined; run: (...args: any[]) => Promise<T>; refresh: () => Promise<T>; mutate: (next: T | undefined | ((prev: T | undefined) => T | undefined)) => void; };

Tham số

  • service: hàm trả Promise, thường là một hàm của useApiClient.
  • options.manual: true thì không tự gọi khi component hiện ra; bạn gọi run().
  • options.defaultData: giá trị của data trước lần gọi đầu.
  • options.refreshDeps: danh sách giá trị; một giá trị đổi thì hook gọi lại service.
  • options.onSuccess: chạy với kết quả sau mỗi lần gọi thành công.
  • options.onError: chạy với lỗi sau mỗi lần gọi hỏng.

Chỉ có năm tuỳ chọn trên. Không có pollingInterval, debounceWait, cacheKey, ready hay retryCount.

Trả về

  • data: kết quả lần gọi thành công gần nhất.
  • loading: true khi đang gọi. Lúc đầu là true, trừ khi manual: true.
  • error: lỗi lần gọi gần nhất, hoặc undefined.
  • run(...args): gọi service với các tham số này. Trả kết quả; khi lỗi thì ném lại lỗi sau khi gọi onError.
  • refresh(): gọi lại với tham số của lần run trước.
  • mutate(next): thay data tại chỗ, không gọi server. Nhận giá trị mới hoặc hàm (prev) => next.

Lần gọi tự động khi component hiện ra không ném lỗi ra ngoài; đọc error để biết.

Trang công khai được dựng sẵn HTML lúc deploy: lần gọi tự động chạy một lần khi dựng, nên HTML đã có dữ liệu. Trong trình duyệt, hook bắt đầu từ dữ liệu đó (không hiện trạng thái đang tải) rồi lặng lẽ tải lại.

Ví dụ

Tải lại mỗi 30 giây:

app/dashboard/page.tsx
const { data, refresh } = useRequest(() => api.reports.today()); useEffect(() => { const t = setInterval(refresh, 30_000); return () => clearInterval(t); }, [refresh]);

Tìm khi gõ: trễ giá trị ô nhập rồi đưa giá trị đã trễ vào refreshDeps.

Không import useRequest từ ahooks: gói này không có trong danh sách cho phép, typecheck sẽ báo lỗi.

Bước tiếp theo

Cập nhật