DIV CSS 佈局教程網

一篇搞懂 Vue 自定義指令 directive 的註冊與五個鉤子
編輯:關於JavaScript     

自定義指令是 Vue 提供給我們直接操作 DOM 的正規通道。本文把註冊方式、生命週期鉤子以及鉤子參數一次講透,並補上幾個實務上容易踩的坑。

一、指令怎麼註冊

指令和元件一樣,得先註冊才能使用,同樣分為全域與局部兩種。

全域註冊,一次宣告到處可用:

Vue.directive('dirName', function () {
  // 在這裡定義指令行為
});

局部註冊,只在當前 Vue 實例內生效:

new Vue({
  directives: {
    dirName: {
      // 在這裡定義指令行為
    }
  }
});

二、五個鉤子函式,對應一段生命週期

官方提供了五個鉤子,剛好對應元素從掛載到銷毀的各個階段:

  • bind:只呼叫一次,指令第一次綁定到元素時觸發,適合放只做一次的初始化動作。
  • inserted:被綁定元素插入父節點時觸發。注意只要父節點存在就會觸發,該元素本身不必已經在 document 裡。
  • update:元素所在的模板更新時觸發,無論綁定值是否真的改變。可以透過比對更新前後的值,跳過不必要的重渲染。
  • componentUpdated:元素所在模板完成整個更新週期後觸發。
  • unbind:只呼叫一次,指令與元素解綁時觸發,用來收拾残局。

其餘幾個都好理解,唯獨 update 值得多說兩句。我的理解是:當指令所在的模板因為資料變化而需要重新渲染時它就會觸發,例如輸入框的 v-model 綁定值改變。這個說法仍然偏籠統,實際邊界還需要看具體案例累積。

下面這段程式可以直接觀察五個鉤子的觸發時機:

<div id="app">
  <input type="text" v-focus="name" v-model="name" :data-name="name">
  <button type="button" @click="name='zw'">click</button>
  <!-- 點擊按鈕後 name 改變,進而觸發 update -->
</div>
<script>
Vue.directive('focus', {
  bind: function (el, binding) {
    console.log('bind:', binding.value);
  },
  inserted: function (el, binding) {
    console.log('insert:', binding.value);
  },
  update: function (el, binding, vnode, oldVnode) {
    el.focus();
    console.log(el.dataset.name); // dataset 上的值是動態的
    console.table({
      name: binding.name,
      value: binding.value,
      oldValue: binding.oldValue,
      expression: binding.expression,
      arg: binding.arg,
      modifiers: binding.modifiers,
      vnode: vnode,
      oldVnode: oldVnode
    });
  },
  componentUpdated: function (el, binding) {
    console.log('componentUpdated:', binding.name);
  }
});
new Vue({
  el: '#app',
  data: { name: 'zwzhai' }
});
</script>

三、鉤子函式拿到了什麼參數

官方定義的參數如下:

  • el:指令所綁定的元素,可以直接拿來操作 DOM。
  • binding:一個物件,包含下列屬性。
    • name:指令名稱,不含 v- 前綴。
    • value:指令的綁定值。例如 v-my-directive="1 + 1",value 就是 2。
    • oldValue:綁定的前一個值,僅在 update 與 componentUpdated 中可用,且無論值有沒有變都能取到。
    • expression:綁定值的字串形式。上例中它是字串 "1 + 1"。
    • arg:傳給指令的參數。例如 v-my-directive:foo,arg 就是 "foo"。
    • modifiers:修飾符物件。例如 v-my-directive.foo.bar 對應 { foo: true, bar: true }。
  • vnode:Vue 編譯產出的虛擬節點。
  • oldVnode:上一個虛擬節點,僅在 update 與 componentUpdated 中可用。

關於 binding 的屬性,補一點自己的看法:value 可以写字面量、單條運算式,也可以是變數(例如 v-focus="name")。但要留意,當你寫 v-focus="name" 時,拿到的 name 永遠被當成一個變數求值,必須事先宣告並賦值;而 arg 走的是另一條路——寫成 v-focus:foo,鉤子裡收到的就是字串 "foo" 本身,不需要任何變數存在。

四、一個重要限制:不要雙向綁定

Vue 官方明確表示:除了 el 之外,其餘參數都應該視為唯讀,盡量不要修改。如果需要在多個鉤子之間共享資料,建議透過元素的 dataset 來傳遞。

順帶補一下 dataset 的知識。它是 HTML5 引入的特性,主流瀏覽器都已支援,IE 則要到 10 以上。用法是在 HTML 中寫成 data-yourname="value",在 JS 中不必再呼叫 getAttribute,直接存取 ele.dataset.yourname 即可,新增與刪除也同樣直覺:

ele.dataset.dessert = 'yourname';  // 新增
delete ele.dataset.name;           // 刪除

此外它還能直接用作 CSS 選擇器:.class[data-name] { }。

五、動手做一個小專案

最後附上一個自己寫的 Vue 小作品:一個簡單的頁面切換 demo,用 vue-cli 建置、搭配 mint-ui 元件庫,可視為 sample 的精簡版。原始碼在 GitHub:https://github.com/Stevenzwzhai/news-vue

指令寫多的時候最容易犯的錯,就是把它當成 jQuery 用的替代品。記住 Vue 的分工:資料流交給響應式系統,只有在確實需要碰原生 DOM 行為(焦點、測量、拖曳、第三方套件橋接)時,才動用自定義指令。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved