DIV CSS 佈局教程網

鏈式調用怎麼實作:從原型鏈返回 this 到設計自己的 JS 庫
編輯:關於JavaScript     

鏈式調用(method chaining)本質上只是一個語法技巧,卻能大幅改善可讀性。它的價值在於讓你以一個初始物件為起點,用一連串緊湊的呼叫描述複雜操作,不必反覆書寫同一個變數名。

要湊出這套語法,需要兩個零件:一個負責產生代表 HTML 元素之物件的「工廠函式」,以及一批掛在這個物件上、對元素執行操作的方法。

第一步:最陽春的骨架

(function () {
  // 私有 class,els 為 arguments 組成的類陣列
  function _$(els) {
    this.elements = [];
    for (var i = 0, len = els.length; i < len; i++) {
      var element = els[i];
      if (typeof element === 'string') {
        element = document.getElementById(element);
      }
      this.elements.push(element);
    }
  }

  _$.prototype = {
    each: function () {},
    setStyle: function () {},
    show: function () {},
    addEvent: function () {}
  };

  // 對外開放的唯一入口
  window.$ = function () { return new _$(arguments); };
})();

用 IIFE 把 _$ 藏在閉包裡,只把 $ 掛到 window,這是避免全域污染的基本手法。

第二步:讓每個方法都回傳 this

鏈式之所以能串起來,關鍵只有一句:每個方法結尾都要 return this。因為所有物件都會繼承原型上的方法,回傳實例本身就能接上下一次呼叫。

(function () {
  function _$(els) { /* 同上 */ }

  _$.prototype = {
    each: function (fn) {
      for (var i = 0; i < this.elements.length; i++) {
        fn.call(this, this.elements[i]);
      }
      return this;
    },
    setStyle: function (prop, value) {
      this.each(function (el) { el.style[prop] = value; });
      return this;
    },
    show: function () {
      var that = this;
      this.each(function () { that.setStyle('display', 'block'); });
      return this;
    },
    addEvent: function (type, fn) {
      var addHandle = function (el) {
        if (document.addEventListener) {
          el.addEventListener(type, fn, false);
        } else if (document.attachEvent) {
          el.attachEvent('on' + type, fn);
        }
      };
      this.each(function (el) { addHandle(el); });
      return this;
    }
  };

  window.$ = function () { return new _$(arguments); };
})();

// 測試
$(window).addEvent('load', function () {
  $('test-1', 'test-2').show()
    .setStyle('color', 'red')
    .addEvent('click', function () {
      $(this).setStyle('color', 'green');
    });
});

注意 show 裡那個 var that = this:each 的 callback 是普通函式呼叫,this 已不是外層物件,必須用閉包把參照留住。用箭頭函式並搭配 bind 也能解決,但箭頭函式的 this 是被繼承的,寫起來更乾淨。

取值器怎麼辦:回呼函式

鏈式很適合「設定」類的方法,卻和「取得」類的方法相衝突——getter 若回傳 this 就拿不到資料,回傳資料又斷了鏈。解法是把結果交給回呼函式:

window.API = window.API || function () {
  var name = 'mackxu';

  this.setName = function (name0) {
    name = name0;
    return this;                 // 設定器:回傳 this 維持鏈式
  };

  this.getName = function (callback) {
    callback.call(this, name);   // 取值器:把值交給 callback
    return this;                 // 仍然回傳 this,鏈不會斷
  };
};

var obj = new API();
obj.getName(console.log).setName('zhangsan').getName(console.log);

這個設計讓「設定」與「取得」在語法上保持一致,代價是 getter 變得比較囉嗦。是否值得,取決於你的 API 有多在意風格統一。

第三步:用 Function.prototype.method 組織一個庫

Crockford 在《JavaScript: The Good Parts》中提出的 method 輔助函式,可以讓方法宣告一氣呵成地串寫下去:

Function.prototype.method = function (name, fn) {
  this.prototype[name] = fn;
  return this;
};

(function () {
  function _$(els) { /* ... */ }

  /* Events: addEvent, removeEvent */
  _$.method('addEvent', function (type, fn) {
    // ...
  }).method('removeEvent', function (type, fn) {
    // ...
  })

  /* DOM: addClass, removeClass, hover, hasClass, getClass, getStyle, setStyle */
  .method('addClass', function (classname) {
    // ...
  }).method('removeClass', function (classname) {
    // ...
  }).method('hover', function (newclass, oldclass) {
    // ...
  }).method('hasClass', function (classname) {
    // ...
  }).method('getClass', function (classname) {
    // ...
  }).method('getStyle', function (prop) {
    // ...
  }).method('setStyle', function (prop, val) {
    // ...
  })

  /* AJAX: ajax */
  .method('ajax', function (url, method) {
    // ...
  });

  window.$ = function () { return new _$(arguments); };

  // 解決命名衝突:讓使用者指定掛載的命名空間
  window.installHelper = function (scope, interface) {
    scope[interface] = function () { return _$(arguments); };
  };
})();

installHelper 這一步很重要。$ 是極易被佔用的名字,允許使用者寫成 installHelper(window, 'YQL') 之後用 YQL(...) 呼叫,就能與其他庫共存。

小結與取捨

鏈式調用確實能讓程式碼更簡潔,也能免除重複書寫同一個物件變數。若你希望 API 風格一致,讓 setter 與 getter 都支援鏈式,用回呼函式傳遞取值結果是最實用的折衷。

不過要誠實地說:上面這套庫示範的是原理,不是你今天該寫進專案的做法。事件的部分請用 addEventListener 並妥善處理 unload 時的資源回收;樣式的部分請操作 classList 而非逐一改 style 屬性;Ajax 請用 fetch 或 XMLHttpRequest 加上適當的逾時與錯誤處理;installHelper 這類動態命名空間機制,在 ES Module 已經標配化的現在顯得多餘。理解鏈式的實作有助於讀懂 jQuery 這類庫的設計,但真正動手時,標準 API 加一個打包工具會省去大量維護成本。

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