Redux Toolkit中如何正确定义和使用TypedUseQuery类型

在Redux Toolkit项目开发中，我们经常需要封装统一的API调用接口，以便在不同应用间共享组件。本文将深入探讨如何正确使用TypedUseQuery类型来定义统一的查询钩子接口。

问题背景

当我们需要在多个应用间共享使用Redux Toolkit Query的组件时，常常会遇到一个需求：组件需要调用API，但具体的API实现可能因应用而异。这时就需要定义一个统一的接口类型，让组件不关心具体实现，而由各个应用自行提供符合规范的实现。

错误示范

初学者可能会尝试这样定义和使用TypedUseQuery类型：

import {FetchArgs, BaseQueryFn} from '@reduxjs/toolkit/query';
import {TypedUseQuery} from '@reduxjs/toolkit/query/react';

export type UseFetchingType = TypedUseQuery<JSONValue, FetchArgs, BaseQueryFn>;

// 错误的实现方式
export const defaultUseFetching: UseFetchingType = () => ({
    data: undefined,
    error: undefined,
    isUninitialized: true,
    isLoading: false,
    isFetching: false,
    isSuccess: false,
    isError: false,
    refetch: () => {},
});

这种写法会导致TypeScript报错，因为TypedUseQuery类型实际上是一个复杂的泛型类型，它需要考虑selectFromResult等选项，而简单的返回固定值对象并不符合其类型约束。

正确实现方式

正确的做法是使用Redux Toolkit Query实际生成的查询钩子来赋值：

// 首先创建API切片
export const apiSlice = createApi({
    reducerPath: 'api',
    baseQuery: autoBaseQueryWithReAuth,
    endpoints: _builder => ({}),
});

// 然后注入具体端点
const slice = apiSlice.injectEndpoints({
    endpoints: builder => ({
        generalFetching: builder.query<JSONValue, string | FetchArgs>({
            query: args => 
                typeof args === 'object'
                    ? {
                          ...args,
                          method: args.method ?? 'GET',
                          params: {rid: crypto.randomUUID(), ...args.params},
                      }
                    : {
                          url: args,
                          method: 'GET',
                          params: {rid: crypto.randomUUID()},
                      },
            transformResponse: (rawResult) => rawResult.data!,
        }),
    }),
});

// 获取生成的查询钩子
const {useGeneralFetchingQuery} = slice;

// 这才是正确的赋值方式
const defaultUseFetching: UseFetchingType = useGeneralFetchingQuery;

类型定义解析

让我们仔细看看TypedUseQuery的类型定义：

type UseFetchingType = TypedUseQuery<ResultType, QueryArg, BaseQuery>;

其中三个泛型参数分别代表：

1. ResultType: 查询结果的类型
2. QueryArg: 查询参数的类型，可以是字符串或FetchArgs对象
3. BaseQuery: 基础查询函数的类型

架构设计建议

在实际项目中，推荐采用以下架构设计：

1. 定义统一的接口类型（UseFetchingType）
2. 组件层只依赖接口类型，不关心具体实现
3. 每个应用提供自己的实现，注入到组件中
4. 组件在不同应用中运行时，会自动使用对应的API实现

这种设计模式很好地遵循了依赖倒置原则，使组件与具体实现解耦，提高了代码的可复用性和可维护性。

总结

正确使用Redux Toolkit的TypedUseQuery类型需要注意以下几点：

1. TypedUseQuery是一个复杂的泛型类型，不能简单地用固定返回值来模拟
2. 应该使用createApi和injectEndpoints生成的真实查询钩子
3. 类型参数需要正确定义结果类型、查询参数类型和基础查询类型
4. 这种类型定义方式非常适合在需要统一接口的多应用场景中使用

通过本文的介绍，希望读者能够掌握在Redux Toolkit项目中正确定义和使用TypedUseQuery类型的方法，构建出更加灵活、可复用的前端架构。