17《Vue 入门教程》Vue 自定义指令

1. 前言

本小节我们介绍 Vue 中的自定义指令。包括全局指令的注册、局部指令的注册、指令钩子函数的使用以及动态指令传参。其中，指令钩子函数和动态指令参数是本节的难点。

同学们需要充分理解每个指令钩子函数执行的时机、对动态指令参数多加练习才能对指令的使用得心应手。

2. 木子解释

Vue 除了提供了默认内置的指令外，还允许开发人员根据实际情况自定义指令，它的作用价值在于当开发人员在某些场景下需要对普通 DOM 元素进行底层操作的时候。 – 官方定义

在之前的章节中我们学习了指令 v-show，他的实现原理就是操作 DOM 元素的样式 display，使之实现隐藏、显示的效果。在日常开发中，我们经常把一些对 DOM 大量相同的操作封装成指令。学好指令可以给我们的开发带来便利、提高效率。同学们需要总结业务中的各种场景，多加练习。

3. 注册自定义指令

Vue 自定义指令和组件一样存在着全局注册和局部注册两种方式。全局注册的自定义指令可以在项目中的所有组件中使用，局部注册的指令只能在当前组件内部使用。接下来我们分步介绍全局指令和局部指令的注册方式。

3.1 全局注册

我们可以通过调用 Vue.directive 的方式来定义全局指令， 它接收两个参数：1. 指令名，2. 指令的钩子函数对象。
命名：

• 短横线：
• 驼峰式： 使用驼峰命名指令时，首字母最好以大写字母开头。

钩子函数对象：指令的钩子函数对象我们将在下面段落 4 中详细介绍。

注意：注册指令时，指令名称不需要加 v- 前缀，默认是自动加上前缀的，使用指令的时候一定要加上 v- 前缀。

// 注册
// 驼峰命名
Vue.directive('MyDirective', {/* */})
// 短横线命名
Vue.directive('my-directive', {/* */})

// 使用

下面我们注册一个全局指令 v-focus，该指令的功能是在页面加载时，使得元素获得焦点。

实例演示

  
  
  
  


  

    

      姓名：
      
    
    

      年龄：
      
    
  

"运行案例" 可查看在线运行效果

代码解释：
JS 代码第 3-7 行，我们定义了指令 v-focus，定义 inserted 钩子函数，在节点被插入时获得焦点。
HTML 代码第 4 行，我们在 input 元素上使用指令，当页面打开时 id 为 name 的输入框会自动获取焦点。

3.2 局部注册

指令的局部注册和组件的局部注册类似，在实例的参数 options 中使用 directives 选项来注册局部指令，局部指令只能在当前这个实例中使用：

// 注册
// 短横线命名
{
  directives: {
      'my-directive': {
        inserted: function (el) {
          el.focus()
        }
      }
    }
}
// 驼峰命名
{
  directives: {
      'MyDirective': {
        inserted: function (el) {
          el.focus()
        }
      }
    }
}

// 使用

实例演示

  
  
  
  


  

    

      姓名：
      
    
    

      年龄：
      
    
  

"运行案例" 可查看在线运行效果

代码解释：
JS 代码第 8-14 行，我们定义了局部指令 v-focus，定义 inserted 钩子函数，在节点被插入时获得焦点。
HTML 代码第 4 行，我们在 input 元素上使用指令，当页面打开时 id 为 name 的输入框会自动获取焦点。

4. 钩子函数

上面我们介绍了 Vue.directive 第二个参数接收的是钩子函数对象，这些钩子函数都是可选的。接下来我们详细介绍这几个钩子函数的作用：

• bind：只调用一次，指令第一次绑定到元素时调用，在这里可以进行一次性的初始化设置；
• inserted：被绑定元素插入父节点时调用 （仅保证父节点存在，但不一定已被插入文档中）；
• update：所在组件的 VNode 更新时调用，但是可能发生在其子 VNode 更新之前。指令的值可能发生了改变，也可能没有。但是你可以通过比较更新前后的值来忽略不必要的模板更新 (详细的钩子函数参数见下)；
• componentUpdated：指令所在组件的 VNode 及其子 VNode 全部更新后调用；
• unbind：只调用一次，指令与元素解绑时调用。

4.1 钩子函数参数

指令钩子函数会被传入以下参数：

• el：指令所绑定的元素，可以用来直接操作 DOM ；

• binding
  

  ：一个对象，包含以下属性：

  • name：指令名，不包括 v- 前缀；
  • value：指令的绑定值，例如：v-my-directive="1 + 1" 中，绑定值为 2；
  • oldValue：指令绑定的前一个值，仅在 update 和 componentUpdated 钩子中可用，无论值是否改变都可用；
  • expression：字符串形式的指令表达式，例如 v-my-directive="1 + 1" 中，表达式为 "1 + 1"；
  • arg：传给指令的参数，可选。例如 v-my-directive:foo 中，参数为 "foo"。
  • modifiers：一个包含修饰符的对象。例如：v-my-directive.foo.bar 中，修饰符对象为 { foo: true, bar: true }。

• vnode：Vue 编译生成的虚拟节点。移步 VNode API 来了解更多详情；

• oldVnode：上一个虚拟节点，仅在 update 和 componentUpdated 钩子中可用。

4.2 动态指令参数

指令的参数可以是动态的。例如，在 v-mydirective:[argument]=“value” 中，argument 参数可以根据组件实例数据进行更新！这使得自定义指令可以在应用中被灵活使用。

例如你想要创建一个自定义指令，用来改变页面元素的字体颜色。我们可以像这样创建一个通过指令值来更新字体颜色的自定义指令：

实例演示

  
  
  
  


  

    
Hello ！
    切换颜色
  

"运行案例" 可查看在线运行效果

代码解释：
JS 代码第 3-10 行，我们定义了全局指令 v-color，定义 bind 钩子函数设置元素的字体颜色，定义 update 钩子函数，在节点更新时修改元素的字体颜色。
HTML 代码第 2 行，我们使用 v-color 指令，并动态传入值 color。
HTML 代码第 3 行，点击按钮切换 color 的值。
最终，当我们点击按钮时，“Hello ！” 的字体颜色会随机变化。

上面的例子中我们通过指令动态设置了元素的字体颜色。但如果场景是我们需要修改元素的边框颜色又该怎么办呢？有些同学可能说我们可以再写一个 v-border-color 不就行了。那如果又有修改背景色的需求呢？这时使用动态参数就可以非常方便地根据每个组件实例来进行更新：

实例演示

  
  
  
  


  

    
Hello ！
    
Hello ！
    
Hello ！
    切换颜色
  

"运行案例" 可查看在线运行效果

代码解释：
JS 代码第 3-12 行，我们定义了全局指令 v-color，定义 bind 钩子函数和 update 钩子函数。
HTML 代码第 2-4 行，我们使用 v-color 指令，并动态传入值 color。
HTML 代码第 5 行，点击按钮切换 color 的值。
最终，当我们点击 "切换颜色" 按钮时，分别会修改元素的 color、border-color、background-color 样式属性。

4.3 对象字面量

如果指令需要多个值，可以传入一个 JavaScript 对象字面量。记住，指令函数能够接受所有合法的 JavaScript 表达式：

实例演示

  
  
  
  


  

    
Hello ！
  

"运行案例" 可查看在线运行效果

代码解释：
JS 代码第 3-8 行，我们定义了全局指令 v-font。
JS 代码第 13-16 行，我们定义了对象类型的值 font。
HTML 代码第 2 行，我们使用 v-font 指令，并动态传入对象类型的值 font。

5. 小结

本节，我们带大家学习了自定义指令在项目中的运用。主要知识点有以下几点：

• 使用 Vue.directive 注册全局组件。
• 使用 Vue 实例上 directives 属性注册局部组件。
• 使用指令中钩子函数操作 DOM 元素。
• 使用动态指令参数对 DOM 元素做不同的操作。