Project Icon

redux-toolkit

简化Redux开发的标准工具库

Redux Toolkit是Redux官方推荐的标准工具库,旨在简化Redux配置和减少样板代码。它提供了configureStore、createReducer、createAction等API,以及RTK Query数据获取和缓存功能。通过抽象设置过程和处理常见用例,Redux Toolkit使开发者能更轻松地编写Redux逻辑,提升开发效率。该工具库适用于大多数Redux项目,有助于解决配置复杂、依赖包过多和代码冗余等常见问题。Redux Toolkit特别适合快速搭建新项目或重构现有Redux应用。它的RTK Query功能可以显著减少手动编写数据获取逻辑的需求,对于构建数据密集型应用尤其有价值。

Redux Toolkit

GitHub 工作流状态 npm 版本 npm 下载量

官方的、有主见的、包含所有必要功能的高效 Redux 开发工具集

安装

创建 React Redux 应用

使用 React 和 Redux Toolkit 开始新应用的推荐方式是使用我们官方的 Redux Toolkit + TS 的 Vite 模板,或者使用 Next.js 的 with-redux 模板创建新的 Next.js 项目。

这两种方式都已经为相应的构建工具正确配置了 Redux Toolkit 和 React-Redux,并附带一个小型示例应用,演示了如何使用 Redux Toolkit 的几个特性。

# 使用我们的 Redux+TS 模板的 Vite
# (使用 `degit` 工具克隆并提取模板)
npx degit reduxjs/redux-templates/packages/vite-template-redux my-app

# 使用 `with-redux` 模板的 Next.js
npx create-next-app --example with-redux my-app

我们目前没有官方的 React Native 模板,但推荐以下模板用于标准 React Native 和 Expo:

现有应用

Redux Toolkit 可以作为 NPM 包在模块打包器或 Node 应用中使用:

# NPM
npm install @reduxjs/toolkit

# Yarn
yarn add @reduxjs/toolkit

该包包含一个预编译的 ESM 构建,可以直接在浏览器中作为 <script type="module"> 标签使用。

文档

Redux Toolkit 的文档可在 https://redux-toolkit.js.org 获取,包括 API 参考和 Redux Toolkit 所有 API 的使用指南。

Redux 核心文档 https://redux.js.org 包含完整的 Redux 教程,以及一般 Redux 模式的使用指南。

目的

Redux Toolkit 包旨在成为编写 Redux 逻辑的标准方式。它最初的创建是为了解决关于 Redux 的三个常见问题:

  • "配置 Redux store 太复杂"
  • "我需要添加很多包才能让 Redux 做一些有用的事情"
  • "Redux 需要太多样板代码"

我们无法解决每个用例,但本着 create-react-app 的精神,我们可以尝试提供一些工具,抽象设置过程并处理最常见的用例,同时包含一些有用的实用工具,让用户可以简化他们的应用代码。

因此,这个包的范围是有意限制的。它不涉及"可重用的封装 Redux 模块"、文件夹或文件结构、管理 store 中的实体关系等概念。

Redux Toolkit 还包括一个强大的数据获取和缓存功能,我们称之为"RTK Query"。它作为一组单独的入口点包含在包中。它是可选的,但可以消除自己手写数据获取逻辑的需求。

包含内容

Redux Toolkit 包括以下 API:

  • configureStore():包装 createStore 以提供简化的配置选项和良好的默认值。它可以自动组合你的 slice reducer,添加你提供的任何 Redux 中间件,默认包含 redux-thunk,并启用 Redux DevTools Extension 的使用。
  • createReducer():让你提供一个 action 类型到 case reducer 函数的查找表,而不是编写 switch 语句。此外,它自动使用 immer,让你可以使用普通的可变代码编写更简单的不可变更新,如 state.todos[3].completed = true
  • createAction():为给定的 action 类型字符串生成一个 action creator 函数。该函数本身定义了 toString(),因此可以用来替代类型常量。
  • createSlice():结合了 createReducer() + createAction()。接受一个 reducer 函数对象、slice 名称和初始状态值,并自动生成相应的 action creator 和 action 类型的 slice reducer。
  • combineSlices():将多个 slice 组合成一个单一的 reducer,并允许在初始化后"懒加载"slice。
  • createListenerMiddleware():让你定义包含额外逻辑的"效果"回调的"监听器"条目,以及基于派发的 action 或状态变化指定该回调何时运行的方式。这是 Redux 异步中间件(如 sagas 和 observables)的轻量级替代方案。
  • createAsyncThunk():接受一个 action 类型字符串和一个返回 promise 的函数,并生成一个基于该 promise 派发 pending/resolved/rejected action 类型的 thunk。
  • createEntityAdapter():生成一组可重用的 reducer 和选择器,用于管理 store 中的规范化数据。
  • Reselect 库重新导出的 createSelector() 实用函数,以便使用。

详情请参阅文档中的 Redux Toolkit API 参考部分

RTK Query

RTK Query 作为 @reduxjs/toolkit 包中的可选附加组件提供。它专门用于解决数据获取和缓存的用例,提供了一个紧凑但功能强大的工具集,用于为你的应用定义 API 接口层。它旨在简化 Web 应用中加载数据的常见情况,消除了自己手写数据获取和缓存逻辑的需求。

RTK Query 基于 Redux Toolkit 核心构建,在其实现中使用 Redux。虽然使用 RTK Query 不需要了解 Redux 和 RTK,但你应该探索它们提供的所有额外的全局 store 管理功能,并安装 Redux DevTools 浏览器扩展,它与 RTK Query 完美配合,可以遍历和重放请求和缓存行为的时间线。

RTK Query 包含在核心 Redux Toolkit 包的安装中。它可以通过以下两个入口点之一使用:

import { createApi } from '@reduxjs/toolkit/query'

/* React 特定的入口点,自动生成
   与定义的端点对应的 hooks */
import { createApi } from '@reduxjs/toolkit/query/react'

包含内容

RTK Query 包括以下 API:

  • createApi():RTK Query 功能的核心。它允许你定义一组端点,描述如何从一系列端点检索数据,包括如何获取和转换数据的配置。在大多数情况下,你应该在每个应用中使用一次,以"每个基本 URL 一个 API slice"为经验法则。
  • fetchBaseQuery():fetch 的小型包装器,旨在简化请求。作为大多数用户在 createApi 中使用的推荐 baseQuery。
  • <ApiProvider />:如果你还没有 Redux store,可以用作 Provider。
  • setupListeners():用于启用 refetchOnMount 和 refetchOnReconnect 行为的实用工具。

有关 RTK Query 是什么、它解决了哪些问题以及如何使用它的更多详细信息,请参阅 RTK Query 概述 页面。

贡献

请参阅我们的贡献指南,了解我们的开发流程、如何提出 bug 修复和改进建议,以及如何构建和测试你对 Redux Toolkit 的更改。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号