IntersectionObserver API实现虚拟列表滚动

最新推荐文章于 2024-05-28 14:27:53 发布

csdn_poxiao

最新推荐文章于 2024-05-28 14:27:53 发布

阅读量290

点赞数

文章标签： javascript 开发语言 ecmascript

本文链接：https://blog.csdn.net/csdn_poxiao/article/details/133657163

版权

前言
在本篇文章你将会学到：

IntersectionObserver API 的用法，以及如何兼容。
如何在React Hook中实现无限滚动。
如何正确渲染多达10000个元素的列表。

无限下拉加载技术使用户在大量成块的内容面前一直滚动查看。这种方法是在你向下滚动的时候不断加载新内容。
当你使用滚动作为发现数据的主要方法时，它可能使你的用户在网页上停留更长时间并提升用户参与度。随着社交媒体的流行，大量的数据被用户消费。无线滚动提供了一个高效的方法让用户浏览海量信息，而不必等待页面的预加载。

如何构建一个体验良好的无限滚动，是每个前端无论是项目或面试都会碰到的一个课题。

本文的原版实现来自：Creating Infinite Scroll with 15 Elements

1. 早期的解决方案
关于无限滚动，早期的解决方案基本都是依赖监听scroll事件：

function fetchData() {
fetch(path).then(res => doSomeThing(res.data));
}

window.addEventListener('scroll', fetchData);
1
2
3
4
5
然后计算各种.scrollTop()、.offset().top等等。
手写一个也是非常枯燥。而且：

scroll事件会频繁触发，因此我们还需要手动节流。
滚动元素内有大量DOM，容易造成卡顿。
后来出现交叉观察者IntersectionObserver API ，在与Vue、React这类数据驱动视图的框架后，无限滚动的通用方案就出来了。

2. 交叉观察者：IntersectionObserver
const box = document.querySelector('.box');
const intersectionObserver = new IntersectionObserver((entries) => {
entries.forEach((item) => {
if (item.isIntersecting) {
console.log('进入可视区域');
}
})
});
intersectionObserver.observe(box);
1
2
3
4
5
6
7
8
9
敲重点：IntersectionObserver API是异步的，不随着目标元素的滚动同步触发，性能消耗极低。

2.1 IntersectionObserverEntry对象

这里我就粗略的介绍下需要用到的：

IntersectionObserverEntry对象

callback函数被调用时，会传给它一个数组，这个数组里的每个对象就是当前进入可视区域或者离开可视区域的对象(IntersectionObserverEntry对象)

这个对象有很多属性，其中最常用的属性是：

target: 被观察的目标元素，是一个 DOM 节点对象
isIntersecting: 是否进入可视区域
intersectionRatio: 相交区域和目标元素的比例值，进入可视区域，值大于0，否则等于0
2.3 options
调用IntersectionObserver时，除了传一个回调函数，还可以传入一个option对象，配置如下属性：

threshold: 决定了什么时候触发回调函数。它是一个数组，每个成员都是一个门槛值，默认为[0]，即交叉比例（intersectionRatio）达到0时触发回调函数。用户可以自定义这个数组。比如，[0, 0.25, 0.5, 0.75, 1]就表示当目标元素 0%、25%、50%、75%、100% 可见时，会触发回调函数。
root: 用于观察的根元素，默认是浏览器的视口，也可以指定具体元素，指定元素的时候用于观察的元素必须是指定元素的子元素
rootMargin: 用来扩大或者缩小视窗的的大小，使用css的定义方法，10px 10px 30px 20px表示top、right、bottom 和 left的值
const io = new IntersectionObserver((entries) => {
console.log(entries);
}, {
threshold: [0, 0.5],
root: document.querySelector('.container'),
rootMargin: "10px 10px 30px 20px",
});
1
2
3
4
5
6
7
2.4 observer
observer.observer（nodeone）; //仅观察nodeOne
observer.observer（nodeTwo）; //观察nodeOne和nodeTwo
observer.unobserve（nodeOne）; //停止观察nodeOne
observer.disconnect（）; //没有观察任何节点
1
2
3
4
3. 如何在React Hook中使用IntersectionObserver
在看Hooks版之前，来看正常组件版的：

class SlidingWindowScroll extends React.Component {
this.$bottomElement = React.createRef();
...
componentDidMount() {
this.intiateScrollObserver();
}
intiateScrollObserver = () => {
const options = {
root: null,
rootMargin: '0px',
threshold: 0.1
};
this.observer = new IntersectionObserver(this.callback, options);
this.observer.observe(this.$bottomElement.current);
}
render() {
return (
<li className='img' ref={this.$bottomElement}>
)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
众所周知，React 16.x后推出了useRef来替代原有的createRef，用于追踪DOM节点。那让我们开始吧：

4. 原理
实现一个组件，可以显示具有15个元素的固定窗口大小的n个项目的列表：
即在任何时候，无限滚动n元素上也仅存在15个DOM节点。

采用relative/absolute定位来确定滚动位置
追踪两个ref: top/bottom来决定向上/向下滚动的渲染与否
切割数据列表，保留最多15个DOM元素。
5. useState声明状态变量
我们开始编写组件SlidingWindowScrollHook:

const THRESHOLD = 15;
const SlidingWindowScrollHook = (props) => {
const [start, setStart] = useState(0);
const [end, setEnd] = useState(THRESHOLD);
const [observer, setObserver] = useState(null);
// 其它代码...
}
1
2
3
4
5
6
7
useState的简单理解:
const [属性, 操作属性的方法] = useState(默认值);
1
变量解析
start：当前渲染的列表第一个数据，默认为0
end: 当前渲染的列表最后一个数据，默认为15
observer: 当前观察的视图ref元素
6. useRef定义追踪的DOM元素
const $bottomElement = useRef();
const $topElement = useRef();
1
2
正常的无限向下滚动只需关注一个dom元素，但由于我们是固定15个dom元素渲染，需要判断向上或向下滚动。

7. 内部操作方法和和对应useEffect
请配合注释食用：

useEffect(() => {
// 定义观察
intiateScrollObserver();
return () => {
// 放弃观察
resetObservation()
}
},[end]) //因为[end] 是同步刷新，这里用一个就行了。

// 定义观察
const intiateScrollObserver = () => {
const options = {
root: null,
rootMargin: '0px',
threshold: 0.1
};
const Observer = new IntersectionObserver(callback, options)
// 分别观察开头和结尾的元素
if ($topElement.current) {
Observer.observe($topElement.current);
}
if ($bottomElement.current) {
Observer.observe($bottomElement.current);
}
// 设初始值
setObserver(Observer)
}

// 交叉观察的具体回调，观察每个节点，并对实时头尾元素索引处理
const callback = (entries, observer) => {
entries.forEach((entry, index) => {
const listLength = props.list.length;
// 向下滚动，刷新数据
if (entry.isIntersecting && entry.target.id === "bottom") {
const maxStartIndex = listLength - 1 - THRESHOLD; // 当前头部的索引
const maxEndIndex = listLength - 1; // 当前尾部的索引
const newEnd = (end + 10) <= maxEndIndex ? end + 10 : maxEndIndex; // 下一轮增加尾部
const newStart = (end - 5) <= maxStartIndex ? end - 5 : maxStartIndex; // 在上一轮的基础上计算头部
setStart(newStart)
setEnd(newEnd)
}
// 向上滚动，刷新数据
if (entry.isIntersecting && entry.target.id === "top") {
const newEnd = end === THRESHOLD ? THRESHOLD : (end - 10 > THRESHOLD ? end - 10 : THRESHOLD); // 向上滚动尾部元素索引不得小于15
let newStart = start === 0 ? 0 : (start - 10 > 0 ? start - 10 : 0); // 头部元素索引最小值为0
setStart(newStart)
setEnd(newEnd)
}
});
}

// 停止滚动时放弃观察
const resetObservation = () => {
observer && observer.unobserve($bottomElement.current);
observer && observer.unobserve($topElement.current);
}

// 渲染时，头尾ref处理
const getReference = (index, isLastIndex) => {
if (index === 0)
return $topElement;
if (isLastIndex)
return $bottomElement;
return null;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
8. 渲染界面
const {list, height} = props; // 数据，节点高度
const updatedList = list.slice(start, end); // 数据切割

const lastIndex = updatedList.length - 1;
return (
<ul style={{position: 'relative'}}>
{updatedList.map((item, index) => {
const top = (height * (index + start)) + 'px'; // 基于相对 & 绝对定位计算
const refVal = getReference(index, index === lastIndex); // map循环中赋予头尾ref
const id = index === 0 ? 'top' : (index === lastIndex ? 'bottom' : ''); // 绑ID
return (<li className="li-card" key={item.key} style={{top}} ref={refVal} id={id}>{item.value}</li>);
})}
</ul>
);
1
2
3
4
5
6
7
8
9
10
11
12
13
14
9. 如何使用
App.js:

import React from 'react';
import './App.css';
import { SlidingWindowScrollHook } from "./SlidingWindowScrollHook";
import MY_ENDLESS_LIST from './Constants';

function App() {
return (
<div className="App">
<h1>15个元素实现无限滚动</h1>
<SlidingWindowScrollHook list={MY_ENDLESS_LIST} height={195}/>
</div>
);
}

export default App;
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
定义一下数据Constants.js:

const MY_ENDLESS_LIST = [
{
key: 1,
value: 'A'
},
{
key: 2,
value: 'B'
},
{
key: 3,
value: 'C'
},
// 中间就不贴了...
{
key: 45,
value: 'AS'
}
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
SlidingWindowScrollHook.js:

import React, { useState, useEffect, useRef } from "react";
const THRESHOLD = 15;

const SlidingWindowScrollHook = (props) => {
const [start, setStart] = useState(0);
const [end, setEnd] = useState(THRESHOLD);
const [observer, setObserver] = useState(null);
const $bottomElement = useRef();
const $topElement = useRef();

useEffect(() => {
intiateScrollObserver();
return () => {
resetObservation()
}
// eslint-disable-next-line react-hooks/exhaustive-deps
},[start, end])

const getReference = (index, isLastIndex) => {
if (index === 0)
return $topElement;
if (isLastIndex)
return $bottomElement;
return null;
}

const {list, height} = props;
const updatedList = list.slice(start, end);
const lastIndex = updatedList.length - 1;

return (
<ul style={{position: 'relative'}}>
{updatedList.map((item, index) => {
const top = (height * (index + start)) + 'px';
const refVal = getReference(index, index === lastIndex);
const id = index === 0 ? 'top' : (index === lastIndex ? 'bottom' : '');
return (<li className="li-card" key={item.key} style={{top}} ref={refVal} id={id}>{item.value}</li>);
})}
</ul>
);
}
export { SlidingWindowScrollHook };
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
以及少许样式：

.li-card {
display: flex;
justify-content: center;
list-style: none;
box-shadow: 2px 2px 9px 0px #bbb;
padding: 70px 0;
margin-bottom: 20px;
border-radius: 10px;
position: absolute;
width: 80%;
}
1
2
3
4
5
6
7
8
9
10
11
然后你就可以慢慢耍了。。。