JavaScript專題之跟著underscore學防抖

冴羽發表於2017-06-02
JavaScript

JavaScript 專題系列第一篇，講解防抖，帶你從零實現一個 underscore 的 debounce 函式

前言

在前端開發中會遇到一些頻繁的事件觸發，比如：

  1. window 的 resize、scroll
  2. mousedown、mousemove
  3. keyup、keydown
    ……

為此，我們舉個示例程式碼來了解事件如何頻繁的觸發：

我們寫個 index.html 檔案：

<!DOCTYPE html>
<html lang="zh-cmn-Hans">

<head>
    <meta charset="utf-8">
    <meta http-equiv="x-ua-compatible" content="IE=edge, chrome=1">
    <title>debounce</title>
    <style>
        #container{
            width: 100%; height: 200px; line-height: 200px; text-align: center; color: #fff; background-color: #444; font-size: 30px;
        }
    </style>
</head>

<body>
    <div id="container"></div>
    <script src="debounce.js"></script>
</body>

</html>複製程式碼

debounce.js 檔案的程式碼如下：

var count = 1;
var container = document.getElementById('container');

function getUserAction() {
    container.innerHTML = count++;
};


container.onmousemove = getUserAction;複製程式碼

我們來看看效果：

JavaScript專題之跟著underscore學防抖
debounce

從左邊滑到右邊就觸發了 165 次 getUserAction 函式！

因為這個例子很簡單，所以瀏覽器完全反應的過來，可是如果是複雜的回撥函式或是 ajax 請求呢？假設 1 秒觸發了 60 次，每個回撥就必須在 1000 / 60 = 16.67ms 內完成，否則就會有卡頓出現。

為了解決這個問題，一般有兩種解決方案：

  1. debounce 防抖
  2. throttle 節流

防抖

今天重點講講防抖的實現。

防抖的原理就是：你儘管觸發事件，但是我一定在事件觸發 n 秒後才執行，如果你在一個事件觸發的 n 秒內又觸發了這個事件，那我就以新的事件的時間為準，n 秒後才執行，總之，就是要等你觸發完事件 n 秒內不再觸發事件，我才執行，真是任性吶!

第一版

根據這段表述，我們可以寫第一版的程式碼：

// 第一版
function debounce(func, wait) {
    var timeout;
    return function () {
        clearTimeout(timeout)
        timeout = setTimeout(func, wait);
    }
}複製程式碼

如果我們要使用它，以最一開始的例子為例：

container.onmousemove = debounce(getUserAction, 1000);複製程式碼

現在隨你怎麼移動，反正你移動完 1000ms 內不再觸發，我再執行事件。

頓時就從 165 次降低成了 1 次!

棒棒噠，我們接著完善它。

this

如果我們在 getUserAction 函式中 console.log(this)，在不使用 debounce 函式的時候，this 的值為：

<div id="container"></div>複製程式碼

但是如果使用我們的 debounce 函式，this 就會指向 Window 物件！

所以我們需要將 this 指向正確的物件。

我們修改下程式碼：

// 第二版
function debounce(func, wait) {
    var timeout;

    return function () {
        var context = this;

        clearTimeout(timeout)
        timeout = setTimeout(function(){
            func.apply(context)
        }, wait);
    }
}複製程式碼

現在 this 已經可以正確指向了。讓我們看下個問題：

event 物件

JavaScript 在事件處理函式中會提供事件物件 event，我們修改下 getUserAction 函式：

function getUserAction(e) {
    console.log(e);
    container.innerHTML = count++;
};複製程式碼

如果我們不使用 debouce 函式，這裡會列印 MouseEvent 物件，如圖所示：

JavaScript專題之跟著underscore學防抖
MouseEvent

但是在我們實現的 debounce 函式中，卻只會列印 undefined!

所以我們再修改一下程式碼：

// 第三版
function debounce(func, wait) {
    var timeout;

    return function () {
        var context = this;
        var args = arguments;

        clearTimeout(timeout)
        timeout = setTimeout(function(){
            func.apply(context, args)
        }, wait);
    }
}複製程式碼

返回值

再注意一個小點，getUserAction 函式可能是有返回值的，所以我們也要返回函式的執行結果

// 第四版
function debounce(func, wait) {
    var timeout, result;

    return function () {
        var context = this;
        var args = arguments;

        clearTimeout(timeout)
        timeout = setTimeout(function(){
            result = func.apply(context, args)
        }, wait);

        return result;
    }
}複製程式碼

到此為止，我們修復了三個小問題：

  1. this 指向
  2. event 物件
  3. 返回值

立刻執行

這個時候，程式碼已經很是完善，但是為了讓這個函式更加完善，我們接下來思考一個新的需求。

這個需求就是：

我不希望非要等到事件停止觸發後才執行，我希望立刻執行函式，然後等到停止觸發n秒後，才可以重新觸發執行。

想想這個需求也是很有道理的嘛，那我們加個 immediate 引數判斷是否是立刻執行。

// 第五版
function debounce(func, wait, immediate) {

    var timeout, result;

    return function () {
        var context = this;
        var args = arguments;

        if (timeout) clearTimeout(timeout);
        if (immediate) {
            // 如果已經執行過，不再執行
            var callNow = !timeout;
            timeout = setTimeout(function(){
                timeout = null;
            }, wait)
            if (callNow) result = func.apply(context, args)
        }
        else {
            timeout = setTimeout(function(){
                result = func.apply(context, args)
            }, wait);
        }

        return result;
    }
}複製程式碼

取消

最後我們再思考一個小需求，我希望能取消 debounce 函式，比如說我 debounce 的時間間隔是 10 秒鐘，immediate 為 true，這樣的話，我只有等 10 秒後才能重新觸發事件，現在我希望有一個按鈕，點選後，取消防抖，這樣我再去觸發，就可以又立刻執行啦，是不是很開心？

為了這個需求，我們寫最後一版的程式碼：

// 第六版
function debounce(func, wait, immediate) {

    var timeout, result;

    var debounced = function () {
        var context = this;
        var args = arguments;

        if (timeout) clearTimeout(timeout);
        if (immediate) {
            // 如果已經執行過，不再執行
            var callNow = !timeout;
            timeout = setTimeout(function(){
                timeout = null;
            }, wait)
            if (callNow) result = func.apply(context, args)
        }
        else {
            timeout = setTimeout(function(){
                result = func.apply(context, args)
            }, wait);
        }
        return result;
    };

    debounced.cancel = function() {
        clearTimeout(timeout);
        timeout = null;
    };

    return debounced;
}複製程式碼

演示效果如下：

JavaScript專題之跟著underscore學防抖
debounce-cancel

至此我們已經完整實現了一個 underscore 中的 debounce 函式，恭喜，撒花！

專題系列

JavaScript專題系列目錄地址：github.com/mqyqingfeng…。

JavaScript專題系列預計寫二十篇左右，主要研究日常開發中一些功能點的實現，比如防抖、節流、去重、型別判斷、拷貝、最值、扁平、柯里、遞迴、亂序、排序等，特點是研(chao)究(xi) underscore 和 jQuery 的實現方式。

如果有錯誤或者不嚴謹的地方，請務必給予指正，十分感謝。如果喜歡或者有所啟發，歡迎star，對作者也是一種鼓勵。

相關文章