DIV CSS 佈局教程網

徹底搞懂 AngularJS 指令的 compile、pre-link 與 post-link
編輯:關於JavaScript     

多數人寫自訂指令時只會用到 link,而官方文件也常直接建議「用 link 就好」。但 compile 到底在做什麼?pre-link 和 post-link 又有何差別?很少文章認真講。這件事值得弄清楚,因為搞懂它之後,你對 ng 內部運作的理解會完全不一樣,寫出來的指令也會更好。

指令是 ng 最迷人的部分,讓你能做出語意化、可高度重用的元件,可以說是 Web Components 的先聲。本文假設你已經具備指令的基本知識。

ng 是怎麼處理指令的

先回顧一下流程。瀏覽器載入頁面時,本質上是讀 HTML、建立 DOM 節點,樹建好之後廣播一個完成事件。

當你以 script 標籤載入 ng 應用程式碼時,ng 會監聽這個 DOM 完成事件,然後去找帶有 ng-app 屬性的元素。找到之後,ng 就以該元素為起點開始處理 DOM——如果 ng-app 掛在 html 上,那就從 html 開始。

從這個起點出發,ng 遞迴遍歷所有子節點,比對應用程式中註冊的指令規則。而具體怎麼處理,取決於你在指令定義裡給了哪些屬性:可以給 compile、可以給 link,也可以用 pre-link 與 post-link 取代 link。

帶著「差別在哪、何時該用哪個」這兩個問題,我們看下去。

一個能說清楚一切的實驗

HTML 部分,三層巢狀:

  <level-one>
      <level-two>
          <level-three>
              Hello 
          </level-three>
      </level-two>
  </level-one>

JS 部分,用一個工廠函數批量產生指令,每個指令都同時定義 compile、pre、post,並在每個階段印一行字:

var app = angular.module('plunker', []);

  function createDirective(name){
    return function(){
      return {
        restrict: 'E',
        compile: function(tElem, tAttrs){
          console.log(name + ': compile');
          return {
            pre: function(scope, iElem, iAttrs){
              console.log(name + ': pre link');
            },
            post: function(scope, iElem, iAttrs){
              console.log(name + ': post link');
            }
          }
        }
      }
    }
  }

  app.directive('levelOne', createDirective('levelOne'));
  app.directive('levelTwo', createDirective('levelTwo'));
  app.directive('levelThree', createDirective('levelThree'));

輸出的順序說明了一切

  // COMPILE PHASE
  // levelOne:   compile function is called
  // levelTwo:   compile function is called
  // levelThree: compile function is called

  // PRE-LINK PHASE
  // levelOne:   pre link function is called
  // levelTwo:   pre link function is called
  // levelThree: pre link function is called

  // POST-LINK PHASE (Notice the reverse order)
  // levelThree: post link function is called
  // levelTwo:   post link function is called
  // levelOne:   post link function is called

三個階段涇渭分明:ng 會先把所有指令編譯完,才進入 link;而 link 又切成 pre 與 post 兩段,其中 post 的執行順序是反過來的。

那問題來了:compile 和 pre-link 順序相同,為什麼要分成兩個函數?

把 DOM 印出來看看

改一下程式,讓每個階段順便印出參數裡的 element:

var app = angular.module('plunker', []);

  function createDirective(name){ 
    return function(){
      return {
        restrict: 'E',
        compile: function(tElem, tAttrs){
          console.log(name + ': compile => ' + tElem.html());
          return {
            pre: function(scope, iElem, iAttrs){
              console.log(name + ': pre link => ' + iElem.html());
            },
            post: function(scope, iElem, iAttrs){
              console.log(name + ': post link => ' + iElem.html());
            }
          }
        }
      }
    }
  }

  app.directive('levelOne', createDirective('levelOne'));
  app.directive('levelTwo', createDirective('levelTwo'));
  app.directive('levelThree', createDirective('levelThree'));

答案浮現了:compile 階段拿到的 HTML,和 pre-link 階段拿到的並不一樣。

Compile 階段

ng 是在 DOM 建好之後才開始處理它的。遍歷到 level-one 時,ng 從定義得知有事情要做。

因為 compile 定義在 level-one 的指令物件上,它會被呼叫,並收到一個 element 參數。仔細看會發現,這個 element 此時仍是瀏覽器產出的原始標記,還沒經過 ng 加工。

1. 在 ng 的術語裡,這個原始 DOM 被稱為 template element,所以參數取名 tElem。

level-one 的 compile 跑完,ng 接著往下遞迴深入子節點,在 level-two、level-three 上重複同樣動作。

Post-link 階段

2. 如果你只寫了一個 link 函數,ng 會把它當成 post-link 處理,所以先講它。

當所有 DOM 都遍歷完、所有 compile 都跑完,ng 會反向依序呼叫各指令的 post-link。順序反過來看有點怪,但設計得非常合理。

當一個含有子指令的指令執行 post-link 時,反向的規則保證了子指令的 post-link 已經跑完。所以 level-one 的 post-link 執行時,level-two 和 level-three 的 post-link 一定都結束了。

這就是為什麼大家都說 post-link 是寫業務邏輯「最安全」或「預設」的位置——你在這裡可以確定子樹已經就緒。

但為什麼這裡的 element 又跟 compile 裡不同?

compile 跑完之後,ng 會依 template element 建立它的 element 實例,並為它準備一個 scope。這個 scope 可能是新建的、繼承的、子 scope 或獨立 scope,取決於指令定義裡 scope 屬性的設定。

因此到了 linking 階段,element 實例與 scope 都已可用,並作為參數傳入 post-link。

1. 我習慣用 iElem 命名 link 函數的 element 參數,用來提醒自己這是 instance element。

換句話說,post-link(與 pre-link)收到的是 element 實例,而非 template element。這也解釋了上面輸出為何不同。

Pre-link 階段

寫 post-link 時你能保證:執行它的時候,所有子指令的 post-link 都跑完了。多數情況這就夠用,所以一般都用 post-link 來寫指令主體。

但 ng 還多給了一個 hook:pre-link。它保證的是——在所有子指令的 post-link 之前執行。這句話值得反覆咀嚼。

pre-link 保證在 element 實例上、以及其所有子指令的 post-link 之前執行。所以 post-link 之所以反向,正是為了讓出這個位置;pre-link 則維持正向順序。

這也意味著,pre-link 會跑在它自己所有子指令的 pre-link 之前。完整的結論是:

一個元素的 pre-link,保證早於它所有子指令的 pre-link 與 post-link 執行。

回頭對照原始輸出

  // HERE THE ELEMENTS ARE STILL THE ORIGINAL TEMPLATE ELEMENTS

  // COMPILE PHASE
  // levelOne:   compile function is called on original DOM
  // levelTwo:   compile function is called on original DOM
  // levelThree: compile function is called on original DOM

  // AS OF HERE, THE ELEMENTS HAVE BEEN INSTANTIATED AND
  // ARE BOUND TO A SCOPE
  // (E.G. NG-REPEAT WOULD HAVE MULTIPLE INSTANCES)

  // PRE-LINK PHASE
  // levelOne:   pre link function is called on element instance
  // levelTwo:   pre link function is called on element instance
  // levelThree: pre link function is called on element instance

  // POST-LINK PHASE (Notice the reverse order)
  // levelThree: post link function is called on element instance
  // levelTwo:   post link function is called on element instance
  // levelOne:   post link function is called on element instance

三個函數的定位

Compile

用來在 ng 建立 element 實例與 scope 之前,改寫原始 DOM(template element)。它最典型的用途是:需要從一個 template 生出多個 element 實例時。ng-repeat 就是最佳範例——它在 compile 階段複製原始 DOM 成多份,再各自建立實例。因為 compile 只跑一次,需要大量實例時能省下可觀的效能。

此時拿得到 template element 與其屬性,但還沒有 scope:

/**
 * Compile function
 * 
 * @param tElem - template element
 * @param tAttrs - attributes of the template element
 */
  function(tElem, tAttrs){

    // ...

  };

Pre-link

用來在 compile 之後、但所有子指令的 post-link 之前執行一些程式碼。scope 與 element 實例都可用:

/**
 * Pre-link function
 * 
 * @param scope - scope associated with this istance
 * @param iElem - instance element
 * @param iAttrs - attributes of the instance element
 */
  function(scope, iElem, iAttrs){

    // ...

  };

Post-link

寫業務邏輯的預設位置。此階段它的所有子指令都已完成編譯,pre-link 與 post-link 也都跑完,這正是它「最安全」的原因:

/**
 * Post-link function
 * 
 * @param scope - scope associated with this istance
 * @param iElem - instance element
 * @param iAttrs - attributes of the instance element
 */
  function(scope, iElem, iAttrs){

    // ...

  };

結語

到這裡,compile、pre-link、post-link 的界線應該很清楚了。如果還有點模糊,而你又是認真的 ng 開發者,建議回頭再讀一遍——這些概念直接決定你能不能讀懂 ng 原生指令的行為,也決定你的自訂指令能寫得多好。

後續還有兩個題目值得談:指令使用 transclusion 時實際在做什麼?指令的 controller 函數又是怎麼串起來的?

如果發現文中有誤,歡迎留言指正。謝謝!

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