Vue实战之掌握自定义指令

下面是Vue实战之掌握自定义指令的完整攻略：

1. 自定义指令的作用及使用场景

自定义指令是Vue中一个非常重要的功能，它可以让我们自定义DOM操作行为，比如让元素获取焦点、滚动到指定位置、自动聚焦等。自定义指令的使用场景非常广泛，比如：

在表单中监听输入框焦点事件，根据输入框的类型来动态切换键盘类型；
在移动端页面中使用Better-Scroll滚动插件时，使用自定义指令来初始化滚动实例；
在前端性能优化中，使用自定义指令来实现懒加载、无限滚动等功能。

2. 自定义指令的基本语法和注册方法

在Vue中，自定义指令的基本语法如下：

Vue.directive('directiveName', {
  // 指令选项
})

其中，directiveName为指令的名称，directiveOption为指令的选项，常见的选项有：

bind：指令绑定时触发的钩子函数，可以在这里进行一些初始化工作；
inserted：指令所在元素插入到DOM中时触发的钩子函数；
update：指令所在元素更新时触发的钩子函数；
componentUpdated：指令所在元素及其子节点全部更新时触发的钩子函数；
unbind：指令与元素解绑时触发的钩子函数。

示例如下：

Vue.directive('focus', {
  // 指令绑定时触发
  bind: function (el, binding) {
    if (binding.value) {
      el.focus()
    }
  },
  // 指令所在元素插入到DOM中时触发
  inserted: function (el) {
    el.focus()
  },
  // 指令所在元素更新时触发
  update: function (el, binding) {
    if (binding.value !== binding.oldValue) {
      el.focus()
    }
  },
  // 指令所在元素及其子节点全部更新时触发
  componentUpdated: function (el) {
    el.focus()
  },
  // 指令与元素解绑时触发
  unbind: function (el) {
    // ...
  }
})

3. 示例：自定义指令实现输入框自动聚焦

接下来，我们来看一个案例：如何使用自定义指令实现输入框自动聚焦。这里以Vue3为例，示例代码如下：

<template>
  <div>
    <input type="text" v-focus:auto />
    <input type="password" v-focus="focusState" />
  </div>
</template>

<script>
import { onMounted } from 'vue'

export default {
  setup() {
    const focusState = true
    onMounted(() => {
      console.log('mounted')
    })

    return {
      focusState
    }
  },

  directives: {
    focus: {
      mounted: function (el, binding) {
        if (binding.arg === 'auto' || binding.value) {
          el.focus()
        }
      }
    }
  }
}
</script>

上述代码中，我们创建了一个focus指令，并在mounted钩子函数中判断binding.arg和binding.value，来判断是否自动聚焦。使用方式如下：

v-focus:auto：当值为auto时，表示自动聚焦；
v-focus="focusState"：当focusState值为true时，表示自动聚焦。

在页面中使用该指令，即可实现输入框自动聚焦功能。

4. 示例：自定义指令实现Better-Scroll初始化

下面，我们再看一个案例：如何使用自定义指令实现Better-Scroll初始化。这里以Vue2为例，示例代码如下：

<template>
  <div ref="wrapper" class="wrapper">
    <ul>
      <li v-for="item in list" :key="item.id">{{ item.title }}</li>
    </ul>
  </div>
</template>

<script>
import BScroll from 'better-scroll'

export default {
  data() {
    return {
      list: []
    }
  },
  mounted() {
    this.getList()
  },
  methods: {
    async getList() {
      // 获取列表数据
      this.list = await fetch('data.json').then(res => res.json())
    }
  },
  directives: {
    // Better-Scroll初始化指令
    scroll: {
      inserted: function (el, binding) {
        if (!binding.value || !binding.value.enabled) return

        const options = {
          scrollY: true,
          click: true
        }

        if (typeof binding.value === 'object') {
          Object.assign(options, binding.value.options)
        }

        if (binding.expression) {
          // 订阅父组件事件，更新scroll对象
          const updateScroll = () => {
            if (vm[binding.expression]) {
              vm[binding.expression].refresh()
            }
          }

          const vm = binding.instance
          el._updateScroll = updateScroll
          vm.$on('hook:mounted', updateScroll)
          vm.$on('hook:updated', updateScroll)
        }

        el._scroll = new BScroll(el, options)
      },
      componentUpdated: function (el, binding) {
        if (!binding.value || !binding.value.enabled) return

        if (el._scroll) {
          el._scroll.refresh()
        }
      },
      unbind: function (el) {
        if (el._scroll) {
          el._scroll.destroy()
          el._scroll = null
        }

        if (el._updateScroll) {
          const vm = el._updateScroll.binding.instance
          vm.$off('hook:mounted', el._updateScroll)
          vm.$off('hook:updated', el._updateScroll)
          el._updateScroll = null
        }
      }
    }
  }
}
</script>

上述代码中，我们创建了一个scroll指令，并在inserted钩子函数中，使用Better-Scroll插件初始化滚动实例。同时，当binding.expression存在时，我们订阅父组件的mounted和updated钩子函数，在元素更新后重新初始化滚动实例。

该指令的使用方式如下：

<template>
  <div ref="wrapper" class="wrapper" v-scroll="{ enabled: true, options: { scrollY: true, click: true } }">
    <ul>
      <li v-for="item in list" :key="item.id">{{ item.title }}</li>
    </ul>
  </div>
</template>

在页面中使用该指令，即可实现Better-Scroll初始化功能。