手寫防抖、節流 hook(ts版)

節流與防抖都是通過延遲執行,減少調用次數,來優化頻繁調用函數時的性能。不同的是,對于一段時間內的頻繁調用,防抖是 延遲執行 一次調用,節流是 延遲定時 多次調用

前言

不知道有多少人,簡單的寫了防抖、節流函數,然后遇到在 react hook 里失效的情況。

失效的原因: 每次 render 時,內部函數會重新生成并綁定到組件上去。

解決方案:也很簡單,使用 useCallback ,依賴傳入空數組,保證 useCallback 永遠返回同一個函數。

上面呢,算是這個文章的一個契機吧。

關于手寫防抖和節流的思路,個人認為關鍵在于都是對 閉包高階函數 的應用,以這個為切入點去思考,手寫的時候就不會腦子一片空白了。

防抖(debounce)

觸發事件后在 n 秒內函數只能執行一次,如果在 n 秒內又觸發了事件,則會重新計算函數執行時間。

初步
import { useCallback } from 'react';
/**
 * 防抖hook
 * @param func 需要執行的函數
 * @param wait 延遲時間
 */
export function useDebounce<A extends Array<any>, R = void>(
  func: (..._args: A) => R,
  wait: number,
) {
  let timeOut: null | NodeJS.Timeout = null;
  function debounced(..._args: A) {
    if (timeOut) {
      clearTimeout(timeOut);
      timeOut = null;
    }
    timeOut = setTimeout(() => {
      fn.apply(null, _args);
    }, wait);
  }
  return useCallback(debounced, []);
}

這可以用,但并不夠好。想要進階更高級的工程師,就需要將問題再想深一層,考慮到更復雜的情況,從而自身得到成長。

進階版
  1. 首先想到的是要返回一個 Promise ,用來傳遞返回值。
  2. 其次考慮到異步的情況,增加 async。
  3. 最后是防抖化之后是否可以立即執行和取消,所以增加2個新函數。
import { useCallback } from 'react';
/**
 * 防抖hook
 * @param func 需要執行的函數
 * @param wait 延遲時間
 */
export function useDebounce<A extends Array<any>, R = void>(
  func: (..._args: A) => R,
  wait: number,
) {
  let timeOut: null | NodeJS.Timeout = null;
  let args: A;
  function debounce(..._args: A) {
    args = _args;
    if (timeOut) {
      clearTimeout(timeOut);
      timeOut = null;
    }
    return new Promise<R>((resolve, reject) => {
      timeOut = setTimeout(async () => {
        try {
          const result = await func.apply(null, args);
          resolve(result);
        } catch (e) {
          reject(e);
        }
      }, wait);
    });
  }
  //取消
  function cancel() {
    if (!timeOut) return;
    clearTimeout(timeOut);
    timeOut = null;
  }
  //立即執行
  function flush() {
    cancel();
    return func.apply(null, args);
  }
  debounce.flush = flush;
  debounce.cancel = flush;
  return useCallback(debounce, []);
}

關于防抖函數還有功能更豐富的版本,可以看下 lodashdebounce 函數

節流(throttle)

連續觸發事件但是在 n 秒中只執行一次函數

節流函數的2種思路
  • 時間戳:通過記錄上次執行的時間戳, 和當前時間戳比較來判斷是否已到執行時間 ,如果是則執行,并更新上次執行的時間戳。(問題在于:事件停止觸發時無法執行函數)

  • 定時器:如果已經存在定時器,則不執行方法,直到定時器觸發后被清除,然后重新設置定時器。(問題在于:事件停止觸發后必然會再執行函數)

整合版

把兩個整合一下,根據場景、需求等來決定,最后是否需要事件停止觸發后定時器執行函數。

/**
 * 節流hook
 * @param func 需要執行的函數
 * @param wait 延遲時間
 * @param isTimer 是否開啟定時器響應事件結束后的回調
 */
export function useThrottle<A extends Array<any>, R = void>(
  func: (..._args: A) => R,
  wait: number,
  isTimer: boolean = false,
) {
  let timeOut: null | NodeJS.Timeout = null;
  let args: A;
  let agoTimestamp: number;
  function throttle(..._args: A) {
    args = _args;
    if (!agoTimestamp) agoTimestamp = +new Date();
    if (timeOut) {
      clearTimeout(timeOut);
      timeOut = null;
    }
    return new Promise<R>((resolve, reject) => {
      if (+new Date() - agoTimestamp >= wait) {
        try {
          const result = func.apply(null, args);
          resolve(result);
          agoTimestamp = +new Date();
        } catch (e) {
          reject(e);
        }
      } else if (isTimer) {
        timeOut = setTimeout(async () => {
          try {
            const result = await func.apply(null, args);
            resolve(result);
            agoTimestamp = +new Date();
          } catch (e) {
            reject(e);
          }
        }, agoTimestamp + wait - +new Date());
      }
    });
  }
  //取消
  function cancel() {
    if (!timeOut) return;
    clearTimeout(timeOut);
    timeOut = null;
  }
  //立即執行
  function flush() {
    cancel();
    return func.apply(null, args);
  }
  throttle.flush = flush;
  throttle.cancel = flush;
  return useCallback(throttle, []);
}

最后

有個地方有人可能有疑問,為什么沒去用 useRef 去保存 timeOut 呢?

有人可能會認為這會有問題:因為每次組件重新渲染,都會執行一遍所有的 hooks,這樣 useDebounce 高階函數里面的 timeOut 就不能起到緩存的作用(在 useDebounce 里 console.log(timeOut),每次 render 時都打印出 null)。所以 timeOut 不可靠,防抖的核心就被破壞了。

但是呢,如果你在里面的函數 debounce 里 console.log(timeOut) 會發現,打印出來的,就是之前的 timeOut ,所以是沒問題的。

最后,寫的過程中,ts 才是我真正花費時間思考的地方。完成后,有點微妙的滿足感。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,797評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,179評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,628評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,642評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,444評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,948評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,040評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,185評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,717評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,794評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,418評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,414評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,750評論 2 370

推薦閱讀更多精彩內容

  • 本篇文章主要介紹防抖和節流的原理,以及它們的區別。 防抖與節流的問題總是會在面試中出現(然而我并沒有遇到),如果你...
    黑色瓶子閱讀 1,118評論 0 3
  • 1. 認識防抖和節流 1.1. 對防抖和節流的認識 防抖和節流的概念其實最早并不是出現在軟件工程中,防抖是出現在電...
    AShuiCoder閱讀 1,127評論 0 10
  • 節流(throttle)與防抖(debounce) 場景 因頻繁執行DOM操作,資源加載等行為,導致UI停頓甚至瀏...
    學編程的小屁孩閱讀 495評論 0 0
  • 有些瀏覽器事件可以在短時間內快速觸發多次,比如調整窗口大小或向下滾動頁面。例如,監聽頁面窗口滾動事件,并且用戶持續...
    劉其瑞閱讀 2,614評論 0 1
  • 在上周的開發中,又遇到點擊保存多次請求數據重復的問題,所以下來學習了一下js的防抖和節流。通過學習了解到,在進行窗...
    any_5637閱讀 398評論 0 2