Redux Toolkit 中自定义 MutationExtraOptions 的类型扩展实践

背景介绍

在使用 Redux Toolkit Query (RTK Query) 进行 API 状态管理时，开发者有时需要扩展默认的 mutation 配置选项。本文探讨了如何在 RTK Query 中安全地扩展 MutationExtraOptions 类型，以实现自定义功能如乐观更新(optimistic updates)和自动保存(auto-save)等高级特性。

问题分析

在 Redux Toolkit 2.2.5 版本中，开发者可以通过类型声明合并(declaration merging)来扩展 MutationExtraOptions 接口。但随着版本升级到 2.3.0，原有的类型扩展方式不再适用，导致类型检查失败。

核心问题在于：

1. 内部类型路径变更（@reduxjs/toolkit/dist/query/endpointDefinitions 变为非公开API）
2. 类型导出策略调整
3. 模块声明位置变化

解决方案

正确的类型扩展方式

在最新版本中，应使用以下方式扩展 MutationExtraOptions：

declare module '@reduxjs/toolkit/query' {
  interface MutationExtraOptions<
    TagTypes extends string,
    ResultType,
    QueryArg,
    BaseQuery extends BaseQueryFn,
    ReducerPath extends string = string
  > {
    optimisticUpdates?: OptimisticUpdateFuncType<QueryArg>[];
    optimisticUpserts?: OptimisticUpdateFuncType<QueryArg>[];
  }
}

实现自动保存功能

基于扩展的类型，可以实现自动保存功能的核心逻辑：

1. 防抖处理：使用 useDebounce 实现输入防抖
2. 乐观更新：在请求发送前先更新本地状态
3. 错误回滚：请求失败时撤销本地变更

function useAutosave({ data, onSave, interval = 2000 }) {
  const valueOnCleanup = useRef(data);
  const debouncedValue = useDebounce(data, interval);

  useEffect(() => {
    if (!initialRender.current) {
      onSave(valueOnCleanup.current);
    }
  }, [debouncedValue]);

  // 其他实现细节...
}

API 端点配置示例

在 API 端点定义中使用自定义选项：

setContact: builder.mutation({
  query: (data) => ({ /* 请求配置 */ }),
  optimisticUpdates: [
    ({ id, ...patch }) => [
      'getContact', 
      { id },
      (draft) => ({ ...draft, ...patch })
    ]
  ],
  // 其他配置...
})

最佳实践建议

1. 避免依赖内部路径：所有位于 /dist/ 下的路径都应视为内部实现，可能随时变更
2. 类型安全扩展：始终通过模块声明合并来扩展类型，而非直接修改
3. 版本兼容性：重大功能变更应考虑提供迁移路径或文档说明
4. 错误处理：乐观更新必须配套完善的错误回滚机制

总结

通过合理扩展 RTK Query 的类型系统，开发者可以实现强大的自定义功能，如自动保存和乐观更新。关键在于：

1. 使用正确的模块声明路径
2. 遵循类型扩展的最佳实践
3. 实现完整的错误处理流程
4. 避免依赖不稳定的内部实现

这种模式不仅适用于讨论的自动保存场景，也可应用于其他需要扩展 RTK Query 默认行为的场景。