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

複製代碼