React?TypeScript?應用中便捷使用Redux?Toolkit方法詳解
前言
本文介紹的主要內(nèi)容是 Redux-Toolkit 在 React + TypeScript 大型應用中的實踐,主要解決的問題是使用 createSlice 的前提下消費 redux 狀態(tài)仍舊有點繁瑣的問題。
閱讀本文需要的前置知識:了解 React 、Redux-Toolkit 、TypeScript 的使用。
關于 Redux-Toolkit 提供的各種函數(shù)的使用,大家可以去官網(wǎng) redux-toolkit.js.org/ 學習。
背景
前陣子接到一個任務:在使用 redux 作為狀態(tài)管理工具的前提下,優(yōu)化一下消費 redux 的步驟,并制定一套使用規(guī)范,讓大家在開發(fā)這個項目消費 redux 狀態(tài)時能按照規(guī)范來。
說到簡化消費 redux 步驟,我第一時間想到的就是 redux 官方推薦的 Redux-Toolkit,于是我就去學習了一下 Redux-Toolkit。
了解完官網(wǎng)和網(wǎng)上各種文章后,我知道了 Redux-Toolkit 在項目中的使用,但是仍然有一個疑問:使用了 createSlice 后,仍然需要在項目的組件中使用 useDispatch 來更新狀態(tài),還是有點麻煩。對于組件使用者來說,有沒有更方便的方式消費 redux 狀態(tài)?
在網(wǎng)上逛來逛去,沒找到有人發(fā)相關的文章,所以我準備自己動手試試看。
Redux-Toolkit 常規(guī)使用
我們先來看看目前使用 Redux-Toolkit 消費 redux 狀態(tài)的方式。舉個例子,假設我們現(xiàn)在的業(yè)務和蛋糕有關,有兩個狀態(tài)存在 redux,分別是 nameOfCake 和 numOfCakes,我們使用 createSlice 來創(chuàng)建 reducer 和 actions:
// 文件位置: app/src/store/reducers/cake.ts
import { createSlice, PayloadAction } from '@reduxjs/toolkit';
type InitialState = {
numOfCakes: number;
nameOfCake: string;
};
const initialState: InitialState = {
numOfCakes: 20,
nameOfCake: 'great cake',
};
const cakeSlice = createSlice({
name: 'cake',
initialState,
reducers: {
updateCakeNum: (state, action: PayloadAction<number>) => {
state.numOfCakes = action.payload;
},
updateCakeName: (state, action: PayloadAction<string>) => {
state.nameOfCake = action.payload;
},
},
});
export default cakeSlice.reducer;
export const { updateCakeNum, updateCakeName } = cakeSlice.actions;
接著我們在組件中消費:
// 文件位置: app/src/pages/Cake/components/CakeView/index.tsx
import { RootState } from '@/src/store';
import { useSelector, useDispatch } from 'react-redux';
import {
useRecordReduxFunction,
updateCakeNum,
updateCakeName,
} from '@/src/store/reducers/cake';
export const CakeView = () => {
const numOfCakes = useSelector((state: RootState) => state.cake.numOfCakes);
const nameOfCake = useSelector((state: RootState) => state.cake.nameOfCake);
const dispatch = useDispatch();
const updateNum = () => {
dispatch(updateCakeNum(100));
};
const updateName = () => {
dispatch(updateCakeName('best cake'));
};
return (
<div>
<h3>Number of cakes - {numOfCakes}</h3>
<h3>Name of cakes - {nameOfCake}</h3>
<button onClick={updateName}>change cake's name</button>
<button onClick={updateNum}>change cake's number</button>
</div>
);
};
現(xiàn)狀的繁瑣點:
- 每次使用 useSelector 來獲取 redux 中狀態(tài)的時候,都需要給 state 加一個 ts 類型 RootState
- 每次修改 redux 狀態(tài)時,都需要引入 useDispatch 和一個 updateData,再將調(diào)用 updateData 返回的action 給 dispatch
我們的目標就是優(yōu)化現(xiàn)狀的這兩個繁瑣點。
優(yōu)化方案
優(yōu)化 useDispatch 和 useSelector
對于繁瑣點1,我們可以對 useDispatch 和 useSelector 進行簡單的封裝,增加 ts 類型校驗。代碼如下:
// 文件位置: app/src/hooks/useReduxHook.ts
import { TypedUseSelectorHook, useDispatch, useSelector } from 'react-redux';
import type { RootState, AppDispatch } from '../store';
export const useAppDispatch = () => useDispatch<AppDispatch>();
export const useAppSelector: TypedUseSelectorHook<RootState> = useSelector;
其中 RootState 和 AppDispatch 在 store 中導出:
import { configureStore } from '@reduxjs/toolkit';
import cakeReducer from './reducers/cake';
const store = configureStore({
reducer: {
cake: cakeReducer,
}
})
export default store;
export type RootState = ReturnType<typeof store.getState>;
export type AppDispatch = typeof store.dispatch;
通過簡單的封裝,我們在業(yè)務層就用 useAppSelector 和 useAppDispatch 代替 useSelector 和 useDispatch:
import { useAppSelector, useAppDispatch } from '@src/hooks/useReduxHook';
// ...
export const CakeView = () => {
const numOfCakes = useAppSelector((state) => state.cake.numOfCakes);
const nameOfCake = useAppSelector((state) => state.cake.nameOfCake);
const dispatch = useAppDispatch();
// ...
return (
// ...
);
};
可以看到這樣就有 ts 類型提示或者校驗了:

優(yōu)化修改 redux 狀態(tài)的步驟
我們現(xiàn)在想要在業(yè)務組件中修改 redux 狀態(tài),我們就需要引入 useDispatch 和通過 createSlice 生成的 updateData 函數(shù),再調(diào)用 dispatch(updateData(data)) 來更新狀態(tài)。
能不能優(yōu)化成,業(yè)務組件只需要調(diào)用一個 updateData 函數(shù),就可以更新 redux 狀態(tài)呢?
最簡單的方式就是將 dispatch(updateData(data)) 給抽出去:
const useUpdateCakeName = () => {
const dispatch = useAppDispatch();
return (payload: InitialState['nameOfCake']) => {
dispatch(updateCakeName(payload));
};
};
但是這對于開發(fā)者來講,換湯不換藥,還是需要寫一個 hook 來 dispatch action。
那我們就來寫一個能自動生成 「用于dispatch action 的 updateData 函數(shù)」的 hook 吧。先來個 js 版:
const useCakeReduxFunction = (action) => {
const dispatch = useAppDispatch();
return (payload) => {
dispatch(cakeSlice.actions[action](payload));
};
};
這個倒是好用了一些,業(yè)務組件使用起來是這樣的:
import { useCakeReduxFunction } from '@/src/store/reducers/cake';
// ...
export const CakeView = () => {
const updateNum = useCakeReduxFunction('updateCakeNum');
const updateName = useCakeReduxFunction('updateCakeName');
// ...
return (
// ...
);
};
但是還有個問題,這樣的話每個 reducer 里都要寫一個 useDataReduxFunction,還是不夠便捷。我們就自然而然的想到寫一個 useCreateReduxFunction 來簡化開發(fā)流程。useCreateReduxFunction 的代碼如下;
type GetArrFirst<T> = T extends [infer Res, ...infer P] ? Res : unknown;
export const useCreateReduxFunction = <S extends Slice>(slice: S) => {
return <T extends keyof S['actions']>(name: T) => {
const dispatch = useAppDispatch();
const actionCreator = (slice.actions as S['actions'])[name];
return (payload: GetArrFirst<Parameters<typeof actionCreator>>) => {
dispatch(actionCreator(payload));
};
};
};
這樣就好辦了,我們在 reducer 中這樣使用:
import { createSlice, PayloadAction } from '@reduxjs/toolkit';
import { useCreateReduxFunction } from '../../app/hooks';
type InitialState = {
numOfCakes: number;
cakeName: string;
};
const initialState: InitialState = {
numOfCakes: 20,
cakeName: 'great cake',
};
const cakeSlice = createSlice({
name: 'cake',
initialState,
reducers: {
updateCakeNum: (state, action: PayloadAction<number>) => {
state.numOfCakes = action.payload;
},
updateCakeName: (state, action: PayloadAction<string>) => {
state.cakeName = action.payload;
},
},
});
export const useCakeReduxFunction = useCreateReduxFunction(cakeSlice);
export default cakeSlice.reducer;
export const { updateCakeNum, updateCakeName } = cakeSlice.actions;
在業(yè)務方這么使用:
import { useAppSelector } from '@src/hooks/useReduxHook';
import { useCakeReduxFunction } from '@src/store/reducers/cake';
export const CakeView = () => {
const numOfCakes = useAppSelector((state) => state.cake.numOfCakes);
const nameOfCake = useAppSelector((state) => state.cake.cakeName);
const updateNum = useCakeReduxFunction('updateCakeNum');
const updateName = useCakeReduxFunction('updateCakeName');
return (
<div>
<h3>Number of cakes - {numOfCakes}</h3>
<h3>Name of cakes - {nameOfCake}</h3>
<button onClick={() => {updateName('best cake')}}>change cake's name</button>
<button onClick={() => {updateNum(100)}}>change cake's number</button>
</div>
);
};
這樣就達成我們的目標了。
總結(jié)
核心代碼如下:
type GetArrFirst<T> = T extends [infer Res, ...infer P] ? Res : unknown;
export const useAppDispatch = () => useDispatch<AppDispatch>();
export const useAppSelector: TypedUseSelectorHook<RootState> = useSelector;
export const useCreateReduxFunction = <S extends Slice>(slice: S) => {
return <T extends keyof S['actions']>(name: T) => {
const dispatch = useAppDispatch();
const actionCreator = (slice.actions as S['actions'])[name];
return (payload: GetArrFirst<Parameters<typeof actionCreator>>) => {
dispatch(actionCreator(payload));
};
};
};
經(jīng)過上面的優(yōu)化方案,我們封裝了 useAppSelector 、 useAppDispatch 和 useCreateReduxFunction三個 hook,解決了目前使用 Redux-Toolkit 還會存在的一些繁瑣點。
以上就是React TypeScript 應用中便捷使用Redux Toolkit方法詳解的詳細內(nèi)容,更多關于React TypeScript使用Redux Toolkit的資料請關注腳本之家其它相關文章!
相關文章
react配置代理setupProxy.js無法訪問v3.0版本問題
這篇文章主要介紹了react配置代理setupProxy.js無法訪問v3.0版本問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
解決React報錯Parameter 'props' implicitly&nb
這篇文章主要為大家介紹了React報錯Parameter 'props' implicitly has an 'any' type的解決處理方法,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-12-12
React?hook實現(xiàn)簡單的websocket封裝方式
這篇文章主要介紹了React?hook實現(xiàn)簡單的websocket封裝方式,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-09-09
react搭建在線編輯html的站點通過引入grapes實現(xiàn)在線拖拉拽編輯html
Grapes插件是一種用于Web開發(fā)的開源工具,可以幫助用戶快速創(chuàng)建動態(tài)和交互式的網(wǎng)頁元素,它還支持多語言和多瀏覽器,適合開發(fā)響應式網(wǎng)頁和移動應用程序,這篇文章主要介紹了react搭建在線編輯html的站點通過引入grapes實現(xiàn)在線拖拉拽編輯html,需要的朋友可以參考下2023-08-08
React文件名和目錄規(guī)范最佳實踐記錄(總結(jié)篇)
React在使用時非常靈活,如果沒有一個規(guī)范約束項目,在開發(fā)過程中會非?;靵y,本文將介紹幾個優(yōu)秀的規(guī)范,介紹文件名和目錄前,需要先簡述一下幾種通用的類型,用來區(qū)分文件的功能,感興趣的朋友一起看看吧2022-05-05

