Vue3 实现一个自带防抖的响应式值 —— CustomRef

前言

写一个防抖函数自然难不倒各位同学。但实现一个自带防抖的响应式值大家可否听说过，本文使用vue3中的customRef来实现。

基本介绍

customRef函数可以创建一个自定义ref，并对其依赖项跟踪和更新触发进行控制。该函数接受一个工厂函数作为参数，该工厂函数接收track和trigger两个函数作为参数。

了解过Vue3原理的同学都知道track主要负责get时进行依赖收集，trigger主要负责通知更新

废话不多说，我们直接看如何使用customRef，优雅的实现一个自带防抖的响应式值

例子

<template>
  {{ value }}
  <input type="text" placeholder="请输入内容..." v-model="value" />
</template>
<script lang="ts" setup>
import { customRef, ref } from "vue";
let time: any = null;
const value = customRef((track, trigger) => {
  let defaultValue = "默认值";
  return {
    get() {
      track();
      return defaultValue;
    },
    set(newValue) {
      clearTimeout(time);
      time = setTimeout(() => {
        defaultValue = newValue;
        console.log("value update");
        trigger();
      }, 500);
    },
  };
});
</script>

上述代码中，我们使用customRef，定义了一个响应式的值，并且使用v-model进行双向绑定。其内部声明了一个闭包变量defaultValue，get时调用track进行依赖收集的同时返回，set时修改defaultValue，并调用trigger进行更新，其内部也是利用setTimeOut实现防抖。

输入框进行输入的时候，value只会更新一次。

以上就是customRef实现一个自带防抖的响应式值。当然我们也可以尊重一下CompositionAPI：

// useDebounceRef.ts
import {customRef} from "vue";
export function useDebounceRef(defaultValue:any,delay = 300){
    let time: any = null;
    return customRef((track, trigger) => {
        return {
          get() {
            track();
            return defaultValue;
          },
          set(newValue) {
            clearTimeout(time);
            time = setTimeout(() => {
              defaultValue = newValue;
              trigger();
            }, 500);
          },
        };
      })
}

// 组件中使用
<template>
  <div>
    {{ value }}
    <input type="text" placeholder="请输入内容..." v-model="value" />
  </div>
</template>
<script lang="ts" setup>
import { useDebounceRef } from "./useDebounceRef";
const value = useDebounceRef("默认值");
</script>