这一节了解一下Vue3 中的自定义引用,customRef是Vue3提供的一个响应式API,允许你自定义ref的get和set内部逻辑,通过track()收集依赖、trigger()触发更新,从而实现防抖等特殊行为。简单总结如下:
API:
customRef(factory):创建一个自定义的ref,传入一个工厂函数factory
factory 固定参数:track,trigger
track():收集依赖->当数据被模板/计算属性读取时,通知Vue收集当前副作用
trigger():派发更新 ->当数据修改完成后,通知所有收集到的依赖去更新视图
返回值:一个ref对象
场景:
1 防抖,输入框延迟更新,减少频繁请求
2 带本地持久化的ref:读写同时自动存入localStorage
3 读写拦截、数据校验
栗子:
1<template> 2 <div> 3 <input v-model="searchKey" placeholder="输入搜索内容" /> 4 <p>实时防抖结果:{{ searchKey }}</p> 5 </div> 6</template> 7 8<script setup> 9import { customRef } from 'vue' 10 11function useDebounceRef(initValue, delay = 500) { 12 let timer = null 13 // customRef 工厂函数,接收 track、trigger 14 return customRef((track, trigger) => { 15 let value = initValue 16 return { 17 get() { 18 track() 19 return value 20 }, 21 set(newVal) { 22 clearTimeout(timer) 23 timer = setTimeout(() => { 24 value = newVal 25 trigger() 26 }, delay) 27 } 28 } 29 }) 30} 31 32// 使用自定义ref 33const searchKey = useDebounceRef('') 34</script>
Demo02
1<template> 2 <div> 3 <input v-model="username" placeholder="输入用户名" /> 4 <p>当前用户名:{{ username }}</p> 5 <button @click="assignIllegal">赋值非法数字</button> 6 </div> 7</template> 8 9<script setup> 10import { customRef } from 'vue' 11 12function useStorageRef(key, defaultValue) { 13 return customRef((track, trigger) => { 14 let value = localStorage.getItem(key) ?? defaultValue 15 16 return { 17 get() { 18 console.log('[读取数据]', value) 19 track() 20 return value 21 }, 22 set(newVal) { 23 console.log('[准备赋值]', newVal) 24 if (typeof newVal !== 'string') { 25 console.warn('赋值失败:数据类型不合法,只允许字符串!') 26 return 27 } 28 value = newVal 29 localStorage.setItem(key, value) 30 trigger() 31 console.log('[赋值成功并持久化]', value) 32 } 33 } 34 }) 35} 36 37// 使用自定义引用 38const username = useStorageRef('user_name', '默认用户') 39 40const assignIllegal = () => { 41 username.value = 123456 42} 43</script> 44
原理:
customRef是一个高阶工厂函数,把ref内部的track(收集依赖)、trigger(触发更新)两个核心能力暴露给开发者,让我们手动控制什么时候收集依赖、什么时候派发更新,不再由Vue内部自动处理。
1开始调用 customRef(工厂函数) 2 ↓ 3传入全局 track、trigger 给工厂函数 4 ↓ 5执行工厂函数 → 得到 {get, set},闭包变量常驻 6 ↓ 7返回 ref 实例(标记 __v_isRef = true) 8———————————————————————————————— 9【读取 .value】 10 ↓ 11执行 get() 12 ↓ 13手动 track() → 收集当前effect依赖 14 ↓ 15return 数据 16———————————————————————————————— 17【修改 .value = newVal】 18 ↓ 19执行 set(newVal) 20 ↓ 21执行自定义业务逻辑(防抖/校验等等) 22 ↓ 23 满足条件手动 trigger() 24 ↓ 25取出收集的所有 effect 执行 → 视图更新、watch触发
注意:
1 get里面必须调用track(),否则模板不会收集依赖,视图不更新
2 set修改完数据必须调用trigger(),否则不会通知视图刷新
3 不要在get/set里面写无限循环逻辑
参考文档
- Primers 编程伙伴/HTML/HTML 元素/template
- Primers 编程伙伴/HTML/HTML 元素/div
- Primers 编程伙伴/HTML/HTML 元素/input
- Primers 编程伙伴/HTML/HTML 元素/p
- Primers 编程伙伴/HTML/HTML 元素/script
- Primers 编程伙伴/HTML/HTML 元素/track
- Primers 编程伙伴/HTML/HTML 元素/button
《Vue笔记(十五)--自定义引用》 是转载文章,点击查看原文。
