30-seconds-of-react 实战:useInterval Hook——以声明式写法优雅封装 setInterval
30-seconds-of-react 实战:useInterval Hook——以声明式写法优雅封装 setInterval
导读
useInterval 是 30-seconds-of-react 仓库中一个极具代表性的自定义 Hook,它把命令式的 setInterval() 调用封装成符合 React 心智模型的声明式接口,让"定时执行回调"这件事在组件渲染、卸载与依赖变化时都能自动、正确地管理。本文以仓库中的 use-interval.md 为骨架,结合同仓库的 useTimeout、useEventListener、count-down 等实现,讲透其设计原理、完整代码、运行示例与实战注意事项。读完本文,你将能独立实现并驾驭一个健壮的 useInterval,并将其迁移到轮询、倒计时、轮播等真实业务场景。
一、为什么需要 useInterval:setInterval 在 React 中的"三宗罪"
在函数组件里直接调用 setInterval(),几乎必然踩中以下问题:
- 丢失最新闭包:interval 回调在创建时捕获了当时的
callback,而组件每次渲染都会产生新的函数,旧闭包中的 state 会逐渐过期; - 缺少自动清理:组件卸载后定时器仍在运行,回调继续访问已卸载组件的 state,轻则浪费资源,重则触发 React 警告甚至内存泄漏;
- 依赖管理混乱:定时器的间隔
delay变化时,旧定时器不会自动重建,导致行为与预期不符。
useInterval 用两个 useEffect() 加一个 useRef(),把这三个问题一次性解决,这正是 use-interval.md 给出的核心思路。
二、核心实现:两段 Effect + 一个 Ref
仓库 use-interval.md 中的完整实现如下:
const useInterval = (callback, delay) => {
const savedCallback = React.useRef();
React.useEffect(() => {
savedCallback.current = callback;
}, [callback]);
React.useEffect(() => {
const tick = () => {
savedCallback.current();
}
if (delay !== null) {
let id = setInterval(tick, delay);
return () => clearInterval(id);
}
}, [delay]);
};
拆解其工作方式,正好对应原文档给出的四步设计:
useRef()创建savedCallback:用一个可变的 ref 容器存放回调函数,它是"永远拿到最新回调"的关键;- 第一个
useEffect依赖<a href="https://link.gitcode.com/i/b7614acfce529ef46927d5bd8a6d307a" target="_blank">callback]:每当callback引用变化(即每次组件渲染产生新函数时)就更新savedCallback.current,保证 interval 内部永远调用最新版本的回调,彻底规避闭包过期问题。这一"ref 缓存最新回调"的手法,与仓库中 [use-event-listener.md 的savedHandler、use-timeout.md 的savedCallback完全同构,属于 30-seconds-of-react 里定时类与事件类 Hook 的通用范式; - 第二个
useEffect依赖[delay]:在组件挂载时及delay变化时创建setInterval(tick, delay),并返回清理函数clearInterval(id)。React 会在下一次 effect 运行前以及组件卸载时自动调用该清理函数,从而做到"定时器随 delay 重建、随卸载销毁"; delay !== null守卫:当delay为null时跳过定时器创建,等价于"暂停"。这为按条件启停留出了天然接口,稍后实战会用到。
需要特别说明的是,effect 的清理函数返回形式与仓库 CONTRIBUTING.md 中"仅在有清理需求时返回函数"的编码规范一致——这里必须返回 clearInterval(id),否则组件卸载后定时器仍会存活。
三、运行示例:一个每秒跳动的计时器
use-interval.md 同时给出了开箱即用的示例:一个每秒自增、渲染当前秒数的 Timer 组件。
const Timer = props => {
const [seconds, setSeconds] = React.useState(0);
useInterval(() => {
setSeconds(seconds + 1);
}, 1000);
return <p>{seconds}</p>;
};
ReactDOM.createRoot(document.getElementById('root')).render(
<Timer />
);
该示例严格遵循仓库 snippet-template.md 的编排:第一段代码块给出 Hook 定义,第二段代码块给出使用示例,并以 ReactDOM.createRoot(...).render(...) 作为挂载入口。注意示例中使用的是 React.useState 的全限定写法,这是仓库所有 Hook 类 snippet 的统一风格,便于在无导入语句的演示环境中直接运行。
需要指出的是,示例中 setSeconds(seconds + 1) 依赖闭包内的 seconds。由于 savedCallback 始终指向最新渲染的回调,这里的 seconds 也是最新的,因此可以正常工作;不过更稳妥的写法是使用函数式更新 setSeconds(s => s + 1),这在使用间隔较短、更新频繁的场景下能避免任何潜在的陈旧值问题。
四、与姊妹 Hook 的横向对比:useTimeout 与原生写法
useInterval 并非孤例,仓库中 use-timeout.md 实现了几乎一模一样的 useTimeout:
const useTimeout = (callback, delay) => {
const savedCallback = React.useRef();
React.useEffect(() => {
savedCallback.current = callback;
}, [callback]);
React.useEffect(() => {
const tick = () => {
savedCallback.current();
}
if (delay !== null) {
let id = setTimeout(tick, delay);
return () => clearTimeout(id);
}
}, [delay]);
};
两者的差异只有一个关键点:setInterval/clearInterval 与 setTimeout/clearTimeout。useInterval 按固定间隔反复触发,useTimeout 只触发一次;其余结构(双 Effect、ref 缓存、delay !== null 守卫、清理函数)完全一致。这一对比恰好说明:在 React 中管理任何定时器,核心难点从来不是定时器 API 本身,而是"何时重建、何时清理、如何拿到最新回调"这三件事。
若不做封装、直接在组件里使用原生写法,可对照仓库 count-down.md 中 CountDown 组件的做法:它在 useEffect() 内创建 setInterval(() => tick(), 1000) 并返回 clearInterval(timerID)。这种写法在单个组件内可行,但一旦出现多个依赖不同 delay 或需要暂停/恢复的定时器,代码会迅速膨胀且容易漏掉清理,这正是自定义 Hook 的封装价值所在。
五、实战扩展:暂停控制、轮询与轮播
5.1 用 delay 为 null 实现暂停/恢复
得益于 delay !== null 守卫,暂停逻辑只需把 delay 设为 null,恢复只需传回数值:
const Timer = () => {
const [seconds, setSeconds] = React.useState(0);
const [paused, setPaused] = React.useState(false);
useInterval(() => {
setSeconds(s => s + 1);
}, paused ? null : 1000);
return (
<div>
<p>{seconds}s</p>
<button onClick={() => setPaused(p => !p)}>
{paused ? 'Resume' : 'Pause'}
</button>
</div>
);
};
当 paused 为 true 时,第二个 effect 因 delay 变化而重建,此时 delay 为 null 不创建定时器,effect 不返回清理函数,定时器自然停止;恢复时同理自动重启。暂停/恢复的交互模式与仓库 count-down.md 中的 paused 状态变量设计一脉相承。
5.2 轻量轮询:定时刷新数据
把回调换成异步请求即可实现定时轮询。仍建议在回调内使用函数式更新并做好竞态兜底:
const useInterval = (callback, delay) => {
const savedCallback = React.useRef();
React.useEffect(() => { savedCallback.current = callback; }, [callback]);
React.useEffect(() => {
const tick = () => savedCallback.current();
if (delay !== null) {
let id = setInterval(tick, delay);
return () => clearInterval(id);
}
}, [delay]);
};
const PollingComponent = () => {
const [data, setData] = React.useState(null);
useInterval(async () => {
const res = await fetch('/api/status');
const json = await res.json();
setData(json);
}, 5000);
return <pre>{JSON.stringify(data, null, 2)}</pre>;
};
5.3 自动轮播:与仓库 Carousel 思路对照
仓库 carousel.md 的 Carousel 组件使用 setTimeout 每 2 秒推进一次 active 索引:setActive((active + 1) % carouselItems.length)。若希望轮播"永不中断、自动循环",只需把同样的逻辑放进 useInterval 的回调中,delay 即轮播间隔,天然具备"delay 变化即重启"的能力,比在组件内手动管理 scrollInterval 更简洁。
六、使用要点与常见误区
- 依赖数组必须精确:第二个 effect 的依赖是
[delay],不要漏写依赖,也不要改成空数组,否则定时器将永不更新间隔或无法清理; - 不要在回调里依赖过期的 props/state:虽然
savedCallback会拿到最新回调,但若回调本身用普通写法捕获了旧值,仍可能读到陈旧数据,优先使用函数式更新(如setSeconds(s => s + 1)); delay为0是合法值:setInterval(cb, 0)会以接近浏览器最小节流间隔运行,应避免在真实业务中使用;null才是"暂停"的约定值,这与 use-timeout.md 中的约定保持一致;- 清理函数是防泄漏的最后防线:第二个 effect 的
return () => clearInterval(id)保证组件卸载时定时器被清除,这一点在仓库的计时类、事件类 snippet 中均有体现; - 多实例互不影响:
useRef为每个组件实例独立持有,多个组件各自调用useInterval时定时器彼此隔离。
七、源码级延伸:从 useInterval 看 30-seconds-of-react 的 Hook 家族
从源码结构看,useInterval 与仓库其他 Hook 共享了一套成熟的"ref 缓存最新值 + effect 管理生命周期"模式:
- use-timeout.md:
savedCallback+ 双 effect,逻辑与useInterval逐行对应; - use-event-listener.md:
savedHandler缓存 handler,效果与useInterval的savedCallback完全同构; - use-component-did-mount.md 与 use-component-will-unmount.md:通过空依赖数组的 effect 模拟生命周期钩子,是理解"effect 清理函数何时触发"的最佳入门材料;
- use-debounce.md:用
setTimeout+clearTimeout清理实现防抖,与useInterval的清理哲学一致。
这种"一法通、百法通"的复用模式,正是 30-seconds-of-react 这类 snippet 库的价值:每段代码都短小精悍、可直接复制到业务中使用,同时又能作为理解 React Hooks 组合规律的教科书式范例。仓库 README.md 也印证了其定位——"Short React code snippets for all your development needs",useInterval 正是其中把"定时"这一高频需求压缩到 20 行以内的代表之作。