js節(jié)流函數(shù)

前言

《JavaScript專題之跟著underscore學(xué)防抖》中,我們了解了為什么要限制事件的頻繁觸發(fā),以及如何做限制:

  1. debounce 防抖
  2. throttle 節(jié)流

今天重點講講節(jié)流的實現(xiàn)。

節(jié)流

節(jié)流的原理很簡單:

如果你持續(xù)觸發(fā)事件,每隔一段時間,只執(zhí)行一次事件。

根據(jù)首次是否執(zhí)行以及結(jié)束后是否執(zhí)行,效果有所不同,實現(xiàn)的方式也有所不同。
我們用 leading 代表首次是否執(zhí)行,trailing 代表結(jié)束后是否再執(zhí)行一次。

關(guān)于節(jié)流的實現(xiàn),有兩種主流的實現(xiàn)方式,一種是使用時間戳,一種是設(shè)置定時器。

使用時間戳

讓我們來看第一種方法:使用時間戳,當(dāng)觸發(fā)事件的時候,我們?nèi)〕霎?dāng)前的時間戳,然后減去之前的時間戳(最一開始值設(shè)為 0 ),如果大于設(shè)置的時間周期,就執(zhí)行函數(shù),然后更新時間戳為當(dāng)前的時間戳,如果小于,就不執(zhí)行。

看了這個表述,是不是感覺已經(jīng)可以寫出代碼了…… 讓我們來寫第一版的代碼:

// 第一版
function throttle(func, wait) {
    var context, args;
    var previous = 0;

    return function() {
        var now = +new Date();
        context = this;
        args = arguments;
        if (now - previous > wait) {
            func.apply(context, args);
            previous = now;
        }
    }
}

例子依然是用講 debounce 中的例子,如果你要使用:

container.onmousemove = throttle(getUserAction, 1000);

效果演示如下:

image.png

我們可以看到:當(dāng)鼠標(biāo)移入的時候,事件立刻執(zhí)行,每過 1s 會執(zhí)行一次,如果在 4.2s 停止觸發(fā),以后不會再執(zhí)行事件。

使用定時器

接下來,我們講講第二種實現(xiàn)方式,使用定時器。

當(dāng)觸發(fā)事件的時候,我們設(shè)置一個定時器,再觸發(fā)事件的時候,如果定時器存在,就不執(zhí)行,直到定時器執(zhí)行,然后執(zhí)行函數(shù),清空定時器,這樣就可以設(shè)置下個定時器。

// 第二版
function throttle(func, wait) {
    var timeout;
    var previous = 0;

    return function() {
        context = this;
        args = arguments;
        if (!timeout) {
            timeout = setTimeout(function(){
                timeout = null;
                func.apply(context, args)
            }, wait)
        }

    }
}

為了讓效果更加明顯,我們設(shè)置 wait 的時間為 3s,效果演示如下:

image.png

我們可以看到:當(dāng)鼠標(biāo)移入的時候,事件不會立刻執(zhí)行,晃了 3s 后終于執(zhí)行了一次,此后每 3s 執(zhí)行一次,當(dāng)數(shù)字顯示為 3 的時候,立刻移出鼠標(biāo),相當(dāng)于大約 9.2s 的時候停止觸發(fā),但是依然會在第 12s 的時候執(zhí)行一次事件。

所以比較兩個方法:

  1. 第一種事件會立刻執(zhí)行,第二種事件會在 n 秒后第一次執(zhí)行
  2. 第一種事件停止觸發(fā)后沒有辦法再執(zhí)行事件,第二種事件停止觸發(fā)后依然會再執(zhí)行一次事件

雙劍合璧

那我們想要一個什么樣的呢?

有人就說了:我想要一個有頭有尾的!就是鼠標(biāo)移入能立刻執(zhí)行,停止觸發(fā)的時候還能再執(zhí)行一次!

所以我們綜合兩者的優(yōu)勢,然后雙劍合璧,寫一版代碼:

// 第三版
function throttle(func, wait) {
    var timeout, context, args, result;
    var previous = 0;

    var later = function() {
        previous = +new Date();
        timeout = null;
        func.apply(context, args)
    };

    var throttled = function() {
        var now = +new Date();
        //下次觸發(fā) func 剩余的時間
        var remaining = wait - (now - previous);
        context = this;
        args = arguments;
         // 如果沒有剩余的時間了或者你改了系統(tǒng)時間
        if (remaining <= 0 || remaining > wait) {
            if (timeout) {
                clearTimeout(timeout);
                timeout = null;
            }
            previous = now;
            func.apply(context, args);
        } else if (!timeout) {
            timeout = setTimeout(later, remaining);
        }
    };
    return throttled;
}

效果演示如下:

image.png

我們可以看到:鼠標(biāo)移入,事件立刻執(zhí)行,晃了 3s,事件再一次執(zhí)行,當(dāng)數(shù)字變成 3 的時候,也就是 6s 后,我們立刻移出鼠標(biāo),停止觸發(fā)事件,9s 的時候,依然會再執(zhí)行一次事件。

優(yōu)化

但是我有時也希望無頭有尾,或者有頭無尾,這個咋辦?

那我們設(shè)置個 options 作為第三個參數(shù),然后根據(jù)傳的值判斷到底哪種效果,我們約定:

leading:false 表示禁用第一次執(zhí)行
trailing: false 表示禁用停止觸發(fā)的回調(diào)

我們來改一下代碼:

// 第四版
function throttle(func, wait, options) {
    var timeout, context, args, result;
    var previous = 0;
    if (!options) options = {};

    var later = function() {
        previous = options.leading === false ? 0 : new Date().getTime();
        timeout = null;
        func.apply(context, args);
        if (!timeout) context = args = null;
    };

    var throttled = function() {
        var now = new Date().getTime();
        if (!previous && options.leading === false) previous = now;
        var remaining = wait - (now - previous);
        context = this;
        args = arguments;
        if (remaining <= 0 || remaining > wait) {
            if (timeout) {
                clearTimeout(timeout);
                timeout = null;
            }
            previous = now;
            func.apply(context, args);
            if (!timeout) context = args = null;
        } else if (!timeout && options.trailing !== false) {
            timeout = setTimeout(later, remaining);
        }
    };
    return throttled;
}

取消

在 debounce 的實現(xiàn)中,我們加了一個 cancel 方法,throttle 我們也加個 cancel 方法:

// 第五版 非完整代碼,完整代碼請查看最后的演示代碼鏈接
...
throttled.cancel = function() {
    clearTimeout(timeout);
    previous = 0;
    timeout = null;
}
...

注意

我們要注意 underscore 的實現(xiàn)中有這樣一個問題:

那就是 leading:falsetrailing: false 不能同時設(shè)置。

如果同時設(shè)置的話,比如當(dāng)你將鼠標(biāo)移出的時候,因為 trailing 設(shè)置為 false,停止觸發(fā)的時候不會設(shè)置定時器,所以只要再過了設(shè)置的時間,再移入的話,就會立刻執(zhí)行,就違反了 leading: false,bug 就出來了,所以,這個 throttle 只有三種用法:

container.onmousemove = throttle(getUserAction, 1000);
container.onmousemove = throttle(getUserAction, 1000, {
    leading: false
});
container.onmousemove = throttle(getUserAction, 1000, {
    trailing: false
});

至此我們已經(jīng)完整實現(xiàn)了一個 underscore 中的 throttle 函數(shù),恭喜,撒花!

演示代碼

相關(guān)的代碼可以在 Github 博客倉庫 中找到

專題系列

JavaScript專題系列目錄地址:https://github.com/mqyqingfeng/Blog。

轉(zhuǎn)自: https://github.com/mqyqingfeng/Blog/issues/26

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容