Infinte Scroll with Vue / Intersection Observer API

三步了解并实现无限滚动加载 feat.Vue / Intersection Observer API

前言

最近工作中接触了不少界面开发,其中一个需求是实现「无限滚动加载功能」。这是一种常见的加载策略,广泛应用于 Facebook、Instagram、Twitter、Pinterest……等主流网站。当用户滚动到页面底部时,页面会自动加载更多数据,无需点击按钮就能浏览更多内容,就像自动触发的加载按钮。

分页、无限滚动、加载按钮示例

工作中使用的是 Options API,不过这次示例会用 Composition API 来实现,同样的逻辑也可以应用于任何程序或框架。

实现

既然叫滚动「加载」,就意味着通常需要向第三方请求数据。不过,示例中会简化这一流程,只需编写一个返回模拟数据的函数。这样,getCards 函数就可以通过传入 limitsPerPage 和 currentPage 来生成对应的卡片数据。

/**
* @param {number} limitsPerPage 每页数据量
* @param {number} currentPage 当前页码
* @returns {Array} 模拟卡片数据
*/
function getCards(limitsPerPage, currentPage) {
return Array.from({ length: limitsPerPage }, () => ({ title: currentPage.toString() }));
}
getCards(3, 2); // [{ title: '2' }, { title: '2' }, { title: '2' }]

定义问题与执行流程

无限加载无非就是自动检测用户是否滚动到「无限加载组件」的底部,并触发加载操作,因此可以将需求进一步细化为以下几点:

  1. 如果加载后组件仍在可视范围内,则持续加载,直到组件移出可视范围
  2. 如果加载后组件已在可视范围外,则停止加载
  3. 超过 x 页就完全停止加载

为了判断目标组件是否在可视范围内,可以制作一个通用组件来进行检测并触发事件,也就是接下来要编写的 Observer.vue 组件。

第一步:编写 Observer.vue 检测组件

早期获取 DOM 元素的位置通常会使用 getBoundingClientRect(),不过,考虑到性能、可读性以及 API 的用途,使用 Intersection Observer API 会是更好的选择。

Intersection Observer API 自 2019 年起就已得到各大浏览器的广泛支持🔗,主要用于监测 DOM 元素是否进入或离开另一个 DOM 元素或浏览器的视口范围,并且可以通过设置阈值来触发相应的事件。

在列表底部放置一个没有内容和样式的元素,并设置为:「当元素与视口的相交状态发生变化时(离开/进入)」,就触发 Vue 自定义事件,执行相关代码。具体来说,封装好的 Observer.vue 组件如下:

<script setup>
import { ref, onMounted, onBeforeUnmount, defineProps, defineEmits } from 'vue';
const { observerOptions } = defineProps(['observerOptions']);
const emit = defineEmits(['is-in-view', 'is-outside-view']);
const target = ref(null);
const observer = ref(null);
const emitInView = () => {
emit('is-in-view');
};
const emitOutsideView = () => {
emit('is-outside-view');
};
onMounted(() => {
observer.value = new IntersectionObserver((entries) => {
if (entries[0].isIntersecting) {
emitInView();
} else {
emitOutsideView();
}
}, observerOptions);
observer.value.observe(target.value);
});
onBeforeUnmount(() => {
console.log('distory');
observer.value.disconnect();
});
</script>
<template>
<div ref="target" class="target"></div>
</template>

代码与思路都很简单:在空 <div> 元素挂载时创建一个新的 IntersectionObserver 实例,触发相应的事件,并在组件销毁时断开 IntersectionObserver 实例的观察。然后将这个组件引入无限加载列表的底部,就可以通过 @is-in-view 事件来触发加载操作。

<template>
<ul class="cards"></ul>
<Observer
v-if="!(infinteScrollOptions.currentPage > infinteScrollOptions.maxPage)"
@is-in-view="handleIsInView"
@is-outside-view="handleIsOutsideView"
/>
</template>

第二步:设置必要参数

无限加载列表需要以下状态,可以在开头定义并初始化:

  • maxPage 最大页数
  • limitsPerPage 每页数据量
  • currentPage 当前页码
  • isInView 是否在可视范围内
const infinteScrollOptions = {
maxPage: 10,
limitsPerPage: 1,
currentPage: 1,
isInView: false
}

然后创建第一批响应式数据。这里我在卡片中放入了随机的 picsum🔗 图片,并使用 index 作为图片的 ID(可以随意放入任何你想展示的数据):

<script setup>
import { ref } from "vue"
const cards = ref(getCards(infinteScrollOptions.limitsPerPage, infinteScrollOptions.currentPage))
<script>
<template>
<ul class="cards">
<li class="card" v-for="(card, index) in cards">
<img :src="`https://picsum.photos/id/${index}/300/300`" width="300" height="300" alt="Random Image">
<p>
#图片:{{ index }}
</p>
</li>
</ul>
<template>

第三步:无限加载逻辑

接下来,在 Observer.vue 触发事件时,通过切换 isInView 的状态来决定是否继续加载,并且只有当 Observer 组件处于可视范围内时,才会主动触发加载。

加载过程中特意使用了 lodash 的 throttle 节流函数来控制加载频率,使其每 300 毫秒最多触发一次,目的是:

  1. 避免加载的内容还没有渲染到页面上,就因列表仍未填满可视区域而反复触发加载
  2. 避免用户频繁滚动时过度触发加载请求,导致性能问题

关于节流,可以参考我之前写的介绍文章:通过动图轻松理解:防抖与节流,其中有动画演示实际效果。

import { throttle } from 'lodash';
function handleIsInView() {
infinteScrollOptions.isInView = true;
handleLoadmore();
}
function handleIsOutsideView() {
infinteScrollOptions.isInView = false;
}
const handleLoadmore = throttle(
function (options = infinteScrollOptions) {
const { limitsPerPage, currentPage, isInView, maxPage } = options;
if (currentPage > maxPage) return;
const newCurrentPage = currentPage + 1;
infinteScrollOptions.currentPage = newCurrentPage;
const newCards = getCards(limitsPerPage, newCurrentPage);
cards.value = [...cards.value, ...newCards];
if (isInView) {
handleLoadmore();
}
},
300,
{ leading: true, trailing: true },
);

结语

到这里,基本的无限加载功能已经完成。过程中涉及的加载中、加载失败等状态,可以根据需求自行调整,这里就不再展开介绍。示例代码可以在 GitHub 上下载🔗。

这是一个很实用的练习题目,尤其是在实现更进阶的「无限滚动搜索功能」时,会遇到很多需要管理的状态。有空的话,我或许会再写一篇进阶版文章,介绍我是如何一步步推导出最终方案的。

程序运行效果

如果你有更好的想法或发现了任何问题,欢迎在下方留言讨论。我很有兴趣尝试或探讨不同的设计方式,比如:更符合不可变性(Immutable)的写法、有限状态机、状态模式(State Pattern)!

延伸阅读