首页
/ Redux Toolkit 2.0 中 RTK Query 错误日志中间件的类型安全升级

Redux Toolkit 2.0 中 RTK Query 错误日志中间件的类型安全升级

2025-05-21 00:26:35作者:温艾琴Wonderful

背景

在 Redux Toolkit 1.9 版本中,开发者通常会使用一个错误日志中间件来处理 RTK Query 的全局错误。这个中间件通常会检查 action 是否被拒绝(rejected),并在满足条件时显示错误提示。在 1.9 版本中,这样的实现通常能够正常工作,即使类型标注可能并不完全准确。

问题发现

随着 Redux Toolkit 升级到 2.0 版本,类型系统变得更加严格。特别是,action 的类型从 Any 变为了 Unknown。这一变化暴露了之前版本中类型标注的问题。

在 1.9 版本中,开发者可能会这样定义中间件:

const rtkQueryErrorLogger: Middleware = (store: MiddlewareAPI) => (next) => (action: PayloadAction) => {
  // 处理逻辑
};

这种写法在 2.0 版本中会引发类型错误,因为现在 action 的类型默认为 unknown,而不是开发者假设的 PayloadAction

类型安全的重要性

Redux Toolkit 2.0 的这一改变是为了提高类型安全性。在 Redux 生态系统中,action 可以是任何类型,因此假设它为特定类型(如 PayloadAction)是不安全的。通过将默认类型设为 unknown,TypeScript 会强制开发者在处理 action 前进行适当的类型检查。

正确的实现方式

在 2.0 版本中,正确的做法是:

  1. 移除对 PayloadAction 的假设性类型标注
  2. 使用类型守卫来安全地检查 action 的类型

例如:

const rtkQueryErrorLogger: Middleware = (store: MiddlewareAPI) => (next) => (action) => {
  if (isRejectedWithValue(action)) {
    // 现在可以安全地访问 action.payload
    toast.error(action.payload);
  }
  return next(action);
};

或者,如果需要更严格的类型检查:

const rtkQueryErrorLogger: Middleware = (store: MiddlewareAPI) => (next) => (action: unknown) => {
  if (isRejectedWithValue(action) && isPayloadAction(action)) {
    // 双重类型检查后安全处理
    toast.error(action.payload);
  }
  return next(action);
};

迁移建议

对于从 1.9 升级到 2.0 的开发者:

  1. 检查所有中间件中对 action 的类型假设
  2. 移除不必要的类型标注
  3. 添加适当的类型守卫
  4. 利用 TypeScript 的严格模式来捕获潜在的类型问题

总结

Redux Toolkit 2.0 对类型的强化是一个积极的改进,虽然它可能导致一些现有代码需要调整,但最终会带来更好的类型安全和更健壮的代码。开发者应该拥抱这一变化,并借此机会审查和改进自己的类型定义。

记住,在 Redux 中间件中,action 本质上是动态的,因此使用 unknown 类型并配合类型守卫是最安全、最符合 Redux 哲学的做法。

登录后查看全文
热门项目推荐
相关项目推荐