useEffect
useEffect
是一个 React Hook,它允许你 将组件与外部系统同步。
useEffect(setup, dependencies?)
参数
setup
:处理 Effect 的函数。setup 函数选择性返回一个 清理(cleanup) 函数。当组件被添加到 DOM 的时候,React 将运行 setup 函数。在每次依赖项变更重新渲染后,React 将首先使用旧值运行 cleanup 函数(如果你提供了该函数),然后使用新值运行 setup 函数。在组件从 DOM 中移除后,React 将最后一次运行 cleanup 函数。- 可选
dependencies
:setup
代码中引用的所有响应式值的列表。响应式值包括 props、state 以及所有直接在组件内部声明的变量和函数。如果你的代码检查工具 配置了 React,那么它将验证是否每个响应式值都被正确地指定为一个依赖项。依赖项列表的元素数量必须是固定的,并且必须像[dep1, dep2, dep3]
这样内联编写。React 将使用Object.is
来比较每个依赖项和它先前的值。如果省略此参数,则在每次重新渲染组件之后,将重新运行 Effect 函数。
返回值
useEffect
返回 undefined
。
基础用法
import React, { useState, useEffect } from 'react';
function Example() {
const [count, setCount] = useState(0);
useEffect(() => {
document.title = `点击了 ${count} 次`;
});
return (
<div>
<p>点击了 {count} 次</p>
<button onClick={() => setCount(count + 1)}>点击我</button>
</div>
);
}
你需要向 useEffect
传递两个参数:
- 一个 setup 函数 ,其 setup 代码 用来连接到该系统。
- 它应该返回一个 清理函数(cleanup),其 cleanup 代码 用来与该系统断开连接。
- 一个 依赖项列表,包括这些函数使用的每个组件内的值。
React 在必要时会调用 setup 和 cleanup,这可能会发生多次:
- 将组件挂载到页面时,将运行 setup 代码。
- 重新渲染依赖项变更的组件后:
- 首先,使用旧的 props 和 state 运行 cleanup 代码。
- 然后,使用新的 props 和 state 运行 setup 代码。
- 当组件从页面卸载后,cleanup 代码 将运行最后一次。
在开发环境下,React 在运行 setup 之前会额外运行一次setup 和 cleanup。这是一个压力测试,用于验证 Effect 逻辑是否正确实现。如果这会导致可见的问题,那么你的 cleanup 函数就缺少一些逻辑。cleanup 函数应该停止或撤消 setup 函数正在执行的任何操作。一般来说,用户不应该能够区分只调用一次 setup(在生产环境中)与调用 setup → cleanup → setup 序列(在开发环境中)。
跳过初始渲染
在某些情况下,当组件首次渲染时,我们不希望立即执行某些操作。这些操作可能包括发送网络请求、触发某些动画或其他任务。而是只有在某个值或依赖项发生变化后,我们才希望执行这些任务。
假设我们有一个count
状态,我们希望当count
值发生变化时显示一个通知,但不希望在组件首次加载时显示这个通知。
import React, { useState, useEffect, useRef } from 'react';
function Counter() {
const [count, setCount] = useState(0);
const mounted = useRef(false);
useEffect(() => {
if (mounted.current) {
alert('Count value changed!');
} else {
mounted.current = true;
}
}, [count]);
return (
<div>
<button onClick={() => setCount(count + 1)}>Increase</button>
<p>Count: {count}</p>
</div>
);
}
export default Counter;