定时器在页面最小化时不执行实现示例

目录

引言useInterval 和 useTimeoutsetTimeout 和 setInterval 的问题useRafInterval 和 useRafTimeout

setRafIntervalclearRafInterval

思考与总结

引言

本文是深入浅出 ahooks 源码系列文章的第七篇，这个系列的目标主要有以下几点：

加深对 React hooks 的理解。学习如何抽象自定义 hooks。构建属于自己的 React hooks 工具库。培养阅读学习源码的习惯，工具库是一个对源码阅读不错的选择。

注：本系列对 ahooks 的源码解析是基于 v3.3.13。自己 folk 了一份源码，主要是对源码做了一些解读，可见 详情。
今天我们来聊聊定时器。

useInterval 和 useTimeout

看名称，我们就能大概知道，它们的功能对应的是 setInterval 和 setTimeout，那对比后者有什么优势？
先看 useInterval，代码简单，如下所示：

1. function useInterval(
2.   fn: () => void,
3.   delay: number | undefined,
4.   options?: {
5.     immediate?: boolean;
6.   },
7. ) {
8.   const immediate = options?.immediate;
9.   const fnRef = useLatest(fn);
10.   useEffect(() => {
11.     // 忽略部分代码...
12.     // 立即执行
13.     if (immediate) {
14.       fnRef.current();
15.     }
16.     const timer = setInterval(() => {
17.       fnRef.current();
18.     }, delay);
19.     // 清除定时器
20.     return () => {
21.       clearInterval(timer);
22.     };
23.     // 动态修改 delay 以实现定时器间隔变化与暂停。
24.   }, [delay]);
25. }

复制代码

跟 setInterval 的区别如下：

可以支持第三个参数，通过 immediate 能够立即执行我们的定时器。在变更 delay 的时候，会自动清除旧的定时器，并同时启动新的定时器。通过 useEffect 的返回清除机制，开发者不需要关注清除定时器的逻辑，避免内存泄露问题。这点是很多开发者会忽略的点。

useTimeout 跟上面很类似，如下所示，不再做额外解释：

1. function useTimeout(fn: () => void, delay: number | undefined): void {
2.   const fnRef = useLatest(fn);
3.   useEffect(() => {
4.     // ...忽略部分代码
5.     const timer = setTimeout(() => {
6.       fnRef.current();
7.     }, delay);
8.     return () => {
9.       clearTimeout(timer);
10.     };
11.   // 动态修改 delay 以实现定时器间隔变化与暂停。
12.   }, [delay]);
13. }

复制代码

setTimeout 和 setInterval 的问题

首先，setTimeout 和 setInterval 作为事件循环中宏任务的“两大主力”，它的执行时机不能跟我们预期一样准确的，它需要等待前面任务的执行。比如下面的 setTimeout 的第二个参数设置为 0，并不会立即执行。

1. setTimeout(() => {
2.   console.log('test');
3. }, 0)

复制代码

另外还有一种情况，setTimeout 和 setInterval 在浏览器不可见的时候（比如最小化的时候），不同的浏览器中设置不同的时间间隔的时候，其表现不一样。根据 当浏览器切换到其他标签页或者最小化时，你的js定时器还准时吗？ 这篇文章的实践结论如下：
谷歌浏览器中，当页面处于不可见状态时，setInterval 的最小间隔时间会被限制为 1s。火狐浏览器的 setInterval 和谷歌特性一致，但是 ie 浏览器没有对不可见状态时的 setInterval 进行性能优化，不可见前后间隔时间不变。
在谷歌浏览器中，setTimeout在浏览器不可见状态下间隔低于1s的会变为1s，大于等于1s的会变成N+1s的间隔值。火狐浏览器下setTimeout的最小间隔时间会变为1s,大于等于1s的间隔不变。ie浏览器在不可见状态前后的间隔时间不变。
这个结论，我没有验证过，但看起来差异挺大，其中还提到了另外一个选择，就是 requestAnimationFrame。
window.requestAnimationFrame() 告诉浏览器——你希望执行一个动画，并且要求浏览器在下次重绘之前调用指定的回调函数更新动画。该方法需要传入一个回调函数作为参数，该回调函数会在浏览器下一次重绘之前执行
为了提高性能和电池寿命，因此在大多数浏览器里，当requestAnimationFrame() 运行在后台标签页或者隐藏的 <iframe> 里时，requestAnimationFrame() 会被暂停调用以提升性能和电池寿命。
所以，ahooks 也提供了使用 requestAnimationFrame 进行模拟定时器处理的 hook，我们一起来看下。

useRafInterval 和 useRafTimeout

直接看 useRafInterval。（useRafTimeout 和 useRafInterval 类似，这里不展开细说）。

1. function useRafInterval(
2.   fn: () => void,
3.   delay: number | undefined,
4.   options?: {
5.     immediate?: boolean;
6.   },
7. ) {
8.   const immediate = options?.immediate;
9.   const fnRef = useLatest(fn);
10.   useEffect(() => {
11.     // 省略部分代码...
12.     const timer = setRafInterval(() => {
13.       fnRef.current();
14.     }, delay);
15.     return () => {
16.       clearRafInterval(timer);
17.     };
18.   }, [delay]);
19. }

复制代码

可以看到，跟前面的 useInterval 大部分代码逻辑都是一样的，只是定时使用了 setRafInterval 方法，清除定时器用了 clearRafInterval。

setRafInterval

直接上代码：

1. const setRafInterval = function (callback: () => void, delay: number = 0): Handle {
2.   if (typeof requestAnimationFrame === typeof undefined) {
3.     // 如果不支持，还是使用 setInterval
4.     return {
5.       id: setInterval(callback, delay),
6.     };
7.   }
8.   // 开始时间
9.   let start = new Date().getTime();
10.   const handle: Handle = {
11.     id: 0,
12.   };
13.   const loop = () => {
14.     const current = new Date().getTime();
15.     // 当前时间 - 开始时间，大于设置的间隔，则执行，并重置开始时间
16.     if (current - start >= delay) {
17.       callback();
18.       start = new Date().getTime();
19.     }
20.     handle.id = requestAnimationFrame(loop);
21.   };
22.   handle.id = requestAnimationFrame(loop);
23.   return handle;
24. };

复制代码

首先是用 typeof 判断进行兼容逻辑处理，假如不兼容，则兜底使用 setInterval。
初始记录一个 start 的时间。
在 requestAnimationFrame 回调中，判断现在的时间减去开始时间有没有达到间隔，假如达到则执行我们的 callback 函数。更新开始时间。

clearRafInterval

清除定时器。

1. function cancelAnimationFrameIsNotDefined(t: any): t is NodeJS.Timer {
2.   return typeof cancelAnimationFrame === typeof undefined;
3. }
4. // 清除定时器
5. const clearRafInterval = function (handle: Handle) {
6.   if (cancelAnimationFrameIsNotDefined(handle.id)) {
7.     return clearInterval(handle.id);
8.   }
9.   cancelAnimationFrame(handle.id);
10. };

复制代码

假如不支持 cancelAnimationFrame API，则通过 clearInterval 清除，支持则直接使用 cancelAnimationFrame 清除。

思考与总结

关于定时器，我们平时用得不少，但经常有同学容易忘记清除定时器，结合 useEffect 返回清除副作用函数这个特性，我们可以将这类逻辑一起封装到 hook 中，让开发者使用更加方便。
另外，假如希望在页面不可见的时候，不执行定时器，可以选择 useRafInterval 和 useRafTimeout，其内部是使用 requestAnimationFrame 进行实现。
以上就是定时器在页面最小化时不执行实现示例的详细内容，更多关于定时器页面最小化不执行的资料请关注中国红客联盟其它相关文章！