VUI建立日志(二)——防抖节流组件的实现

时间 2019-11-05

标签 vui 建立日志节流组件实现繁體版

原文原文链接

1. 项目实现介绍

vue 项目搭建参考《Webpack4 搭建 Vue 项目》html

文档使用 vuepress, 官方文档 vuepress.vuejs.org前端

发布文档 github pages + gh-pagevue

项目地址 github.com/zxpsuper/vu…node

文档地址 zxpsuper.github.io/vui-vuewebpack

组件地址 zxpsuper.github.io/vui-vue/com…git

处于自我摸索阶段，期待留下您的宝贵意见！github

2. Throttle 组件的实现

首先，写一个防抖节流的通用函数

/** * @param {function} func 执行函数 * @param {number} time 防抖节流时间 * @param {boolean} isDebounce 是否为防抖组件 * @param {this} ctx this 的指向 */
const debounce = (func, time, isDebounce, ctx) => {
    var timer, lastCall, rtn;
    if (isDebounce) {
        rtn = (...params) => {
            if (timer) clearTimeout(timer);
            timer = setTimeout(() => {
                func.apply(ctx, params);
            }, time);
        };
    } else {
        rtn = (...params) => {
            const now = new Date().getTime();
            if (now - lastCall < time && lastCall) return;
            lastCall = now;
            func.apply(ctx, params);
        };
    }
    return rtn;
};
复制代码

使用抽象组件

export default {
    name: 'Throttle',
    abstract: true,
    props: {
        time: {
            type: Number,
            default: 800,
        },
        events: {
            type: String,
            default: 'click',
        },
        isDebounce: {
            type: Boolean,
            default: false,
        },
    },
    created() {
        this.eventKeys = this.events.split(','); // 分隔事件
        this.originMap = {}; // 储存事件，用于从新render时与子事件的对比
        this.debouncedMap = {}; // 储存防抖节流事件
    },
    render() {
        const vnode = this.$slots.default[0];
        this.eventKeys.forEach(key => {
            const target = vnode.data.on[key];
            if (target === this.originMap[key] && this.debouncedMap[key]) {
                vnode.data.on[key] = this.debouncedMap[key];
            } else if (target) {
                this.originMap[key] = target;
                this.debouncedMap[key] = debounce(
                    target,
                    this.time,
                    this.isDebounce,
                    vnode
                );
                vnode.data.on[key] = this.debouncedMap[key]; // 重写子组件的事件
            }
        });
        return vnode;
    },
};

复制代码

3. 使用组件

需全局或者组件内注册一下，这里只展现全局注册代码：web

Vue.component("Throttle", Throttle);
复制代码

使用方法：npm

<Throttle :time="5000" isDebounce>
    <span @click="decounceFunction">
        <Button color="purple" light>防抖按钮</Button>
    </span>
</Throttle>
复制代码

4. 存在问题与解决方法

当页面元素在防抖节流时间内发生了更新（渲染）（能够用定时器修改页面，如页面倒计时），那么此组件会从新执行一遍canvas

this.debouncedMap[key] = debounce(target,this.time,this.isDebounce,vnode);
复制代码

致使防抖节流失效，目前的解决方法是在此组件的子元素添加 v-once，以下：

<Throttle :time="5000" isDebounce>
    <span @click="decounceFunction" v-once>
        <Button color="purple" light>防抖按钮</Button>
    </span>
</Throttle>
复制代码

可解决此问题，有更好的方法请在评论区留言

5. 完整代码

/* * @descript: 防抖节流组件，前提是页面在等待时间内无其余渲染方可以使用，从新渲染致使 debounce() 函数不断重置 * @Author: super * @Date: 2019-04-09 14:21:18 * @Last Modified by: super * @Last Modified time: 2019-10-24 16:37:43 */

const debounce = (func, time, isDebounce, ctx) => {
    var timer, lastCall, rtn;
    if (isDebounce) {
        rtn = (...params) => {
            if (timer) clearTimeout(timer);
            timer = setTimeout(() => {
                func.apply(ctx, params);
            }, time);
        };
    } else {
        rtn = (...params) => {
            const now = new Date().getTime();
            if (now - lastCall < time && lastCall) return;
            lastCall = now;
            func.apply(ctx, params);
        };
    }
    return rtn;
};

export default {
    name: 'Throttle',
    abstract: true,
    props: {
        time: {
            type: Number,
            default: 800,
        },
        events: {
            type: String,
            default: 'click',
        },
        isDebounce: {
            type: Boolean,
            default: false,
        },
    },
    created() {
        this.eventKeys = this.events.split(',');
        this.originMap = {};
        this.debouncedMap = {};
    },
    render() {
        const vnode = this.$slots.default[0];
        this.eventKeys.forEach(key => {
            const target = vnode.data.on[key];
            if (target === this.originMap[key] && this.debouncedMap[key]) {
                vnode.data.on[key] = this.debouncedMap[key];
            } else if (target) {
                this.originMap[key] = target;
                this.debouncedMap[key] = debounce(
                    target,
                    this.time,
                    this.isDebounce,
                    vnode
                );
                vnode.data.on[key] = this.debouncedMap[key];
            }
        });
        return vnode;
    },
};

复制代码

总结

本文是对render及抽象组件的使用总结，如有错误，望指出共同进步。