Redux Toolkit中RTK Query自定义Mutation Hook的封装实践

背景介绍

Redux Toolkit（RTK）是Redux官方推荐的工具集，其中RTK Query是其内置的数据获取和缓存解决方案。在开发过程中，我们经常需要对基础的Mutation Hook进行二次封装，以满足项目的统一错误处理、日志记录等需求。

问题演变

在RTK Query的早期版本中，开发者可以直接导入UseMutation类型来创建自定义的Mutation Hook封装器。这种封装方式允许开发者对原始的Mutation Hook进行包装，添加额外的逻辑如错误处理等。

然而，随着RTK Query的版本更新，官方移除了直接导出UseMutation类型的做法，转而提供了更加用户友好的TypedUseMutation辅助类型。这一变化虽然提高了类型安全性，但也导致了一些基于旧版本实现的代码需要相应调整。

解决方案

新的TypedUseMutation类型提供了更直观的类型参数，使得封装Mutation Hook变得更加清晰。下面是实现自定义Mutation Hook封装器的现代方法：

import { useCallback } from 'react';
import type { SerializedError } from '@reduxjs/toolkit';
import type { BaseQueryFn, TypedUseMutation } from '@reduxjs/toolkit/query/react';
import type { GraphQLError } from 'graphql/error/GraphQLError';

export const useWrappedMutation = <ResultType, BaseQuery extends BaseQueryFn, QueryArg>(
  useMutation: TypedUseMutation<ResultType, QueryArg, BaseQuery>,
  {
    onError,
  }: {
    onError?: (error: GraphQLError | SerializedError) => void;
  }
) => {
  const [mutate, status] = useMutation();

  const handleMutate = useCallback(
    (args: QueryArg) => mutate(args),
    [mutate, onError]
  );

  return [handleMutate, status] as const;
};

实现解析

1. 类型参数：

   • ResultType：表示Mutation操作返回的数据类型
   • BaseQuery：扩展自BaseQueryFn，表示基础查询函数类型
   • QueryArg：表示Mutation操作接受的参数类型

2. 核心逻辑：

   • 接收原始的useMutation hook作为参数
   • 返回一个新的元组，包含处理过的mutate函数和原始状态
   • 使用useCallback优化性能，避免不必要的重新创建

3. 错误处理：

   • 通过onError回调参数提供统一的错误处理机制
   • 支持处理GraphQL错误和序列化错误

使用示例

在实际项目中，我们可以这样使用封装后的Hook：

// 定义API端点
const api = createApi({
  // ...配置
  endpoints: (builder) => ({
    updateUser: builder.mutation<User, UpdateUserPayload>({
      query: (payload) => ({ /* ... */ }),
    }),
  }),
});

// 使用封装Hook
const [updateUser, { isLoading }] = useWrappedMutation(api.useUpdateUserMutation, {
  onError: (error) => {
    // 统一错误处理逻辑
    showErrorToast(error.message);
  },
});

// 在组件中使用
const handleSubmit = () => {
  updateUser({ id: 1, name: 'New Name' });
};

最佳实践

1. 类型安全：确保所有类型参数都正确传递，以获得完整的类型推断
2. 性能优化：合理使用useCallback避免不必要的函数重建
3. 错误处理：在封装层实现统一的错误处理逻辑，避免在每个Mutation中重复
4. 可扩展性：设计封装器时考虑未来可能添加的功能，如loading状态处理、成功回调等

总结

通过使用RTK Query提供的TypedUseMutation类型，我们可以构建类型安全且功能强大的自定义Mutation Hook封装器。这种方法不仅保持了RTK Query的强类型优势，还能在项目层面实现统一的逻辑处理，提高代码的可维护性和一致性。随着RTK Query的持续发展，建议开发者关注官方文档，及时调整实现方式以适应API的变化。