使用@reduxjs/toolkit简化redux代码

序言

在平时写业务代码的时候,使用redux经常会遇到一些问题:

  • 状态管理代码分散在action,constant,reducer三个文件中
  • 定位问题路径较长,经常需要使用ctrl+f查找action->constant->reducer
  • action和reducer中代码重复度较高,充斥了大量的样版代码
  • 使用typescript时,需要自己定义大量类型

这个时候就会想,能不能对redux进行一定程度的封装,优化文件结构,来去掉这些样版代码,只保留核心的业务逻辑,这样在写代码和查找问题的时候代码都会清晰很多。偶然在网上看到了redux官方提供的Redux Toolkit,这个就是我想要的工具库。

概述

Redux Toolkit对redux的api进行了封装,提供了一种书写redux逻辑的标准,它是为了帮助解决有关Redux的三个常见问题而创建的:

  • 配置redux store太麻烦
  • 需要添加一系列redux全家桶才能实现业务
  • redux需要大量样版代码

使用步骤

1. 安装

npm install @reduxjs/toolkit react-redux

2. 创建redux store

在根组件中,使用configureStore配置store,支持配置redux中间件,默认它会启用Redux DevTools Extension,和添加redux-thunk,检查状态改变,检查使用不可序列化值的中间件

// app.tsx
import { configureStore } from "@reduxjs/toolkit";
import reducer from "./slices";

const store = configureStore({
      reducer: reducer,
      devTools: __DEV__,
      middleware: getDefaultMiddleware => {
        return getDefaultMiddleware({
          // serializableCheck: false
        });
      }
    });

在这里配置,仅在开发模式下启用Redux DevTools Extension

3. 创建redux slice

slice是redux toolkit定义的一个概念,就是一系列相关数据的状态管理,包含action,state,reducer三个部分,在页面较简单时,可以认为每个页面的状态就是一个slice;在页面较复杂时,可以把一些相关状态放在一个slice中。

使用createSlice,可以基于reducer函数自动生成对应的action creator,例如这里用redux实现一个显示、隐藏对话框的功能:

import { createSlice } from "@reduxjs/toolkit"

const slice = createSlice({
  name: "home",
  initialState: {
    isShowModal: false
  },
  reducers: {
    showModal(state) {
      state.isShowModal = true;
    },
    hideModal(state) {
      state.isShowModal = false
    }
  }
});

export const { showModal, hideModal } = slice.actions;
export default slice.reducer;

其中,

  • toolkit默认对reducer函数使用了immer,在reducer函数中我们可以直接修改state,immer会帮我们创建一个新的对象
  • 根据我们写的showModal和hideModal两个reducer函数,createSlice生成了对应的action creator,他们会返回对应的action对象
  • 从slice的reducer属性中,可以获取到完整的reducer函数,默认导出后可以用于创建store

4. 执行异步请求

使用createAsyncThunk可以执行异步请求,返回一个请求结果的Promise对象,最后在reducer中,对不同的请求结果做不同的处理,例如,请求一个活动接口:

import { createAsyncThunk, createSlice } from "@reduxjs/toolkit";

export const getActivity = createAsyncThunk("home/getActivity", async (param, thunk) => {
  try {
    const res = await ajax({
      data: {
        uAnchorId: getAnchorId(),
        uActivityId: getActivityId()
      }
    });
    return res;
  } catch (error) {
    thunk.dispatch(
      Toast.showToast({
        text: "加载活动信息失败,请稍后重试"
      })
    );
    throw error;
  }
});

const homeSlice = createSlice({
  name: "home",
  initialState: {
    activity: null
  },
  reducers: {},
  extraReducers: builder => {
    builder.addCase(getActivity.fulfilled, (state, action) => {
      // success
      const data = action.payload;
      state.activity = data;
    });

    builder.addCase(getActivity.rejected, (state, action) => {
      // fail
    });
  }
});

其中,

  • createAsyncThunk会提供一个thunk对象,可以使用它的dispatch方法将请求的结果转发给其他的reducer处理
  • 在extraReducers中可以对请求结果的成功失败,做不同的处理

5. 其他

toolkit还提供了createReducer,createAction,createSelector等api,这里平时用得比较少,就不多做介绍了,这里只是抛砖引玉,感兴趣强烈建议去官网查看原文:https://redux-toolkit.js.org/

常见问题

  • A non-serializable value was detected in an action, in the path: payload
    这个是因为immer只能处理可序列化的简单对象,不能处理类的实例,如果你的action.payload是一个类的实例,就会出现这个警告。这里就需要对action.payload进行浅拷贝将它转化为一个简单对象。我们业务中的action.payload实际情况比较复杂,所以先关掉了serializableCheck检查,后面再优化这里的逻辑

总结

使用toolkit可以大幅提高开发体验,和react hook以及typescript搭配起来使用更佳,官网的文档也写得相当详细,目前已经在k歌十几个大型hippy项目中投入使用,大家也可以在项目中尝试使用

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 224,242评论 6 522
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 95,953评论 3 402
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 171,299评论 0 366
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 60,709评论 1 300
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 69,723评论 6 399
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,236评论 1 314
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,629评论 3 428
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,594评论 0 279
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,135评论 1 324
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,156评论 3 345
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,285评论 1 354
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,914评论 5 350
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,600评论 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,073评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,203评论 1 275
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,798评论 3 381
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,339评论 2 365