
useReducer()
title: useReducer()
useReducer 是一个 React Hook,它允许你向组件里面添加一个 reducer。
js
const [state, dispatch] = useReducer(reducer, initialArg, init?)
参考 {/reference/}
useReducer(reducer, initialArg, init?) {/usereducer/}
在组件的顶层作用域调用 useReducer 以创建一个用于管理状态的 reducer。
js
import { useReducer } from 'react';
function reducer(state, action) {
// ...
}
function MyComponent() {
const [state, dispatch] = useReducer(reducer, { age: 42 });
// ...
参数 {/parameters/}
reducer:用于更新 state 的纯函数。参数为 state 和 action,返回值是更新后的 state。state 与 action 可以是任意合法值。initialArg:用于初始化 state 的任意值。初始值的计算逻辑取决于接下来的init参数。- 可选参数
init:用于计算初始值的函数。如果存在,使用init(initialArg)的执行结果作为初始值,否则使用initialArg。
返回值 {/returns/}
useReducer 返回一个由两个值组成的数组:
- 当前的 state。初次渲染时,它是
init(initialArg)或initialArg(如果没有init函数)。 dispatch函数。用于更新 state 并触发组件的重新渲染。
注意事项 {/caveats/}
useReducer是一个 Hook,所以只能在 组件的顶层作用域 或自定义 Hook 中调用,而不能在循环或条件语句中调用。如果有这种需求,可以创建一个新的组件,并把 state 移入其中。dispatch函数具有稳定的标识,所以你经常会看到 Effect 的依赖数组中会省略它,即使包含它也不会导致 Effect 重新触发。如果 linter 允许省略依赖项并且没有报错,那么就可以安全地省略它。了解移除 Effect 依赖项的更多信息。- 严格模式下 React 会 调用两次 reducer 和初始化函数,这可以 帮助你发现意外的副作用。这只是开发模式下的行为,并不会影响生产环境。只要 reducer 和初始化函数是纯函数(理应如此)就不会改变逻辑。其中一个调用结果会被忽略。
dispatch 函数 {/dispatch/}
useReducer 返回的 dispatch 函数允许你更新 state 并触发组件的重新渲染。它需要传入一个 action 作为参数:
js
const [state, dispatch] = useReducer(reducer, { age: 42 });
function handleClick() {
dispatch({ type: 'incremented_age' });
// ...
React 会调用 reducer 函数以更新 state,reducer 函数的参数为当前的 state 与传递的 action。
参数 {/dispatch-parameters/}
action:用户执行的操作。可以是任意类型的值。通常来说 action 是一个对象,其中type属性标识类型,其它属性携带额外信息。
返回值 {/dispatch-returns/}
dispatch 函数没有返回值。
注意 {/dispatch-caveats/}
-
dispatch函数 是为下一次渲染而更新 state。因此在调用dispatch函数后读取 state 并不会拿到更新后的值,也就是说只能获取到调用前的值。 -
如果提供的新值与当前的
state相同(使用Object.is比较),React 会 跳过组件和子组件的重新渲染,这是一种优化手段。虽然在跳过重新渲染前 React 可能会调用你的组件,但是这不应该影响代码。 -
React 会批量更新 state。state 会在 所有事件函数执行完毕 并且已经调用过它的
set函数后进行更新,这可以防止在一个事件中多次进行重新渲染。如果在访问 DOM 等极少数情况下需要强制 React 提前更新,可以使用flushSync。
用法 {/usage/}
向组件添加 reducer {/adding-a-reducer-to-a-component/}
在组件的顶层作用域调用 useReducer 来创建一个用于管理状态(state)的 reducer。
js [[1, 8, "state"], [2, 8, "dispatch"], [4, 8, "reducer"], [3, 8, "{ age: 42 }"]]
import { useReducer } from 'react';
function reducer(state, action) {
// ...
}
function MyComponent() {
const [state, dispatch] = useReducer(reducer, { age: 42 });
// ...
useReducer 返回一个由两个值组成的数组:
当前的 state ,首次渲染时为你提供的初始值 。 ,让你可以根据交互修改 state。dispatch函数
为了更新屏幕上的内容,使用一个表示用户操作的 action 来调用 dispatch
js [[2, 2, "dispatch"]]
function handleClick() {
dispatch({ type: 'incremented_age' });
}
React 会把当前的 state 和这个 action 一起作为参数传给
js
import { useReducer } from 'react';
function reducer(state, action) {
if (action.type === 'incremented_age') {
return {
age: state.age + 1
};
}
throw Error('未知 action。');
}
export default function Counter() {
const [state, dispatch] = useReducer(reducer, { age: 42 });
return (
<>
<button onClick={() => {
dispatch({ type: 'incremented_age' })
}}>
增加年龄
</button>
<p>你好!你 {state.age} 岁了。</p>
</>
);
}
css
button { display: block; margin-top: 10px; }
useReducer 和 useState 非常相似,但是它可以让你把状态更新逻辑从事件处理函数中移动到组件外部。详情可以参阅 对比 useState 和 useReducer。
实现 reducer 函数 {/writing-the-reducer-function/}
reducer 函数的定义如下:
js
function reducer(state, action) {
// ...
}
需要往函数体里面添加计算并返回新的 state 的逻辑。一般会使用 switch 语句 来完成。在 switch 语句中通过匹配 case 条件来计算并返回相应的 state。
js {4-7,10-13}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
return {
name: state.name,
age: state.age + 1
};
}
case 'changed_name': {
return {
name: action.nextName,
age: state.age
};
}
}
throw Error('未知的 action:' + action.type);
}
action 可以是任意类型,不过通常至少是一个存在 type 属性的对象。也就是说它需要携带计算新的 state 值所必须的数据。
js {5,9-12}
function Form() {
const [state, dispatch] = useReducer(reducer, { name: 'Taylor', age: 42 });
function handleButtonClick() {
dispatch({ type: 'incremented_age' });
}
function handleInputChange(e) {
dispatch({
type: 'changed_name',
nextName: e.target.value
});
}
// ...
action 的 type 依赖于组件的实际情况。即使它会导致数据的多次更新,每个 action 都只描述一次交互。state 的类型也是任意的,不过一般会使用对象或数组。
阅读 迁移状态逻辑至 Reducer 中 来了解更多内容。
state 是只读的。即使是对象或数组也不要尝试修改它:
js {4,5}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
// 🚩 不要像下面这样修改一个对象类型的 state:
state.age = state.age + 1;
return state;
}
正确的做法是返回新的对象:
js {4-8}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
// ✅ 正确的做法是返回新的对象
return {
...state,
age: state.age + 1
};
}
阅读 更新对象类型的 state 和 更新数组类型的 state 来了解更多内容。
表单(对象类型) {/form-object/}
在这个示例中,state 是一个有 name 和 age 属性的对象。
js
import { useReducer } from 'react';
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
return {
name: state.name,
age: state.age + 1
};
}
case 'changed_name': {
return {
name: action.nextName,
age: state.age
};
}
}
throw Error('未知的 action:' + action.type);
}
const initialState = { name: 'Taylor', age: 42 };
export default function Form() {
const [state, dispatch] = useReducer(reducer, initialState);
function handleButtonClick() {
dispatch({ type: 'incremented_age' });
}
function handleInputChange(e) {
dispatch({
type: 'changed_name',
nextName: e.target.value
});
}
return (
<>
<input
value={state.name}
onChange={handleInputChange}
/>
<button onClick={handleButtonClick}>
增加年龄
</button>
<p>你好,{state.name}。你 {state.age} 岁了。</p>
</>
);
}
css
button { display: block; margin-top: 10px; }
代办事项(数组类型) {/todo-list-array/}
在这个示例中,reducer 管理一个名为 tasks 的数组。数组 不能使用修改方法 来更新。
js src/App.js
import { useReducer } from 'react';
import AddTask from './AddTask.js';
import TaskList from './TaskList.js';
function tasksReducer(tasks, action) {
switch (action.type) {
case 'added': {
return [...tasks, {
id: action.id,
text: action.text,
done: false
}];
}
case 'changed': {
return tasks.map(t => {
if (t.id === action.task.id) {
return action.task;
} else {
return t;
}
});
}
case 'deleted': {
return tasks.filter(t => t.id !== action.id);
}
default: {
throw Error('未知的 action:' + action.type);
}
}
}
export default function TaskApp() {
const [tasks, dispatch] = useReducer(
tasksReducer,
initialTasks
);
function handleAddTask(text) {
dispatch({
type: 'added',
id: nextId++,
text: text,
});
}
function handleChangeTask(task) {
dispatch({
type: 'changed',
task: task
});
}
function handleDeleteTask(taskId) {
dispatch({
type: 'deleted',
id: taskId
});
}
return (
<>
<h1>布拉格行程</h1>
<AddTask
onAddTask={handleAddTask}
/>
<TaskList
tasks={tasks}
onChangeTask={handleChangeTask}
onDeleteTask={handleDeleteTask}
/>
</>
);
}
let nextId = 3;
const initialTasks = [
{ id: 0, text: '参观卡夫卡博物馆', done: true },
{ id: 1, text: '观看木偶戏', done: false },
{ id: 2, text: '列宁墙合影', done: false }
];
js src/AddTask.js hidden
import { useState } from 'react';
export default function AddTask({ onAddTask }) {
const [text, setText] = useState('');
return (
<>
<input
placeholder="添加任务"
value={text}
onChange={e => setText(e.target.value)}
/>
<button onClick={() => {
setText('');
onAddTask(text);
}}>添加</button>
</>
)
}
js src/TaskList.js hidden
import { useState } from 'react';
export default function TaskList({
tasks,
onChangeTask,
onDeleteTask
}) {
return (
<ul>
{tasks.map(task => (
<li key={task.id}>
<Task
task={task}
onChange={onChangeTask}
onDelete={onDeleteTask}
/>
</li>
))}
</ul>
);
}
function Task({ task, onChange, onDelete }) {
const [isEditing, setIsEditing] = useState(false);
let taskContent;
if (isEditing) {
taskContent = (
<>
<input
value={task.text}
onChange={e => {
onChange({
...task,
text: e.target.value
});
}} />
<button onClick={() => setIsEditing(false)}>
保存
</button>
</>
);
} else {
taskContent = (
<>
{task.text}
<button onClick={() => setIsEditing(true)}>
编辑
</button>
</>
);
}
return (
<label>
<input
type="checkbox"
checked={task.done}
onChange={e => {
onChange({
...task,
done: e.target.checked
});
}}
/>
{taskContent}
<button onClick={() => onDelete(task.id)}>
删除
</button>
</label>
);
}
css
button { margin: 5px; }
li { list-style-type: none; }
ul, li { margin: 0; padding: 0; }
使用 Immer 编写简洁的更新逻辑 {/writing-concise-update-logic-with-immer/}
如果使用复制方法更新数组和对象让你不厌其烦,那么可以使用 Immer 这样的库来减少一些重复的样板代码。Immer 让你可以专注于逻辑,因为它在内部均使用复制方法来完成更新:
js src/App.js
import { useImmerReducer } from 'use-immer';
import AddTask from './AddTask.js';
import TaskList from './TaskList.js';
function tasksReducer(draft, action) {
switch (action.type) {
case 'added': {
draft.push({
id: action.id,
text: action.text,
done: false
});
break;
}
case 'changed': {
const index = draft.findIndex(t =>
t.id === action.task.id
);
draft[index] = action.task;
break;
}
case 'deleted': {
return draft.filter(t => t.id !== action.id);
}
default: {
throw Error('未知的 action:' + action.type);
}
}
}
export default function TaskApp() {
const [tasks, dispatch] = useImmerReducer(
tasksReducer,
initialTasks
);
function handleAddTask(text) {
dispatch({
type: 'added',
id: nextId++,
text: text,
});
}
function handleChangeTask(task) {
dispatch({
type: 'changed',
task: task
});
}
function handleDeleteTask(taskId) {
dispatch({
type: 'deleted',
id: taskId
});
}
return (
<>
<h1>布拉格行程</h1>
<AddTask
onAddTask={handleAddTask}
/>
<TaskList
tasks={tasks}
onChangeTask={handleChangeTask}
onDeleteTask={handleDeleteTask}
/>
</>
);
}
let nextId = 3;
const initialTasks = [
{ id: 0, text: '参观卡夫卡博物馆', done: true },
{ id: 1, text: '观看木偶戏', done: false },
{ id: 2, text: '列宁墙合影', done: false },
];
js src/AddTask.js hidden
import { useState } from 'react';
export default function AddTask({ onAddTask }) {
const [text, setText] = useState('');
return (
<>
<input
placeholder="添加任务"
value={text}
onChange={e => setText(e.target.value)}
/>
<button onClick={() => {
setText('');
onAddTask(text);
}}>添加</button>
</>
)
}
js src/TaskList.js hidden
import { useState } from 'react';
export default function TaskList({
tasks,
onChangeTask,
onDeleteTask
}) {
return (
<ul>
{tasks.map(task => (
<li key={task.id}>
<Task
task={task}
onChange={onChangeTask}
onDelete={onDeleteTask}
/>
</li>
))}
</ul>
);
}
function Task({ task, onChange, onDelete }) {
const [isEditing, setIsEditing] = useState(false);
let taskContent;
if (isEditing) {
taskContent = (
<>
<input
value={task.text}
onChange={e => {
onChange({
...task,
text: e.target.value
});
}} />
<button onClick={() => setIsEditing(false)}>
保存
</button>
</>
);
} else {
taskContent = (
<>
{task.text}
<button onClick={() => setIsEditing(true)}>
编辑
</button>
</>
);
}
return (
<label>
<input
type="checkbox"
checked={task.done}
onChange={e => {
onChange({
...task,
done: e.target.checked
});
}}
/>
{taskContent}
<button onClick={() => onDelete(task.id)}>
删除
</button>
</label>
);
}
css
button { margin: 5px; }
li { list-style-type: none; }
ul, li { margin: 0; padding: 0; }
json package.json
{
"dependencies": {
"immer": "1.7.3",
"react": "latest",
"react-dom": "latest",
"react-scripts": "latest",
"use-immer": "0.5.1"
},
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test --env=jsdom",
"eject": "react-scripts eject"
}
}
避免重新创建初始值 {/avoiding-recreating-the-initial-state/}
React 会保存 state 的初始值并在下一次渲染时忽略它。
js
function createInitialState(username) {
// ...
}
function TodoList({ username }) {
const [state, dispatch] = useReducer(reducer, createInitialState(username));
// ...
虽然 createInitialState(username) 的返回值只用于初次渲染,但是在每一次渲染的时候都会被调用。如果它创建了比较大的数组或者执行了昂贵的计算就会浪费性能。
可以通过给 useReducer 的第三个参数传入 初始化函数 来解决这个问题:
js {6}
function createInitialState(username) {
// ...
}
function TodoList({ username }) {
const [state, dispatch] = useReducer(reducer, username, createInitialState);
// ...
需要注意的是传入的参数是 createInitialState 这个 函数自身,而不是执行 createInitialState() 后的返回值。这样传参就可以保证初始化函数不会再次运行。
在上面这个例子中,createInitialState 有一个 username 参数。如果初始化函数不需要参数就可以计算出初始值,可以把 useReducer 的第二个参数改为 null。
使用初始化函数 {/passing-the-initializer-function/}
这个示例使用了一个初始化函数,所以 createInitialState 函数只会在初次渲染的时候进行调用。即使往输入框中输入内容导致组件重新渲染,初始化函数也不会被再次调用。
js src/App.js hidden
import TodoList from './TodoList.js';
export default function App() {
return <TodoList username="Taylor" />;
}
js src/TodoList.js active
import { useReducer } from 'react';
function createInitialState(username) {
const initialTodos = [];
for (let i = 0; i < 50; i++) {
initialTodos.push({
id: i,
text: username + " 的任务 #" + (i + 1)
});
}
return {
draft: '',
todos: initialTodos,
};
}
function reducer(state, action) {
switch (action.type) {
case 'changed_draft': {
return {
draft: action.nextDraft,
todos: state.todos,
};
};
case 'added_todo': {
return {
draft: '',
todos: [{
id: state.todos.length,
text: state.draft
}, ...state.todos]
}
}
}
throw Error('未知的 action:' + action.type);
}
export default function TodoList({ username }) {
const [state, dispatch] = useReducer(
reducer,
username,
createInitialState
);
return (
<>
<input
value={state.draft}
onChange={e => {
dispatch({
type: 'changed_draft',
nextDraft: e.target.value
})
}}
/>
<button onClick={() => {
dispatch({ type: 'added_todo' });
}}>添加</button>
<ul>
{state.todos.map(item => (
<li key={item.id}>
{item.text}
</li>
))}
</ul>
</>
);
}
直接传入初始值 {/passing-the-initial-state-directly/}
这个示例 没有使用 初始化函数,所以当你往输入框输入内容导致组件重新渲染的时候,createInitialState 函数就会执行。虽然在渲染结果上看没有什么区别,但是多余的逻辑会导致性能变差。
js src/App.js hidden
import TodoList from './TodoList.js';
export default function App() {
return <TodoList username="Taylor" />;
}
js src/TodoList.js active
import { useReducer } from 'react';
function createInitialState(username) {
const initialTodos = [];
for (let i = 0; i < 50; i++) {
initialTodos.push({
id: i,
text: username + " 的任务 #" + (i + 1)
});
}
return {
draft: '',
todos: initialTodos,
};
}
function reducer(state, action) {
switch (action.type) {
case 'changed_draft': {
return {
draft: action.nextDraft,
todos: state.todos,
};
};
case 'added_todo': {
return {
draft: '',
todos: [{
id: state.todos.length,
text: state.draft
}, ...state.todos]
}
}
}
throw Error('未知的 action:' + action.type);
}
export default function TodoList({ username }) {
const [state, dispatch] = useReducer(
reducer,
createInitialState(username)
);
return (
<>
<input
value={state.draft}
onChange={e => {
dispatch({
type: 'changed_draft',
nextDraft: e.target.value
})
}}
/>
<button onClick={() => {
dispatch({ type: 'added_todo' });
}}>添加</button>
<ul>
{state.todos.map(item => (
<li key={item.id}>
{item.text}
</li>
))}
</ul>
</>
);
}
疑难解答 {/troubleshooting/}
我已经 dispatch 了一个 action,但是打印出来仍然还是旧的 state {/ive-dispatched-an-action-but-logging-gives-me-the-old-state-value/}
调用 dispatch 函数 不会改变当前渲染的 state:
js {4,5,8}
function handleClick() {
console.log(state.age); // 42
dispatch({ type: 'incremented_age' }); // 用 43 进行重新渲染
console.log(state.age); // 还是 42!
setTimeout(() => {
console.log(state.age); // 一样是 42!
}, 5000);
}
这是因为 state 的行为和快照一样。更新 state 会使用新的值来对组件进行重新渲染,但是不会改变当前执行的事件处理函数里面 state 的值。
如果你需要获取更新后的 state,可以手动调用 reducer 来得到结果:
js
const action = { type: 'incremented_age' };
dispatch(action);
const nextState = reducer(state, action);
console.log(state); // { age: 42 }
console.log(nextState); // { age: 43 }
我已经 dispatch 了一个 action,但是屏幕并没有更新 {/ive-dispatched-an-action-but-the-screen-doesnt-update/}
React 使用 Object.is 比较更新前后的 state,如果 它们相等就会跳过这次更新。这通常是因为直接修改了对象或数组:
js {4-5,9-10}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
// 🚩 错误行为:直接修改对象
state.age++;
return state;
}
case 'changed_name': {
// 🚩 错误行为:直接修改对象
state.name = action.nextName;
return state;
}
// ...
}
}
直接修改并返回了一个 state 对象,所以 React 会跳过这次更新。为了修复这个错误,应该确保总是 使用正确的方式更新对象 和 使用正确的方式更新数组:
js {4-8,11-15}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
// ✅ 修复:创建一个新的对象
return {
...state,
age: state.age + 1
};
}
case 'changed_name': {
// ✅ 修复:创建一个新的对象
return {
...state,
name: action.nextName
};
}
// ...
}
}
在 dispatch 后 state 的某些属性变为了 undefined {/a-part-of-my-reducer-state-becomes-undefined-after-dispatching/}
请确保每个 case 语句中所返回的新的 state 都复制了当前的属性:
js {5}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
return {
...state, // 不要忘记复制之前的属性!
age: state.age + 1
};
}
// ...
如果上面的代码没有 ...state ,返回的新的 state 就只有 age 属性。
在 dispatch 后整个 state 都变为了 undefined {/my-entire-reducer-state-becomes-undefined-after-dispatching/}
如果 state 错误地变成了 undefined,可能是因为忘记了在某个分支返回 state,或者遗漏了某些 case 分支。可以通过在 switch 语句之后抛出一个错误来查找原因:
js {10}
function reducer(state, action) {
switch (action.type) {
case 'incremented_age': {
// ...
}
case 'edited_name': {
// ...
}
}
throw Error('未知的 action:' + action.type);
}
也可以通过使用 TypeScript 等静态检查工具来发现这类错误。
我收到了一个报错:“Too many re-renders” {/im-getting-an-error-too-many-re-renders/}
可能会收到这样一条报错信息:Too many re-renders. React limits the number of renders to prevent an infinite loop.。这通常是在 渲染期间 dispatch 了 action 而导致组件进入了无限循环:dispatch(会导致一次重新渲染)、渲染、dispatch(再次导致重新渲染),然后无限循环。大多数这样的错误是由于事件处理函数中存在错误的逻辑:
js {1-2}
// 🚩 错误:渲染期间调用了处理函数
return <button onClick={handleClick()}>点击我</button>
// ✅ 修复:传递一个处理函数,而不是调用
return <button onClick={handleClick}>点击我</button>
// ✅ 修复:传递一个内联的箭头函数
return <button onClick={(e) => handleClick(e)}>点击我</button>
如果没有发现上述错误,在控制台点开报错旁边的箭头以查看错误堆栈,从中查找是哪个 dispatch 函数引发的错误。
我的 reducer 和初始化函数运行了两次 {/my-reducer-or-initializer-function-runs-twice/}
严格模式 下 React 会调用两次 reducer 和初始化函数,但是这不应该会破坏代码逻辑。
这个 仅限于开发模式 的行为可以帮助 保持组件纯粹:React 会使用其中一次调用结果并忽略另一个结果。如果组件、初始化函数以及 reducer 函数都是纯函数,这并不会影响逻辑。不过一旦它们存在副作用,这个额外的行为就可以帮助发现它。
比如下面这个 reducer 函数直接修改了数组类型的 state:
js {4-6}
function reducer(state, action) {
switch (action.type) {
case 'added_todo': {
// 🚩 错误:直接修改 state
state.todos.push({ id: nextId++, text: action.text });
return state;
}
// ...
}
}
因为 React 会调用 reducer 函数两次,导致看到添加了两条代办事项,于是发现了这个错误行为。在这个示例中,可以通过 返回新的数组而不是修改数组 来修复它:
js {4-11}
function reducer(state, action) {
switch (action.type) {
case 'added_todo': {
// ✅ 修复:返回一个新的 state 数组
return {
...state,
todos: [
...state.todos,
{ id: nextId++, text: action.text }
]
};
}
// ...
}
}
现在这个 reducer 是纯函数了,调用两次也不会有不一致的行为。这就是 React 如何通过调用两次函数来帮助发现错误。只有组件、初始化函数和 reducer 函数需要是纯函数。事件处理函数不需要实现为纯函数,并且 React 永远不会调用事件函数两次。
阅读 保持组件纯粹 以了解更多相关信息。
帮助我们改进文档
发现翻译问题或内容错误?请告诉我们。
