代码改变世界

用 customRef 做一个防抖函数,支持 element 等UI库。

2021-04-03 14:20  金色海洋(jyk)  阅读(192)  评论(0编辑  收藏

这几天学习Vue的官网,看到 customRef 提供了一个例子,研究半天发现这是一个防抖函数,觉得挺好,于是把这个例子扩展了一下,可以用于表单子控件和查询子控件。

需求

  • v-model
    基于 element-plus 封装表单控件,同时也要封装一下表单子控件,还有查询控件。
    由于 el-input 这类的组件,把 value 封装成了 v-model,所以无法把组件的属性直接设置给内部的 el-input。
    必须在内部设置一个变量,然后做“属性” <==> “变量” 的转换。
    这样就比较麻烦,需要一个既优雅又实用的方式来解决。

  • 查询的防抖
    查询的时候,理想情况是用户输入一个完整的查询条件,然后自动去后端申请查询,但是vue默认的响应形式是,输入一个字符就会响应,如果立即去后端查询的话,会造成浪费的情况,另外用户体验也不好。
    如果用change事件,那么用户输入完毕,还得在其他的地方点一下,比较麻烦。
    所以需要一个简单的方式,比如防抖功能来优化用户体验。

设计

用 customRef (自定义的ref)设计get 和 set。

  • get:获取组件属性,返回给内部组件,比如 el-input。
  • set:用smit提交给父组件。
  • settimeout:实现防抖。

实施验证

想法挺好的,演示为0的时候也是好用的,但是把延迟设为200的时候确出现问题,首先是 el-input 的字符显示也一起延迟了,另外只会显示最后一个字符,中间的字符都被吃掉了。

这是怎么回事?用html5的 input 试验的时候是没有问题的呀。

办法重臂困难多,几经修改之后终于好用了。

/**
 * 自定义的ref,实现属性和内部变量的数据转换
 * @param { reactive } props 组件的属性
 * @param { object } context 组件的上下文
 * @param { number } delay 延迟刷新的时间,单位:毫秒,默认:0
 * @param { string } name 要对应的属性名称,默认:modelValue
 * @returns 自定义的ref
 */
export const debounceRef = (props, context, delay = 0, name = 'modelValue') => {
  let value = props[name]
  // 计时器
  let timeout
  // 是否输入状态。输入时取 value;输入完毕取 modelValue 属性
  let isInput = false
  return customRef((track, trigger) => {
    return {
      get () {
        track()
        if (isInput) {
          return value
        } else {
          return props[name]
        }
      },
      set (newValue) {
        isInput = true
        value = newValue // 绑定值
        trigger() // 组件内部刷新模板
        clearTimeout(timeout) // 清掉上一次的计时
        timeout = setTimeout(() => {
          // 修改 modelValue 属性
          context.emit(`update:${name}`, newValue) // 提交给父组件
          // 用于区分是哪个组件触发的事件。
          context.emit('my-change', newValue, props.controlId, props.colName)
          isInput = false
        }, delay)
      }
    }
  })
}
  • 参数
  1. props: 组件的属性,便于属性值变更的时候可以获得最新值。
  2. context 组件的上下文,方便向父组件提交。
  3. name:v-model的名称,默认是 modelValue。
  4. delay:延迟时间,默认是0。
  • value:内部变量,用于初始值和用户输入的时候的绑定。

  • let timeout:定时器,便于清掉之前的定时。

  • let isInput = false
    用户的输入状态,如果用户处于敲键盘的状态,那么获取内部的 value 绑定到 el-inupt;
    如果用户没有敲键盘,那么获取父组件的属性值,绑定到 el-inupt。

为啥要这么设置呢?没办法,如果直接获取组件的属性值的话,那么会出现延迟的情况,如果获取内部 value 的话,父组件的属性变化的时候,内部 el-input 不会有变化,所以只好这么折腾一下。

后面的就是常规操作了,get 里面根据状态获取属性和 value,set 里面向父组件提交。

使用

setup (props, context) {
  const value = debounceRef(props, context)
  return {
    value
  }
}
 <el-input v-model="value"></el-input>

基本上和普通的 ref 很像,只是需要设置组件的属性和上下文。

  • 如果名称不是默认的 modelValue 的话,需要传递名称;
  • 如果需要延迟响应的话,需要设置延迟时间,默认是不延迟的。

缺点:

  • 灵活性欠佳,只是针对一个特定需求封装的,没有考虑更多的情况。其他情况在写个函数好了,函数要符合原子性,不要承担太多的职责。

  • 还是要传递属性和上下文,这个也没啥办法省略。

  • CheckBox又不支持延迟了。记得之前好用的。。。

优点:

  • 自我感觉还是比较优雅的。
2