JavaScript中ahooks?處理?DOM?的方法

更新時間：2022年06月22日 09:47:41 作者：Gopal

這篇文章主要介紹了JavaScript中ahooks處理DOM的方法，主要通過ahooks對DOM類Hooks使用規(guī)范，以及源碼中是如何去做處理的，具體詳細(xì)介紹需要的小伙伴可以參考一下下面文章內(nèi)容

前言

目標(biāo)主要有以下幾點：

加深對 React hooks 的理解。
學(xué)習(xí)如何抽象自定義 hooks。構(gòu)建屬于自己的 React hooks 工具庫。
培養(yǎng)閱讀學(xué)習(xí)源碼的習(xí)慣，工具庫是一個對源碼閱讀不錯的選擇。

本篇文章探討一下 ahooks 對 DOM 類 Hooks 使用規(guī)范，以及源碼中是如何去做處理的。

DOM 類 Hooks 使用規(guī)范

這一章節(jié)，大部分參考官方文檔的 DOM 類 Hooks 使用規(guī)范。

第一點，ahooks 大部分 DOM 類 Hooks 都會接收 target 參數(shù)，表示要處理的元素。

target 支持三種類型 React.MutableRefObject（通過 useRef 保存的 DOM）、HTMLElement、() => HTMLElement（一般運用于 SSR 場景）。

第二點，DOM 類 Hooks 的 target 是支持動態(tài)變化的。

如下所示：

export default () => {
  const [boolean, { toggle }] = useBoolean();

  const ref = useRef(null);
  const ref2 = useRef(null);

  const isHovering = useHover(boolean ? ref : ref2);
  return (
    <>
      <div ref={ref}>{isHovering ? 'hover' : 'leaveHover'}</div>
      <div ref={ref2}>{isHovering ? 'hover' : 'leaveHover'}</div>
    </>
  );
};

那 ahooks 是怎么處理這兩點的呢？

getTargetElement

獲取到對應(yīng)的 DOM 元素，這一點主要兼容以上第一點的入?yún)⒁?guī)范。

假如是函數(shù)，則取執(zhí)行完后的結(jié)果。
假如擁有 current 屬性，則取 current 屬性的值，兼容 React.MutableRefObject 類型。
最后就是普通的 DOM 元素。

export function getTargetElement<T extends TargetType>(target: BasicTarget<T>, defaultElement?: T) {
  // 省略部分代碼...
  let targetElement: TargetValue<T>;
  if (isFunction(target)) {
    // 支持函數(shù)獲取
    targetElement = target();
    // 假如 ref，則返回 current
  } else if ('current' in target) {
    targetElement = target.current;
    // 支持 DOM
  } else {
    targetElement = target;
  }

  return targetElement;
}

useEffectWithTarget

這個方法，主要是為了支持第二點，支持 target 動態(tài)變化。

其中 packages/hooks/src/utils/useEffectWithTarget.ts 是使用 useEffect。

import { useEffect } from 'react';
import createEffectWithTarget from './createEffectWithTarget';
const useEffectWithTarget = createEffectWithTarget(useEffect);
export default useEffectWithTarget;

另外其中 packages/hooks/src/utils/useLayoutEffectWithTarget.ts 是使用 useLayoutEffect。

import { useLayoutEffect } from 'react';
import createEffectWithTarget from './createEffectWithTarget';
const useEffectWithTarget = createEffectWithTarget(useLayoutEffect);
export default useEffectWithTarget;

兩者都是調(diào)用的 createEffectWithTarget，只是入?yún)⒉煌?/p>

直接重點看這個 createEffectWithTarget 函數(shù)：

createEffectWithTarget 返回的函數(shù) useEffectWithTarget 接受三個參數(shù)，前兩個跟 useEffect 一樣，第三個就是 target。
useEffectType 就是 useEffect 或者 useLayoutEffect。注意這里調(diào)用的時候，沒傳第二個參數(shù)，也就是每次都會執(zhí)行。
hasInitRef 判斷是否已經(jīng)初始化。lastElementRef 記錄的是最后一次 target 元素的列表。lastDepsRef 記錄的是最后一次的依賴。unLoadRef 是執(zhí)行完 effect 函數(shù)（對應(yīng)的就是 useEffect 中的 effect 函數(shù)）的返回值，在組件卸載的時候執(zhí)行。
第一次執(zhí)行的時候，執(zhí)行相應(yīng)的邏輯，并記錄下最后一次執(zhí)行的相應(yīng)的 target 元素以及依賴。
后面每次執(zhí)行的時候，都判斷目標(biāo)元素或者依賴是否發(fā)生變化，發(fā)生變化，則執(zhí)行對應(yīng)的 effect 函數(shù)。并更新最后一次執(zhí)行的依賴。
組件卸載的時候，執(zhí)行 unLoadRef.current?.() 函數(shù)，并重置 hasInitRef 為 false。

const createEffectWithTarget = (useEffectType: typeof useEffect | typeof useLayoutEffect) => {
  /**
   * @param effect
   * @param deps
   * @param target target should compare ref.current vs ref.current, dom vs dom, ()=>dom vs ()=>dom
   */
  const useEffectWithTarget = (
    effect: EffectCallback,
    deps: DependencyList,
    target: BasicTarget<any> | BasicTarget<any>[],
  ) => {
    const hasInitRef = useRef(false);

    const lastElementRef = useRef<(Element | null)[]>([]);
    const lastDepsRef = useRef<DependencyList>([]);

    const unLoadRef = useRef<any>();

    // useEffect 或者 useLayoutEffect
    useEffectType(() => {
      // 處理 DOM 目標(biāo)元素
      const targets = Array.isArray(target) ? target : [target];
      const els = targets.map((item) => getTargetElement(item));

      // init run
      // 首次初始化的時候執(zhí)行
      if (!hasInitRef.current) {
        hasInitRef.current = true;
        lastElementRef.current = els;
        lastDepsRef.current = deps;
        // 執(zhí)行回調(diào)中的 effect 函數(shù)
        unLoadRef.current = effect();
        return;
      }
      // 非首次執(zhí)行的邏輯
      if (
        // 目標(biāo)元素或者依賴發(fā)生變化
        els.length !== lastElementRef.current.length ||
        !depsAreSame(els, lastElementRef.current) ||
        !depsAreSame(deps, lastDepsRef.current)
      ) {
        // 執(zhí)行上次返回的結(jié)果
        unLoadRef.current?.();

        // 更新
        lastElementRef.current = els;
        lastDepsRef.current = deps;
        unLoadRef.current = effect();
      }
    });
    useUnmount(() => {
      // 卸載
      unLoadRef.current?.();
      // for react-refresh
      hasInitRef.current = false;
    });
  };
  return useEffectWithTarget;
};