IT博客汇
  • 首页
  • 精华
  • 技术
  • 设计
  • 资讯
  • 扯淡
  • 权利声明
  • 登录 注册

    JavaScript专题之跟着underscore学防抖

    冴羽发表于 2017-06-02 20:15:18
    love 0

    前言

    在前端开发中会遇到一些频繁的事件触发,比如:

    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;

    我们来看看效果:

    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 对象,如图所示:

    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;
    }

    演示效果如下:

    debounce-cancel

    至此我们已经完整实现了一个 underscore 中的 debounce 函数,恭喜,撒花!

    专题系列

    JavaScript专题系列目录地址:https://github.com/mqyqingfeng/Blog。

    JavaScript专题系列预计写二十篇左右,主要研究日常开发中一些功能点的实现,比如防抖、节流、去重、类型判断、拷贝、最值、扁平、柯里、递归、乱序、排序等,特点是研(chao)究(xi) underscore 和 jQuery 的实现方式。

    如果有错误或者不严谨的地方,请务必给予指正,十分感谢。如果喜欢或者有所启发,欢迎star,对作者也是一种鼓励。



沪ICP备19023445号-2号
友情链接