如何利用 customRef 实现一个带有防抖功能的响应式数据?

雨强吖_2085

雨强吖_2085

2026-06-10

183人浏览

原创

可以使用 customref 封装带防抖的响应式引用:在 set 中清除旧定时器并延后更新 innervalue 和触发 trigger,get 中同步返回当前生效值并调用 track;需手动管理依赖收集与更新通知,卸载时应清理定时器。

如何利用 customref 实现一个带有防抖功能的响应式数据?

可以使用 customRef 封装一个带防抖的响应式引用,核心是控制 get 和 set 的触发时机,把赋值延迟执行,并在延迟期间重复赋值时取消前一次。

理解 customRef 的基本结构

customRef 接收一个工厂函数,返回包含 get 和 set 方法的对象。Vue 依赖收集和触发更新都通过这两个方法控制:

  • get 被读取响应式值时调用,需返回当前值(并进行依赖收集)
  • set 被赋值时调用,接收新值,可在此做拦截、转换或延迟
  • 必须手动调用 track()(读取时)和 trigger()(变更时),否则响应式失效

实现带防抖的 ref 工厂函数

防抖逻辑放在 set 中:每次设置新值时,清除上一次定时器,重新设定延迟更新。注意要保留原始值用于 get 返回,并确保只有最终生效的值才触发更新:

Vuejs
Vuejs

Vue.js 官方推荐通过 npm 进行安装,这是构建现代化前端项目最主流的方式。在终端中执行 npm install vue 即可获取最新稳定版,如需指定版本可添加 @版本号,例如 npm install vue@3.4.0。安装前请确保已配置 Node.js 环境(推荐 v18 及以上版本),并建议将 npm 镜像源切换至国内镜像以提升下载速度。对于大型项目,还可通过 npm create v

下载
import { customRef, nextTick } from 'vue'

function useDebouncedRef(value, delay = 200) {
  let innerValue = value
  let timeout = null

  return customRef((track, trigger) => ({
    get() {
      track() // 告诉 Vue 这里依赖了该 ref
      return innerValue
    },
    set(newValue) {
      clearTimeout(timeout)
      timeout = setTimeout(() => {
        innerValue = newValue
        trigger() // 值真正更新后才通知依赖更新
      }, delay)
    }
  }))
}

使用示例与注意事项

在组件中直接使用,行为类似普通 ref,但赋值会防抖:

export default {
  setup() {
    const searchQuery = useDebouncedRef('', 300)

    const handleInput = (e) => {
      searchQuery.value = e.target.value // 不会立即更新,等待 300ms 静默期
    }

    return { searchQuery, handleInput }
  }
}
  • 防抖只影响 set,get 仍同步返回最新已提交的值(不是输入中的临时值)
  • 组件卸载前记得清理定时器(可结合 onBeforeUnmount 或 watchEffect 的清理函数)
  • 如需支持立即执行首次调用(leading edge),需额外扩展逻辑,标准防抖默认是尾部执行(trailing)

进阶:支持手动取消和立即刷新

可返回增强对象,暴露 flush(立即提交当前值)和 cancel(清空待执行)方法:

function useDebouncedRef(value, delay = 200) {
  let innerValue = value
  let timeout = null

  const flush = () => {
    if (timeout) {
      clearTimeout(timeout)
      timeout = null
      // 此时 innerValue 还是旧值,但我们可以选择是否更新
      // 若希望 flush 时也更新为最新 pending 值,需额外保存 pending 值
    }
  }

  const cancel = () => clearTimeout(timeout)

  return {
    ...customRef((track, trigger) => ({
      get() {
        track()
        return innerValue
      },
      set(newValue) {
        clearTimeout(timeout)
        timeout = setTimeout(() => {
          innerValue = newValue
          trigger()
        }, delay)
      }
    })),
    flush,
    cancel
  }
}

相关专题

更多
LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

2026.09.30

80

10

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

2026.09.30

80

14

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

2026.09.30

80

12

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

2026.09.30

60

26

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

2026.09.29

60

15

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

280

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

160

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

140

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

80

12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 16.9万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.7万人学习