大家都能看得懂的源碼之Ahooks UseInfiniteScroll
簡(jiǎn)介
useInfiniteScroll 封裝了常見(jiàn)的無(wú)限滾動(dòng)邏輯。
詳細(xì)可看官網(wǎng)[3]
注意:這里的無(wú)限滾動(dòng)指的是常見(jiàn)的點(diǎn)擊加載更多或者說(shuō)下拉加載更加功能,而不是虛擬滾動(dòng),虛擬滾動(dòng)后面會(huì)講到。
實(shí)現(xiàn)原理
實(shí)現(xiàn)原理:使用了 useRequest[4] hook 負(fù)責(zé)進(jìn)行請(qǐng)求后臺(tái)數(shù)據(jù)。其中 reloadAsync 對(duì)應(yīng) useRequest 的 runAsync,reload 對(duì)應(yīng) useRequest 的 run。前者返回 Promise,需要自行處理異常。后者內(nèi)部已經(jīng)做了異常處理。
另外假如傳入 target 和 isNoMore 參數(shù),通過(guò)監(jiān)聽(tīng) scroll 事件,判斷是否滾動(dòng)到指定的位置(支持設(shè)置 threshold 值-距離底部距離閾值),進(jìn)行自動(dòng)發(fā)起加載更多請(qǐng)求,從而實(shí)現(xiàn)滾動(dòng)自動(dòng)加載效果。
大概說(shuō)完原理,來(lái)看代碼。
具體實(shí)現(xiàn)
入?yún)⒁约盃顟B(tài)定義,可以直接看注釋?zhuān)?/p>
const useInfiniteScroll = <TData extends Data>(
// 請(qǐng)求服務(wù)
service: Service<TData>,
options: InfiniteScrollOptions<TData> = {},
) => {
const {
// 父級(jí)容器,如果存在,則在滾動(dòng)到底部時(shí),自動(dòng)觸發(fā) loadMore。需要配合 isNoMore 使用,以便知道什么時(shí)候到最后一頁(yè)了。
target,
// 是否有最后一頁(yè)的判斷邏輯,入?yún)楫?dāng)前聚合后的 data
isNoMore,
// 下拉自動(dòng)加載,距離底部距離閾值
threshold = 100,
// 變化后,會(huì)自動(dòng)觸發(fā) reload
reloadDeps = [],
// 默認(rèn) false。 即在初始化時(shí)自動(dòng)執(zhí)行 service。
// 如果設(shè)置為 true,則需要手動(dòng)調(diào)用 reload 或 reloadAsync 觸發(fā)執(zhí)行。
manual,
// service 執(zhí)行前觸發(fā)
onBefore,
// 執(zhí)行后
onSuccess,
// service reject 時(shí)觸發(fā)
onError,
// service 執(zhí)行完成時(shí)觸發(fā)
onFinally,
} = options;
// 最終的數(shù)據(jù)
const [finalData, setFinalData] = useState<TData>();
// 是否loading more
const [loadingMore, setLoadingMore] = useState(false);
// 省略代碼...
};
判斷是否有數(shù)據(jù):isNoMore 的入?yún)⑹钱?dāng)前聚合后的 data。
// 判斷是否還有數(shù)據(jù)
const noMore = useMemo(() => {
if (!isNoMore) return false;
return isNoMore(finalData);
}, [finalData]);
通過(guò) useRequest 處理請(qǐng)求,可以看到 onBefore、onSuccess、onError、onFinally、manual 等參數(shù)都是直接傳到了 useRequest 中。
// 通過(guò) useRequest 處理請(qǐng)求
const { loading, run, runAsync, cancel } = useRequest(
// 入?yún)?,將上次?qǐng)求返回的數(shù)據(jù)整合到新的參數(shù)中
async (lastData?: TData) => {
const currentData = await service(lastData);
// 首次請(qǐng)求,則直接設(shè)置
if (!lastData) {
setFinalData(currentData);
} else {
setFinalData({
...currentData,
// service 返回的數(shù)據(jù)必須包含 list 數(shù)組,類(lèi)型為 { list: any[], ...rest }
// @ts-ignore
list: [...lastData.list, ...currentData.list],
});
}
return currentData;
},
{
// 是否手動(dòng)控制
manual,
// 請(qǐng)求結(jié)束
onFinally: (_, d, e) => {
// 設(shè)置 loading 為 false
setLoadingMore(false);
onFinally?.(d, e);
},
// 請(qǐng)求前
onBefore: () => onBefore?.(),
// 請(qǐng)求成功之后
onSuccess: d => {
setTimeout(() => {
// eslint-disable-next-line @typescript-eslint/no-use-before-define
scrollMethod();
});
onSuccess?.(d);
},
onError: e => onError?.(e),
},
);
loadMore/loadMoreAsync 和 reload/reloadAsync 分別對(duì)應(yīng)調(diào)用的是 useRequest 的 run 和 runAsync 函數(shù)。
// 同步加載更多
const loadMore = () => {
// 假如沒(méi)有更多,直接返回
if (noMore) return;
setLoadingMore(true);
// 執(zhí)行 useRequest
run(finalData);
};
// 異步加載更多,返回的值是 Promise,需要自行處理異常
const loadMoreAsync = () => {
if (noMore) return Promise.reject();
setLoadingMore(true);
return runAsync(finalData);
};
const reload = () => run();
const reloadAsync = () => runAsync();
并且當(dāng) reloadDeps 依賴(lài)發(fā)生變化的時(shí)候,會(huì)觸發(fā) reload,進(jìn)行重置:
useUpdateEffect(() => {
run();
}, [...reloadDeps]);
最后就是滾動(dòng)自動(dòng)加載的邏輯,通過(guò) scrollHeight - scrollTop <= clientHeight + threshold 結(jié)果判斷是否觸底。
// 滾動(dòng)方法
const scrollMethod = () => {
const el = getTargetElement(target);
if (!el) {
return;
}
// Element.scrollTop 屬性可以獲取或設(shè)置一個(gè)元素的內(nèi)容垂直滾動(dòng)的像素?cái)?shù)。
const scrollTop = getScrollTop(el);
// Element.scrollHeight 這個(gè)只讀屬性是一個(gè)元素內(nèi)容高度的度量,包括由于溢出導(dǎo)致的視圖中不可見(jiàn)內(nèi)容。
const scrollHeight = getScrollHeight(el);
// 這個(gè)屬性是只讀屬性,對(duì)于沒(méi)有定義CSS或者內(nèi)聯(lián)布局盒子的元素為0,否則,它是元素內(nèi)部的高度(單位像素),包含內(nèi)邊距,但不包括水平滾動(dòng)條、邊框和外邊距。
const clientHeight = getClientHeight(el);
// 根據(jù)上面三個(gè)值以及 threshold 判斷是否進(jìn)行加載更多
if (scrollHeight - scrollTop <= clientHeight + threshold) {
loadMore();
}
};
// 監(jiān)聽(tīng)滾動(dòng)事件
useEventListener(
'scroll',
() => {
if (loading || loadingMore) {
return;
}
scrollMethod();
},
{ target },
);
上面提到的三個(gè)重要的值 scrollTop,scrollHeight,clientHeight 對(duì)應(yīng)的值分別為以下結(jié)果:
scrollTop[5]
Element.scrollTop 屬性可以獲取或設(shè)置一個(gè)元素的內(nèi)容垂直滾動(dòng)的像素?cái)?shù)。一個(gè)元素的 scrollTop 值是這個(gè)元素的內(nèi)容頂部(卷起來(lái)的)到它的視口可見(jiàn)內(nèi)容(的頂部)的距離的度量。當(dāng)一個(gè)元素的內(nèi)容沒(méi)有產(chǎn)生垂直方向的滾動(dòng)條,那么它的 scrollTop 值為 0。
scrollHeight[6]
Element.scrollTop 屬性可以獲取或設(shè)置一個(gè)元素的內(nèi)容垂直滾動(dòng)的像素?cái)?shù)。一個(gè)元素的 scrollTop 值是這個(gè)元素的內(nèi)容頂部(卷起來(lái)的)到它的視口可見(jiàn)內(nèi)容(的頂部)的距離的度量。當(dāng)一個(gè)元素的內(nèi)容沒(méi)有產(chǎn)生垂直方向的滾動(dòng)條,那么它的 scrollTop 值為 0。
clientHeight[7]
這個(gè)屬性是只讀屬性,對(duì)于沒(méi)有定義 CSS 或者內(nèi)聯(lián)布局盒子的元素為 0,否則,它是元素內(nèi)部的高度 (單位像素),包含內(nèi)邊距,但不包括水平滾動(dòng)條、邊框和外邊距。clientHeight 可以通過(guò) CSS height + CSS padding - 水平滾動(dòng)條高度 (如果存在) 來(lái)計(jì)算。
本文已收錄到個(gè)人博客[8]中。
參考資料
[1]地址: https://gpingfeng.github.io/ahooks-analysis/
[2] star: https://github.com/GpingFeng/ahooks-analysis
[3]官網(wǎng): https://ahooks.gitee.io/zh-CN/hooks/use-infinite-scroll
[4]useRequest: https://ahooks.gitee.io/zh-CN/hooks/use-request/index
[5]scrollTop: https://developer.mozilla.org/zh-CN/docs/Web/API/Element/scrollTop
[6]scrollHeight: https://developer.mozilla.org/zh-CN/docs/Web/API/Element/scrollHeight
[7]clientHeight: https://developer.mozilla.org/zh-CN/docs/Web/API/Element/clientHeight
[8]博客: https://github.com/GpingFeng/gopal-blog?