DIV CSS 佈局教程網

jQuery 外掛學習筆記(三):回傳 this,讓外掛支援鏈式呼叫
編輯:JQuery特效代碼     

寫 jQuery 時你一定用過這種串接:

$(this).test().hide().height();

這裡的 test() 是我們自己寫的外掛,它凭什么能繼續接上 hide() 和 height()?答案很簡單:因為它必須回傳一個 jQuery 物件。

規則:除非需要明確回傳值,否則一律回傳 this

回傳的通常就是 this 本身。而如果你已經用 each() 迭代過 this,那麼直接把迭代的結果回傳即可——因為 each() 的回傳值就是原本的 jQuery 物件。

jQuery.fn.test = function(){
  return this.each(function(){   // 遍歷,this 在此為單一 DOM 元素
    alert(this.nodeName);
  })
}

少了那個 return,函式會回傳 undefined,下一個 .hide() 立刻丟出「 Cannot read property 'hide' of undefined 」。這是新手寫外掛最常撞到的牆。

實際應用

$('body *').click(function(){
  $(this).test().html(this.nodeName).hide(1000);
});

這一行接連做了三件事:先彈出目前節點名稱(外掛的職責),再把該名稱寫進元素內容(html),最後用一秒鐘慢慢隱藏(hide)。三個動作屬於三個不同來源——自製外掛、jQuery 內建方法、動畫——卻能流暢串在一起,這就是鏈式設計的價值:呼叫端不必關心每一步是誰提供的。

一個實務上的提醒

鏈式呼叫雖然方便,但要注意「回傳 this」的前提是這個方法確實在做「轉換」而非「查詢」。如果外掛的語意是取得某個值(例如 data()、val()),就應該回傳資料本身,硬回傳 this 反而違反預期。判斷標準很樸素:方法名稱聽起來像「動詞(做一件事)」就回傳 this,像「名詞(取得某個東西)」就回傳結果。

另外,若外掛內部有非同步行為(Ajax、動畫回呼),鏈式只能保證「已排入佇列」,不代表「已完成」。需要等待時,仍應透過 callback 或 Promise 處理,不能依賴鏈式語法。

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