如何写一个 Vue3 的自定义指令

前端巅峰 
以下文章来源于微信公众号前端巅峰

背景

众所周知，vue.js 的核心思想是数据驱动 + 组件化，通常我们开发页面的过程就是在编写一些组件，并且通过修改数据的方式来驱动组件的重新渲染。在这个过程中，我们不需要去手动操作 dom。

然而在有些场景下，我们还是避免不了要操作 dom。由于 vue.js 框架接管了 dom 元素的创建和更新的过程，因此它可以在 dom 元素的生命周期内注入用户的代码，于是 vue.js 设计并提供了自定义指令，允许用户进行一些底层的 dom 操作。

举个实际的例子——图片懒加载。图片懒加载是一种常见性能优化的方式，由于它只去加载可视区域图片，能减少很多不必要的请求，极大的提升用户体验。

而图片懒加载的实现原理也非常简单，在图片没进入可视区域的时候，我们只需要让 img 标签的 src 属性指向一张默认图片，在它进入可视区后，再替换它的 src 指向真实图片地址即可。

如果我们想在 vue.js 的项目中实现图片懒加载，那么用自定义指令就再合适不过了，那么接下来就让我手把手带你用 vue3 去实现一个图片懒加载的自定义指令 v-lazy。

插件

为了让这个指令方便地给多个项目使用，我们把它做成一个插件：

const lazyplugin = {
  install (app, options) {
    app.directive('lazy', {
      // 指令对象
    })
  }
}

export default lazyplugin

然后在项目中引用它：

import { createapp } from 'vue'
import app from './app.vue'
import lazyplugin from 'vue3-lazy'

createapp(app).use(lazyplugin, {
  // 添加一些配置参数
})

通常一个 vue3 的插件会暴露 install 函数，当 app 实例 use 该插件时，就会执行该函数。在 install 函数内部，通过 app.directive 去注册一个全局指令，这样就可以在组件中使用它们了。

指令的实现

接下来我们要做的就是实现该指令对象，一个指令定义对象可以提供多个钩子函数，比如 mounted、updated、unmounted 等，我们可以在合适的钩子函数中编写相应的代码来实现需求。

在编写代码前，我们不妨思考一下实现图片懒加载的几个关键步骤。

图片的管理:

管理图片的 dom、真实的 src、预加载的 url、加载的状态以及图片的加载。

可视区的判断:

判断图片是否进入可视区域。

关于图片的管理，我们设计了 imagemanager 类：

const state = {
  loading: 0,
  loaded: 1,
  error: 2
}

export class imagemanager {
  constructor(options) {
    this.el = options.el
    this.src = options.src
    this.state = state.loading
    this.loading = options.loading
    this.error = options.error
    
    this.render(this.loading)
  }
  render() {
    this.el.setattribute('src', src)
  }
  load(next) {
    if (this.state > state.loading) {
      return
    }
    this.rendersrc(next)
  }
  rendersrc(next) {
    loadimage(this.src).then(() => {
      this.state = state.loaded
      this.render(this.src)
      next && next()
    }).catch((e) => {
      this.state = state.error
      this.render(this.error)
      console.warn(`load failed with src image(${this.src}) and the error msg is ${e.message}`)
      next && next()
    })
  }
}

export default function loadimage (src) {
  return new promise((resolve, reject) => {
    const image = new image()

    image.onload = function () {
      resolve()
      dispose()
    }

    image.onerror = function (e) {
      reject(e)
      dispose()
    }

    image.src = src

    function dispose () {
      image.onload = image.onerror = null
    }
  })
}

首先，对于图片而言，它有三种状态，加载中、加载完成和加载失败。

当 imagemanager 实例化的时候，除了初始化一些数据，还会把它对应的 img 标签的 src 执行加载中的图片 loading，这就相当于默认加载的图片。

当执行 imagemanager 对象的 load 方法时，就会判断图片的状态，如果仍然在加载中，则去加载它的真实 src，这里用到了 loadimage 图片预加载技术实现去请求 src 图片，成功后再替换 img 标签的 src，并修改状态，这样就完成了图片真实地址的加载。

有了图片管理器，接下来我们就需要实现可视区的判断以及对多个图片的管理器的管理，设计 lazy 类：

const default_url = 'data:image/gif;base64,r0lgodlhaqabaiaaaaaaap///yh5baeaaaaalaaaaaabaaeaaaibraa7'

export default class lazy {
  constructor(options) {
    this.managerqueue = []
    this.initintersectionobserver()
    
    this.loading = options.loading || default_url
    this.error = options.error || default_url
  }
  add(el, binding) {
    const src = binding.value
    
    const manager = new imagemanager({
      el,
      src,
      loading: this.loading,
      error: this.error
    })
    
    this.managerqueue.push(manager)
    
    this.observer.observe(el)
  }
  initintersectionobserver() {
    this.observer = new intersectionobserver((entries) => {
      entries.foreach((entry) => {
        if (entry.isintersecting) {
          const manager = this.managerqueue.find((manager) => {
            return manager.el === entry.target
          })
          if (manager) {
            if (manager.state === state.loaded) {
              this.removemanager(manager)
              return
            }
            manager.load()
          }
        }
      })
    }, {
      rootmargin: '0px',
      threshold: 0
    })
  }
  removemanager(manager) {
    const index = this.managerqueue.indexof(manager)
    if (index > -1) {
      this.managerqueue.splice(index, 1)
    }
    if (this.observer) {
      this.observer.unobserve(manager.el)
    }
  }
}

const lazyplugin = {
  install (app, options) {
    const lazy = new lazy(options)

    app.directive('lazy', {
      mounted: lazy.add.bind(lazy)
    })
  }
}

这样每当图片元素绑定 v-lazy 指令，且在 mounted 钩子函数执行的时候，就会执行 lazy 对象的 add 方法，其中第一个参数 el 对应的就是图片对应的 dom 元素对象，第二个参数 binding 就是指令对象绑定的值，比如：

<img class="avatar" v-lazy="item.pic">

其中 item.pic 对应的就是指令绑定的值，因此通过binding.value 就可以获取到图片的真实地址。

有了图片的 dom 元素对象以及真实图片地址后，就可以根据它们创建一个图片管理器对象，并添加到 managerqueue 中，同时对该图片 dom 元素进行可视区的观察。

而对于图片进入可视区的判断，主要利用了 intersectionobserver api，它对应的回调函数的参数 entries，是 intersectionobserverentry 对象数组。当观测的元素可见比例超过指定阈值时，就会执行该回调函数，对 entries 进行遍历，拿到每一个 entry，然后判断 entry.isintersecting 是否为 true，如果是则说明 entry 对象对应的 dom 元素进入了可视区。

然后就根据 dom 元素的比对从 managerqueue 中找到对应的 manager，并且判断它对应图片的加载状态。

如果图片是加载中的状态，则此时执行manager.load 函数去完成真实图片的加载；如果是已加载状态，则直接从 managerqueue 中移除其对应的管理器，并且停止对图片 dom 元素的观察。

目前，我们实现了图片元素挂载到页面后，延时加载的一系列处理。不过，当元素从页面卸载后，也需要执行一些清理的操作：

export default class lazy {
  remove(el) {
    const manager = this.managerqueue.find((manager) => {
      return manager.el === el
    })
    if (manager) {
      this.removemanager(manager)
    }
  }
}

const lazyplugin = {
  install (app, options) {
    const lazy = new lazy(options)

    app.directive('lazy', {
      mounted: lazy.add.bind(lazy),
      remove: lazy.remove.bind(lazy)
    })
  }
}

当元素被卸载后，其对应的图片管理器也会从 managerqueue 中被移除，并且停止对图片 dom 元素的观察。

此外，如果动态修改了 v-lazy 指令绑定的值，也就是真实图片的请求地址，那么指令内部也应该做对应的修改：

export default class imagemanager {
  update (src) {
    const currentsrc = this.src
    if (src !== currentsrc) {
      this.src = src
      this.state = state.loading
    }
  }  
}

export default class lazy {
  update (el, binding) {
    const src = binding.value
    const manager = this.managerqueue.find((manager) => {
      return manager.el === el
    })
    if (manager) {
      manager.update(src)
    }
  }    
}

const lazyplugin = {
  install (app, options) {
    const lazy = new lazy(options)

    app.directive('lazy', {
      mounted: lazy.add.bind(lazy),
      remove: lazy.remove.bind(lazy),
      update: lazy.update.bind(lazy)
    })
  }
}

至此，我们已经实现了一个简单的图片懒加载指令，在这个基础上，还能做一些优化吗？

指令的优化
在实现图片的真实 url 的加载过程中，我们使用了 loadimage 做图片预加载，那么显然对于相同 url 的多张图片，预加载只需要做一次即可。

为了实现上述需求，我们可以在 lazy 模块内部创建一个缓存 cache:

export default class lazy {
  constructor(options) {
    // ...
    this.cache = new set()
  }
}

然后在创建 imagemanager 实例的时候，把该缓存传入：

const manager = new imagemanager({
  el,
  src,
  loading: this.loading,
  error: this.error,
  cache: this.cache
})

然后对 imagemanager 做如下修改：

export default class imagemanager {
  load(next) {
    if (this.state > state.loading) {
      return
    }
    if (this.cache.has(this.src)) {
      this.state = state.loaded
      this.render(this.src)
      return
    }
    this.rendersrc(next)
  }
  rendersrc(next) {
    loadimage(this.src).then(() => {
      this.state = state.loaded
      this.render(this.src)
      next && next()
    }).catch((e) => {
      this.state = state.error
      this.cache.add(this.src)
      this.render(this.error)
      console.warn(`load failed with src image(${this.src}) and the error msg is ${e.message}`)
      next && next()
    })  
  }
}

在每次执行 load 前从缓存中判断是否已存在，然后在执行 loadimage 预加载图片成功后更新缓存。

通过这种空间换时间的手段，就避免了一些重复的 url 请求，达到了优化性能的目的。

总结:

懒加载图片指令完整的指令实现，可以在 vue3-lazy 中查看， 在我的课程《vue3 开发高质量音乐 web app》中也有应用。

懒加载图片指令的核心是应用了 intersectionobserver api 来判断图片是否进入可视区，该特性在现代浏览器中都支持，但 ie 浏览器不支持，此时可以通过监听图片可滚动父元素的一些事件如 scroll、resize 等，然后通过一些 dom 计算来判断图片元素是否进入可视区。不过 vue3 已经明确不再支持 ie，那么仅仅使用 intersectionobserver api 就足够了。

除了懒加载图片自定义指令中用到的钩子函数，vue3 的自定义指令还提供了一些其它的钩子函数，你未来在开发自定义指令时，可以去查阅它的文档，在适合的钩子函数去编写相应的代码逻辑。

相关链接:

[1] intersectionobserver: https://developer.mozilla.org/zh-cn/docs/web/api/intersectionobserver

[2] vue3-lazy: https://github.com/ustbhuangyi/vue3-lazy

[3] 《vue3 开发高质量音乐 web app》:https://coding.imooc.com/class/503.html

[4] vue3 自定义指令文档: https://v3.cn.vuejs.org/guide/custom-directive.html