在深究 React 的 setState 原理的时候,我们先要考虑一个问题:setState 是异步的吗?首先以 class component 为例,请看下述代码(demo-0):
class App extends React.Component {
state = {
count: 0
}
handleCountClick = () => {
this.setState({
count: this.state.count + 1
});
console.log(this.state.count);
}
render() {
return (
<div className='app-box'>
<div onClick={this.handleCountClick}>the count is {this.state.count}</div>
</div>
)
}
}
ReactDOM.render(
<App />,
document.getElementById('container')
);
count初始值为 0,当我们触发handleCountClick事件的时候,执行了count + 1操作,并打印了count,此时打印出的count是多少呢?答案不是 1 而是 0。
类似的 function component 与 class component 原理一致。现在我们以 function component 为例,请看下述代码 (demo-1):
const App = function () {
const [count, setCount] = React.useState(0);
const handleCountClick = () => {
setCount((count) => {
return count + 1;
});
console.log(count);
}
return <div className='app-box'>
<div onClick={handleCountClick}>the count is {count}</div>
</div>
}
ReactDOM.render(
<App />,
document.getElementById('container')
);
同样的,这里打印出的 count 也为 0。
相信大家都知道这个看起来是异步的现象,但他真的是异步的吗?
首先得思考一个问题:如何判断这个函数是否为异步?
最直接的,我们写一个 setTimeout,打个 debugger 试试看:
我们都知道 setTimeout 里的回调函数是异步的,也正如上图所示,chrome 会给 setTimeout 打上一个 async 的标签。
接下来我们 debugger setState 看看:
React.useState 返回的第二个参数实际就是这个 dispatchSetState函数(下文细说)。但正如上图所示,这个函数并没有 async 标签,所以 setState 并不是异步的。
那么抛开这些概念来看,上文中 demo-1 的类似异步的现象是怎么发生的呢?
简单的来说,其步骤如下所示。基于此,我们接下来更深入的看看 React 在这个过程中做了什么:
first paint 就是『首次渲染』,为突出显示,就用英文代替。
这里先简单看一下App往下的 fiber tree 结构。每个 fiber node 还有一个return指向其 parent fiber node,这里就不细说了
我们都知道 React 渲染的时候,得遍历一遍 fiber tree,当走到 App 这个 fiber node 的时候发生了什么呢?先看一下 first paint 的整个流程图:
接下来我们看看详细的代码(这里的 workInProgress 就是整在处理的 fiber node,不关心的代码已删除):
首先要注意的是,虽然 App 是一个FunctionComponent,但是在 first paint 的时候,React 判断其为IndeterminateComponent。
switch (workInProgress.tag) { // workInProgress.tag === 2
case IndeterminateComponent:
{
return mountIndeterminateComponent(
current,
workInProgress,
workInProgress.type,
renderLanes
);
}
// ...
case FunctionComponent:
{ /** ... */}
}
接下来走进这个mountIndeterminateComponent,里头有个关键的函数renderWithHooks;而在renderWithHooks 中,我们会根据组件处于不同的状态,给ReactCurrentDispatcher.current 挂载不同的dispatcher 。而在first paint 时,挂载的是HooksDispatcherOnMountInDEV:
function mountIndeterminateComponent(_current, workInProgress, Component, renderLanes) {
value = renderWithHooks(
null,
workInProgress,
Component,
props,
context,
renderLanes
);
}
function renderWithHooks() {
// ...
if (current !== null && current.memoizedState !== null) {
// 此时 React 认为组件在更新
ReactCurrentDispatcher.current = HooksDispatcherOnUpdateInDEV;
} else if (hookTypesDev !== null) {
// handle edge case,这里我们不关心
} else {
// 此时 React 认为组件为 first paint 阶段
ReactCurrentDispatcher.current = HooksDispatcherOnMountInDEV;
}
// ...
var children = Component(props, secondArg); // 调用我们的 Component
}
这个HooksDispatcherOnMountInDEV 里就是组件 first paint 的时候所用到的各种 hooks:
HooksDispatcherOnMountInDEV = {
// ...
useState: function (initialState) {
currentHookNameInDev = 'useState';
mountHookTypesDev();
var prevDispatcher = ReactCurrentDispatcher$1.current;
ReactCurrentDispatcher.current = InvalidNestedHooksDispatcherOnMountInDEV;
try {
return mountState(initialState);
} finally {
ReactCurrentDispatcher.current = prevDispatcher;
}
},
// ...
}
接下里走进我们的App(),我们会调用React.useState,点进去看看,代码如下。这里的dispatcher 就是上文挂载到ReactCurrentDispatcher.current 的HooksDispatcherOnMountInDEV:
function useState(initialState) {
var dispatcher = resolveDispatcher();
return dispatcher.useState(initialState);
}
// ...
HooksDispatcherOnMountInDEV = {
// ...
useState: function (initialState) {
currentHookNameInDev = 'useState';
mountHookTypesDev();
var prevDispatcher = ReactCurrentDispatcher$1.current;
ReactCurrentDispatcher$1.current = InvalidNestedHooksDispatcherOnMountInDEV;
try {
return mountState(initialState);
} finally {
ReactCurrentDispatcher$1.current = prevDispatcher;
}
},
// ...
}
这里会调用mountState 函数:
function mountState(initialState) {
var hook = mountWorkInProgressHook();
if (typeof initialState === 'function') {
// $FlowFixMe: Flow doesn't like mixed types
initialState = initialState();
}
hook.memoizedState = hook.baseState = initialState;
var queue = {
pending: null,
interleaved: null,
lanes: NoLanes,
dispatch: null,
lastRenderedReducer: basicStateReducer,
lastRenderedState: initialState
};
hook.queue = queue;
var dispatch = queue.dispatch = dispatchSetState.bind(null, currentlyRenderingFiber$1, queue);
return [hook.memoizedState, dispatch];
}
这个函数做了这么几件事情:
(1)执行 mountWorkInProgressHook 函数:
function mountWorkInProgressHook() {
var hook = {
memoizedState: null,
baseState: null,
baseQueue: null,
queue: null,
next: null
};
if (workInProgressHook === null) {
// This is the first hook in the list
currentlyRenderingFiber$1.memoizedState = workInProgressHook = hook;
} else {
// Append to the end of the list
workInProgressHook = workInProgressHook.next = hook;
}
return workInProgressHook;
}
(2)判断传入的initialState 是否为一个函数,若是,则调用它并重新赋值给initialState (在我们的demo-1里是『0』)
(3)将initialState 挂到hook.memoizedState 以及hook.baseState
(4)给hook 上添加一个queue。这个queue 有多个属性,其中queue.dispatch 挂载的是一个dispatchSetState。这里要注意一下这一行代码:
var dispatch = queue.dispatch = dispatchSetState.bind(null, currentlyRenderingFiber, queue);
(5)Function.prototype.bind 的第一个参数都知道是绑 this 的,后面两个就是绑定了 dispatchSetState 所需要的第一个参数(当前fiber)和第二个参数(当前queue)。
这也是为什么虽然 dispatchSetState 本身需要三个参数,但我们使用的时候都是 setState(params),只用传一个参数的原因。
(6)返回一个数组,也就是我们常见的React.useState 返回的形式。此时这个 state 是 0。
至此为止,React.useState 在 first paint 里做的事儿就完成了,接下来就是正常渲染,展示页面:
最开始我们先看一眼触发组件更新的整个流程图:
要触发组件更新,自然就是点击这个绑定了事件监听的div,触发setCount。回忆一下,这个setCount 就是上文讲述的,暴露出来的dispatchSetState。并且正如上文所述,我们传进去的参数实际上是dispatchSetState 的第三个参数action。(这个函数自然也涉及一些 React 执行优先级的判断,不在本文的讨论范围内就省略了):
function dispatchSetState(fiber, queue, action) {
var update = {
lane: lane,
action: action,
hasEagerState: false,
eagerState: null,
next: null
};
enqueueUpdate(fiber, queue, update);
}
dispatchSetState 做了这么几件事:
(1)创建一个update,把我们传入的action 放进去
(2)进入enqueueUpdate 函数:
function enqueueUpdate(fiber, queue, update, lane) {
var pending = queue.pending;
if (pending === null) {
// This is the first update. Create a circular list.
update.next = update;
} else {
update.next = pending.next;
pending.next = update;
}
queue.pending = update;
var lastRenderedReducer = queue.lastRenderedReducer;
var currentState = queue.lastRenderedState;
var eagerState = lastRenderedReducer(currentState, action);
update.hasEagerState = true;
update.eagerState = eagerState;
}
(3)根据queue 上的各个参数(reducer、上次计算出的 state)计算出eagerState,并挂载到当前update 上
到此,我们实际上更新完state了,这个新的state 挂载到哪儿了呢?在fiber.memoizedState.queue.pending 上。注意:
此时我们打印进行打印,但这里打印的还是 first paint 里返回出来的 state,也就是 0。
现在我们更新完 state,要开始跟新 fiber tree 了,进行最后的渲染。逻辑在 performSyncWorkOnRoot 函数里,同样的,不关心的逻辑我们省略:
function performSyncWorkOnRoot(root) {
var exitStatus = renderRootSync(root, lanes);
}
同样的我们先看一眼 fiber tree 更新过程中与 useState 相关的整个流程图:
首先我们走进renderRootSync,这个函数作用是遍历一遍 fiber tree,当遍历的App时,此时的类型为FunctionComponent。还是我们前文所说的熟悉的步骤,走进renderWithHooks。注意此时 React 认为该组件在更新了,所以给dispatcher 挂载的就是HooksDispatcherOnUpdateInDEV:
function renderWithHooks(current, workInProgress, Component, props, secondArg, nextRenderLanes) {
var children = Component(props, secondArg);
}
我们再次走进App,这里又要再次调用React.useState 了:
const App = function () {
const [count, setCount] = React.useState(0);
const handleCountClick = () => {
setCount(count + 1);
}
return <div className='app-box'>
<div onClick={handleCountClick}>the count is {count}</div>
</div>
}
与之前不同的是,这次所使用的dispatch 为HooksDispatcherOnUpdateInDEV。那么这个dispatch 下的useState 具体做了什么呢?
useState: function (initialState) {
currentHookNameInDev = 'useState';
updateHookTypesDev();
var prevDispatcher = ReactCurrentDispatcher$1.current;
ReactCurrentDispatcher$1.current = InvalidNestedHooksDispatcherOnUpdateInDEV;
try {
return updateState(initialState);
} finally {
ReactCurrentDispatcher$1.current = prevDispatcher;
}
}
可以看到大致都差不多,唯一不同的是,这里调用的是updateState,而之前是mountState。
function updateState(initialState) {
return updateReducer(basicStateReducer);
}
function updateReducer(reducer, initialArg, init) {
var first = baseQueue.next;
var newState = current.baseState;
do {
// 遍历更新 newState
update = update.next;
} while (update !== null && update !== first);
hook.memoizedState = newState;
queue.lastRenderedState = newState;
return [hook.memoizedState, dispatch];
}
这里又调用了updateReducer,其中代码很多不一一展示,关键步骤就是:
接下来就走进commitRootImpl 进行最后的渲染了,这不是本文的重点就不展开了,里头涉及useEffect 等钩子函数的调用逻辑。
最后看一眼整个详细的流程图:
上文只是描述了一个最简单的 React.useState 使用场景,各位可以根据本文配合源码,进行以下两个尝试:
Q1. 多个 state 的时候有什么变化?例如以下场景时:
const App = () => {
const [count, setCount] = React.useState(0);
const [str, setStr] = React.useState('');
// ...
}
A1. 将会构建一个上文所提到的 hook 链。
Q2. 对同个 state 多次调用 setState 时有什么变化?例如以下场景:
const App = () => {
const [count, setCount] = React.useState(0);
const handleCountClick = () => {
setCount(count + 1);
setCount(count + 2);
}
return <div className='app-box'>
<div onClick={handleCountClick}>the count is {count}</div>
</div>
}
A2. 将会构建一个上文所提到的 update 链。