Android 防抖和节流

Android 防抖和节流

概述

• 防抖（Debounce）：
  • 防抖是指在事件被触发后，等待一段时间，如果在这段时间内没有再触发事件，才执行处理函数。如果在这段时间内又触发了事件，就重新开始计时。
  • 场景：适用于频繁触发的事件，如：输入框搜索。
• 节流（Throttle）：
  • 节流是指在一定时间间隔内，无论事件触发多少次，只执行一次处理函数。
  • 场景：适用于限制频率的操作，如：提交按钮。

工具类

object DebounceThrottleUtils {
    private val handler = Handler(Looper.getMainLooper())
    private val debounceMap = ConcurrentHashMap<String, Runnable>()
    private val throttleMap = ConcurrentHashMap<String, Long>()

    /**
     * 防抖
     *  @param key 唯一标识符（建议使用View ID）
     *  @param delayMillis 防抖时间间隔（毫秒）
     *  @param block 要执行的操作
     */
    fun debounce(key: String, delayMillis: Long, block: () -> Unit) {
        // 移除之前的任务
        debounceMap[key]?.let {
            handler.removeCallbacks(it)
            debounceMap.remove(key)
        }
        // 创建新任务
        val runnable = Runnable {
            block()
        }
        debounceMap.put(key, runnable)
        // 延迟执行任务
        handler.postDelayed(runnable, delayMillis)
    }

    /**
     * 节流处理
     * @param key 唯一标识符（建议使用View ID）
     * @param intervalMillis 节流时间间隔（毫秒）
     * @param block 要执行的操作
     */
    fun throttle(key: String, intervalMillis: Long, block: () -> Unit) {
        val now = System.currentTimeMillis()
        val lastTime = throttleMap[key] ?: 0
        if (now - lastTime >= intervalMillis) {
            throttleMap[key] = now
            block()
        }
    }

    /**
     * 清理指定（在onDestroy中调用）
     */
    fun clear(key: String) {
        debounceMap[key]?.let {
            handler.removeCallbacks(it)
            debounceMap.remove(key)
        }
        throttleMap.remove(key)
    }

    /**
     * 清理全部（在onDestroy中调用）
     */
    fun clearAll() {
        handler.removeCallbacksAndMessages(null)
        debounceMap.clear()
        throttleMap.clear()
    }
}

/**
 * 获取View的key
 */
fun View.getKey(): String {
    return "click_${this.id}"
}

/**
 * 获取EditText的key
 */
fun EditText.getKey(): String {
    return "text_change_${this.id}"
}

/**
 * 防抖扩展方法
 */
fun View.clickDebounce(debounceTime: Long = 500L, action: () -> Unit) {
    val key = getKey()
    setOnClickListener {
        DebounceThrottleUtils.debounce(key, debounceTime, action)
    }
}

/**
 * 节流扩展方法
 */
fun View.clickThrottle(throttleTime: Long = 300L, action: () -> Unit) {
    val key = getKey()
    setOnClickListener {
        DebounceThrottleUtils.throttle(key, throttleTime, action)
    }
}

/**
 * 防抖扩展方法
 */
fun EditText.textChangeDebounce(debounceTime: Long = 300L, action: (Editable?) -> Unit) {
    doAfterTextChanged { editable ->
        val key = getKey()
        DebounceThrottleUtils.debounce(key, debounceTime, {
            action(editable)
        })
    }
}

使用

etSearch.textChangeDebounce(debounceTime = 1000L) {
    Log.e("TAG", "textChange:${it.toString()}")
}
btnSubmit.clickDebounce(debounceTime = 1000L) {
    Log.e("TAG", "click-debounce-${System.currentTimeMillis()}")
}
btnSubmit2.clickThrottle(throttleTime = 1000L) {
    Log.e("TAG", "click-throttle-${System.currentTimeMillis()}")
}

源码下载