前言
各位使用 react 技术栈的小伙伴都不可避免的接触过redux
+ react-redux
的这套组合,众所周知 redux 是一个非常精简的库,它和 react 是没有做任何结合的,甚至可以在 vue 项目中使用。
redux 的核心状态管理实现其实就几行代码
function createStore(reducer) { let currentState let subscribers = [] function dispatch(action) { currentState = reducer(currentState, action); subscribers.forEach(s => s()) } function getState() { return currentState; } function subscribe(subscriber) { subscribers.push(subscriber) return function unsubscribe() { ... } } dispatch({ type: 'INIT' }); return { dispatch, getState, }; }
它就是利用闭包管理了 state 等变量,然后在 dispatch 的时候通过用户定义 reducer 拿到新状态赋值给 state,再把外部通过 subscribe 的订阅给触发一下。
那 redux 的实现简单了,react-redux 的实现肯定就需要相对复杂,它需要考虑如何和 react 的渲染结合起来,如何优化性能。
目标
- 本文目标是尽可能简短的实现
react-redux
v7 中的 hook 用法部分Provider
,useSelector
,useDispatch
方法。(不实现connect
方法) - 可能会和官方版本的一些复杂实现不一样,但是保证主要的流程一致。
- 用 TypeScript 实现,并且能获得完善的类型提示。
预览
redux gif.gif
预览地址:
https://sl1673495.github.io/tiny-react-redux
源码地址:
https://github.com/sl1673495/tiny-react-redux
性能
说到性能这个点,自从 React Hook 推出以后,有了useContext
和useReducer
这些方便的 api,新的状态管理库如同雨后春笋版的冒了出来,其中的很多就是利用了Context
做状态的向下传递。
举一个最简单的状态管理的例子
export const StoreContext = React.createContext(); function App({ children }) { const [state, setState] = useState({}); return ( <StoreContext.Provider value={{ state, setState }}> {children} </StoreContext.Provider> ); } function Son() { const { state } = useContext(StoreContext); return <div>state是{state.xxx}</div>; }
利用 useState 或者 useContext,可以很轻松的在所有组件之间通过 Context 共享状态。
但是这种模式的缺点在于 Context 会带来一定的性能问题,下面是 React 官方文档中的描述:
Context性能问题
想像这样一个场景,在刚刚所描述的 Context 状态管理模式下,我们的全局状态中有count
和message
两个状态分别给通过StoreContext.Provider
向下传递
Counter
计数器组件使用了count
Chatroom
聊天室组件使用了message
而在计数器组件通过 Context 中拿到的 setState 触发了count
改变的时候,
由于聊天室组件也利用useContext
消费了用于状态管理的 StoreContext,所以聊天室组件也会被强制重新渲染,这就造成了性能浪费。
虽然这种情况可以用useMemo
进行优化,但是手动优化和管理依赖必然会带来一定程度的心智负担,而在不手动优化的情况下,肯定无法达到上面动图中的重渲染优化。
那么react-redux
作为社区知名的状态管理库,肯定被很多大型项目所使用,大型项目里的状态可能分散在各个模块下,它是怎么解决上述的性能缺陷的呢?接着往下看吧。
缺陷示例
在我之前写的类 vuex 语法的状态管理库react-vuex-hook[1]中,就会有这样的问题。因为它就是用了Context
+ useReducer
的模式。
你可以直接在 在线示例[2] 这里,在左侧菜单栏选择需要优化的场景
,即可看到上述性能问题的重现,优化方案也已经写在文档底部。
这也是为什么我觉得Context
+ useReducer
的模式更适合在小型模块之间共享状态,而不是在全局。
使用
本文的项目就上述性能场景提炼而成,由
聊天室
组件,用了 store 中的count
计数器
组件,用了 store 中的message
控制台
组件,用来监控组件的重新渲染。
redux 的定义
redux 的使用很传统,跟着官方文档对于 TypeScript 的指导走起来,并且把类型定义和 store 都 export 出去。
import { createStore } from 'redux'; type AddAction = { type: 'add'; }; type ChatAction = { type: 'chat'; payload: string; }; type LogAction = { type: 'log'; payload: string; }; const initState = { message: 'Hello', logs: [] as string[], }; export type ActionType = AddAction | ChatAction | LogAction; export type State = typeof initState; function reducer(state: State, action: ActionType): State { switch (action.type) { case 'add': return { ...state, count: state.count + 1, }; case 'chat': return { ...state, message: action.payload, }; case 'log': return { ...state, logs: [action.payload, ...state.logs], }; default: return initState; } } export const store = createStore(reducer);
在组件中使用
import React, { useState, useCallback } from 'react'; import { Card, Button, Input } from 'antd'; import { Provider, useSelector, useDispatch } from '../src'; import { store, State, ActionType } from './store'; import './index.css'; import 'antd/dist/antd.css'; function Count() { const count = useSelector((state: State) => state.count); const dispatch = useDispatch<ActionType>(); // 同步的add const add = useCallback(() => dispatch({ type: 'add' }), []); dispatch({ type: 'log', payload: '计数器组件重新渲染🚀', }); return ( <Card hoverable style={{ marginBottom: 24 }}> <h1>计数器</h1> <div className="chunk"> <div className="chunk">store中的count现在是 {count}</div> <Button onClick={add}>add</Button> </div> </Card> ); } export default () => { return ( <Provider store={store}> <Count /> </Provider> ); };
可以看到,我们用Provider
组件里包裹了Count
组件,并且把 redux 的 store 传递了下去
在子组件里,通过useDispatch
可以拿到 redux 的 dispatch, 通过useSelector
可以访问到 store,拿到其中任意的返回值。
实现
用最简短的方式实现代码,探究 react-redux 为什么能在count
发生改变的时候不让使用了message
的组件重新渲染。
实现 Context
利用官方 api 构建 context,并且提供一个自定义 hook: useReduxContext
去访问这个 context,对于忘了用 Provider 包裹的情况进行一些错误提示:
对于不熟悉自定义 hook 的小伙伴,可以看我之前写的这篇文章:
使用 React Hooks + 自定义 Hook 封装一步一步打造一个完善的小型应用。[3]
import React, { useContext } from "react"; import { Store } from "redux"; interface ContextType { store: Store; } export const Context = (React.createContext < ContextType) | (null > null); export function useReduxContext() { const contextValue = useContext(Context); if (!contextValue) { throw new Error( "could not find react-redux context value; please ensure the component is wrapped in a <Provider>" ); } return contextValue; }
实现 Provider
import React, { FC } from "react"; import { Store } from "redux"; import { Context } from "./Context"; interface ProviderProps { store: Store; } export const Provider: FC<ProviderProps> = ({ store, children }) => { return <Context.Provider value={{ store }}>{children}</Context.Provider>; };
实现 useDispatch
这里就是简单的把 dispatch 返回出去,通过泛型传递让外部使用的时候可以获得类型提示。
泛型推导不熟悉的小伙伴可以看一下之前这篇:
进阶实现智能类型推导的简化版 Vuex[4]
import { useReduxContext } from './Context'; import { Dispatch, Action } from 'redux'; export function useDispatch<A extends Action>() { const { store } = useReduxContext(); return store.dispatch as Dispatch<A>; }
实现 useSelector
这里才是重点,这个 api 有两个参数。
selector
: 定义如何从 state 中取值,如state => state.count
equalityFn
: 定义如何判断渲染之间值是否有改变。
在性能章节也提到过,大型应用中必须做到只有自己使用的状态改变了,才去重新渲染,那么equalityFn
就是判断是否渲染的关键了。
关键流程(初始化):
- 根据传入的 selector 从 redux 的 store 中取值。
- 定义一个
latestSelectedState
保存上一次 selector 返回的值。 - 定义一个
checkForceUpdate
方法用来控制当状态发生改变的时候,让当前组件的强制渲染。 - 利用
store.subscribe
订阅一次 redux 的 store,下次 redux 的 store 发生变化执行checkForceUpdate
。
关键流程(更新)
- 当用户使用
dispatch
触发了 redux store 的变动后,store 会触发checkForceUpdate
方法。 checkForceUpdate
中,从latestSelectedState
拿到上一次 selector 的返回值,再利用 selector(store)拿到最新的值,两者利用equalityFn
进行比较。- 根据比较,判断是否需要强制渲染组件。
有了这个思路,就来实现代码吧:
import { useReducer, useRef, useEffect } from 'react'; import { useReduxContext } from './Context'; type Selector<State, Selected> = (state: State) => Selected; type EqualityFn<Selected> = (a: Selected, b: Selected) => boolean; // 默认比较的方法 const defaultEqualityFn = <T>(a: T, b: T) => a === b; export function useSelector<State, Selected>( selector: Selector<State, Selected>, equalityFn: EqualityFn<Selected> = defaultEqualityFn, ) { const { store } = useReduxContext(); // 强制让当前组件渲染的方法。 const [, forceRender] = useReducer(s => s + 1, 0); // 存储上一次selector的返回值。 const latestSelectedState = useRef<Selected>(); // 根据用户传入的selector,从store中拿到用户想要的值。 const selectedState = selector(store.getState()); // 检查是否需要强制更新 function checkForUpdates() { // 从store中拿到最新的值 const newSelectedState = selector(store.getState()); // 如果比较相等,就啥也不做 if (equalityFn(newSelectedState, latestSelectedState.current)) { return; } // 否则更新ref中保存的上一次渲染的值 // 然后强制渲染 latestSelectedState.current = newSelectedState; forceRender(); } // 组件第一次渲染后 执行订阅store的逻辑 useEffect(() => { // 🚀重点,去订阅redux store的变化 // 在用户调用了dispatch后,执行checkForUpdates const unsubscribe = store.subscribe(checkForUpdates); // 组件被销毁后 需要调用unsubscribe停止订阅 return unsubscribe; }, []); return selectedState; }
总结
本文涉及到的源码地址:
https://github.com/sl1673495/tiny-react-redux
原版的 react-redux 的实现肯定比这里的简化版要复杂的多,它要考虑 class 组件的使用,以及更多的优化以及边界情况。
从简化版的实现入手,我们可以更清晰的得到整个流程脉络,如果你想进一步的学习源码,也可以考虑多花点时间去看官方源码并且单步调试。
参考资料
[1]
react-vuex-hook: https://github.com/sl1673495/react-vuex-hook
[2]
在线示例: https://sl1673495.github.io/react-vuex-hook
[3]
使用 React Hooks + 自定义 Hook 封装一步一步打造一个完善的小型应用。: https://juejin.im/post/5d6771375188257573636cf9
[4]
进阶实现智能类型推导的简化版 Vuex: https://juejin.im/post/5e1684b65188253a8c26468b