Skip to content

debounce 防抖 ​

17:43

说明 ​

$u.debounce 接收回调和等待时间,返回一个防抖函数:延迟模式下每次调用重新计时,停止调用 wait 毫秒后才执行最后一次;立即模式下首次调用立刻执行,等待期内的后续调用被忽略。

示例 ​

普通点击(无防抖) ​

对照组:每次点击都立即计数并记录时间,用于和防抖后的执行次数对比。

查看源码
vue
<template>
    <ux-cell-group :border="false">
        <ux-cell-item title="点击次数" :value="clickCount" :arrow="false" />
        <ux-cell-item title="最近点击时间" :value="lastClickTime.length > 0 ? lastClickTime : '-'" :arrow="false" :border-bottom="false" />
    </ux-cell-group>
    <ux-gap :height="8" />
    <ux-button size="small" type="primary" block text="普通点击" @click="onClick()" />
</template>

<script setup lang="ts">
const clickCount = ref(0);
const lastClickTime = ref('');

function onClick(): void {
    clickCount.value++;
    lastClickTime.value = new Date().toLocaleTimeString();
}
</script>

防抖点击(延迟执行) ​

immediate 为 false,连续点击会不断重置计时器,停止点击 500ms 后才执行一次。

查看源码
vue
<template>
    <ux-cell-group :border="false">
        <ux-cell-item title="触发次数" :value="clickCount" :arrow="false" />
        <ux-cell-item title="实际执行次数" :value="executeCount" :arrow="false" />
        <ux-cell-item title="最近执行时间" :value="lastExecuteTime.length > 0 ? lastExecuteTime : '-'" :arrow="false" :border-bottom="false" />
    </ux-cell-group>
    <ux-gap :height="8" />
    <ux-button size="small" type="primary" block text="防抖点击(500ms)" @click="onClick()" />
</template>

<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';

const clickCount = ref(0);
const executeCount = ref(0);
const lastExecuteTime = ref('');

// 防抖函数只创建一次,跨点击复用
const debouncedFn = $u.debounce((): void => {
    executeCount.value++;
    lastExecuteTime.value = new Date().toLocaleTimeString();
}, 500, false);

function onClick(): void {
    clickCount.value++;
    debouncedFn();
}
</script>

防抖点击(立即执行) ​

immediate 为 true,首次点击立即执行,500ms 内的后续点击被丢弃,因此执行次数明显少于点击次数。

查看源码
vue
<template>
    <ux-cell-group :border="false">
        <ux-cell-item title="实际执行次数" :value="executeCount" :arrow="false" :border-bottom="false" />
    </ux-cell-group>
    <ux-gap :height="8" />
    <ux-button size="small" type="primary" block text="立即执行(500ms)" @click="onClick()" />
</template>

<script setup lang="ts">
import { $u } from '@/uni_modules/uview-pro-x';

const executeCount = ref(0);

// immediate 为 true:首次点击立即执行,等待期内的后续点击被丢弃
const immediateFn = $u.debounce((): void => {
    executeCount.value++;
}, 500, true);

function onClick(): void {
    immediateFn();
}
</script>

API ​

参数 ​

参数说明类型默认值版本
func要执行的回调() => void--
wait等待时间(ms)number500-
immediate是否在首次调用时立即执行booleanfalse-

返回值 ​

类型说明
() => void防抖后的函数,不接收参数也没有返回值

注意事项 ​

  • immediate 为 false 时,每次调用都会清掉上一次计时器,窗口结束后只执行最后一次回调。
  • immediate 为 true 时,首次调用立即执行,wait 时间内的后续调用全部被忽略。
  • 返回的函数需要保存引用复用;每次调用 $u.debounce 都会创建一组独立计时器。
  • 返回的函数没有取消方法,离开页面后计时器仍会按原计划触发回调。