You need to enable JavaScript to run this app. 如何基于现有useSWR封装实现适配Axios与TypeScript的useSWRInfinite?
优惠活动
大模型
产品
解决方案
定价
更多

如何基于现有useSWR封装实现适配Axios与TypeScript的useSWRInfinite?

适配Axios与TypeScript的useSWRInfinite封装实现

完整封装代码

import useSWRInfinite, { SWRInfiniteConfiguration, SWRInfiniteResponse } from 'swr/infinite'
import axios, { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios'

// 沿用原有请求类型定义
export type GetRequest = AxiosRequestConfig | null

// 分页Key生成函数类型:传入当前页码、上一页响应数据,返回当前页的请求配置
export type GetRequestKey<Data> = (
  pageIndex: number,
  previousPageData: AxiosResponse<Data> | null
) => GetRequest

// 封装返回值类型,兼容原有useRequest使用习惯
interface InfiniteReturn<Data, Error>
  extends Pick<
    SWRInfiniteResponse<AxiosResponse<Data>, AxiosError<Error>>,
    'isValidating' | 'revalidate' | 'error' | 'mutate' | 'size' | 'setSize'
  > {
  // 业务数据数组,每一项对应一页的接口返回数据
  data: Data[] | undefined
  // 完整Axios响应数组,每一项对应一页的完整响应对象
  responses: AxiosResponse<Data>[] | undefined
}

// 配置类型
export interface InfiniteConfig<Data = unknown, Error = unknown>
  extends Omit<
    SWRInfiniteConfiguration<AxiosResponse<Data>, AxiosError<Error>>,
    'initialData'
  > {
  // 初始业务数据数组,无需手动包装Axios响应结构
  initialData?: Data[]
}

export default function useInfiniteRequest<Data = unknown, Error = unknown>(
  getKey: GetRequestKey<Data>,
  { initialData, ...config }: InfiniteConfig<Data, Error> = {}
): InfiniteReturn<Data, Error> {
  const { 
    data: responses, 
    error, 
    isValidating, 
    revalidate, 
    mutate, 
    size, 
    setSize 
  } = useSWRInfinite<AxiosResponse<Data>, AxiosError<Error>>(
    // 序列化请求配置作为缓存key
    (pageIndex, previousPageData) => {
      const request = getKey(pageIndex, previousPageData)
      return request ? JSON.stringify(request) : null
    },
    // 反序列化key发起请求
    (key) => {
      const request = JSON.parse(key) as AxiosRequestConfig
      return axios(request)
    },
    {
      ...config,
      // 初始数据自动包装为Axios响应结构,和原有useRequest逻辑对齐
      initialData: initialData?.map(item => ({
        status: 200,
        statusText: 'InitialData',
        config: {},
        headers: {},
        data: item
      }))
    }
  )

  return {
    data: responses?.map(res => res.data),
    responses,
    error,
    isValidating,
    revalidate,
    mutate,
    size,
    setSize
  }
}

核心逻辑说明

  • 类型完全对齐原有useRequest的Axios相关定义,同时兼容useSWRInfinite特有的分页属性size/setSize,全程类型安全
  • 分页请求配置由传入的getKey函数生成,可根据上一页数据判断是否还有更多页,返回null即可终止后续分页请求
  • 初始数据处理逻辑和原有useRequest完全一致,只需传入业务数据数组即可,无需手动构造Axios响应结构
  • 返回值和原有useRequest使用习惯保持一致,直接暴露业务数据数组,同时保留所有useSWRInfinite原生方法

使用示例

// 定义业务数据类型
interface Article {
  id: number
  title: string
  createTime: string
}

// 分页获取文章列表
const { 
  data: articleList, 
  size, 
  setSize, 
  isValidating, 
  error 
} = useInfiniteRequest<Article>(
  (pageIndex, previousPageData) => {
    // 上一页返回空数组说明已经到最后一页,停止请求
    if (previousPageData && previousPageData.data.length === 0) return null
    return {
      url: '/api/article/list',
      method: 'get',
      params: {
        page: pageIndex + 1,
        pageSize: 10
      }
    }
  },
  {
    // 可选配置:传入初始第一页数据
    initialData: [
      { id: 1, title: "示例文章", createTime: "2024-01-01" }
    ],
    revalidateFirstPage: false
  }
)

内容的提问来源于stack exchange,提问作者Bryan Lumbantobing

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.12 20:03:04