DIV CSS 佈局教程網

動手寫一個自己的 JavaScript 框架:從零打造迷你版 jQuery
編輯:關於JavaScript     

覺得 MooTools 很神奇?想知道 Dojo 是怎麼做出來的?對 jQuery 的技巧感到好奇?在這篇長篇教程裡,我們要掀開框架背後的神祕面紗,然後親手做一個你所偏愛的框架的簡化版本。成品我們叫它 dome——一個「有點殘缺的 DOM 框架」。

先講清楚:這不是 jQuery

  • 這不會是一個功能完整的框架。我們會寫不少東西,但它還遠遠算不上 jQuery;目標是讓你親身感受「寫框架」是什麼感覺。
  • 我們不追求全面相容。成品可在 Internet Explorer 8+、Firefox 5+、Opera 10+、Chrome 與 Safari 上運作。
  • 我們不會實作所有可能的功能。例如 append/prepend 只接受本框架的實例,不直接吃原生 DOM 節點或 NodeList。

為什麼要這麼麻煩?因為框架存在的理由,正是為了消化 DOM 的兩大痛點:對新手而言原生 DOM 的 API 實在難以理解,而瀏覽器之間的相容性又令人頭痛。把元素包成物件,我們才能掛上方法——這正是 jQuery 方案的核心濃縮版。

第一步:建立框架骨架

先用典型的立即執行函式(IIFE)包住整個框架:

window.dome = (function () {
    function Dome(els) {}

    var dome = {
        get: function (selector) {}
    };

    return dome;
}());

我們有兩個關鍵角色:Dome 函式是未來所有實例的建構子,用來承載被選取或被建立出來的元素;dome 物件則是對外暴露的框架入口,最終作為回傳值被賦給 window.dome。裡頭還有一個空的 get,等等就來填它。

第二步:取得元素

get 只有一個參數,但它可以是很多種東西:字串(視為 CSS 選擇器)、單一 DOM 節點,或節點列表。

get: function (selector) {
    var els;
    if (typeof selector === "string") {
        els = document.querySelectorAll(selector);
    } else if (selector.length) {
        els = selector;
    } else {
        els = [selector];
    }
    return new Dome(els);
}

用 querySelectorAll 來選元素很省事,代價是牺牲部分舊瀏覽器相容性,這個取捨在此可以接受。若 selector 不是字串,就檢查它有沒有 length:有就是節點列表,沒有就是單一元素,我們把它包進陣列。最後一律回傳一個新的 Dome 物件。

第三步:建立 Dome 實例

function Dome(els) {
    for (var i = 0; i < els.length; i++) {
        this[i] = els[i];
    }
    this.length = els.length;
}

就是這麼樸素:走訪 els,把每個元素塞進以數字為索引的屬性,再補一個 length。看似多此一舉,但正因為包成了物件,我們才有地方掛方法,也才能讓方法去遍歷這批元素。

第四步:幾個實用工具函式

由於 Dome 物件可能含多個元素,幾乎每個方法都得遍歷一次,所以先備好工具會省事很多。

Dome.prototype.map = function (callback) {
    var results = [], i = 0;
    for (; i < this.length; i++) {
        results.push(callback.call(this, this[i], i));
    }
    return results;
};

Dome.prototype.forEach = function (callback) {
    this.map(callback);
    return this;
};

map 收一個回呼,走訪所有元素並收集回傳值。注意 callback.call(this, this[i], i) 這個寫法:回呼會在 Dome 實例的上下文中被呼叫,並收到「當前元素」與「元素序號」兩個參數。forEach 則只是把回呼丟給 map 再忽略結果,改回傳 this,讓我們能鏈式呼叫。

一段簡短的「框架哲學」

如果寫框架只是敲鍵盤,那也沒什麼難。但實作過程會發現,DOM 那些不完美的部分,會決定方法的實作方式。

舉例來說,我們要做一個回傳元素文字的 text 方法。若 Dome 物件含多個節點(例如 dome.get("li")),該回傳什麼?照 jQuery 那樣直接回字串,你會得到所有元素文字的就直接串接——我認為不太有用,但也沒有更好的通用解法。

本專案採折衷:多元素時以陣列回傳;若只有一個元素,就直接回傳該字串。畢竟絕大多數時候我們只取單一元素的文字,那種情況值得特別優化。

Dome.prototype.mapOne = function (callback) {
    var m = this.map(callback);
    return m.length > 1 ? m : m[0];
};

第五步:處理 text 與 html

Dome.prototype.text = function (text) {
    if (typeof text !== "undefined") {
        return this.forEach(function (el) {
            el.innerText = text;
        });
    } else {
        return this.mapOne(function (el) {
            return el.innerText;
        });
    }
};

Dome.prototype.html = function (html) {
    if (typeof html !== "undefined") {
        this.forEach(function (el) {
            el.innerHTML = html;
        });
        return this;
    } else {
        return this.mapOne(function (el) {
            return el.innerHTML;
        });
    }
};

兩者幾乎一樣,只是 html 改用 innerHTML。這裡有個容易踩的坑:判斷「是否要設定」時若用 if (text),傳入空字串就會被誤判為「讀取」,因此必須用 typeof !== "undefined"。

第六步:操作 class

Dome.prototype.addClass = function (classes) {
    var className = "";
    if (typeof classes !== "string") {
        for (var i = 0; i < classes.length; i++) {
            className += " " + classes[i];
        }
    } else {
        className = " " + classes;
    }
    return this.forEach(function (el) {
        el.className += className;
    });
};

Dome.prototype.removeClass = function (clazz) {
    return this.forEach(function (el) {
        var cs = el.className.split(" "), i;
        while ((i = cs.indexOf(clazz)) > -1) {
            cs = cs.slice(0, i).concat(cs.slice(++i));
        }
        el.className = cs.join(" ");
    });
};

addClass 允許傳字串或陣列,並保留原本的 class 名稱。removeClass 每次處理一個名稱,把 className 切成陣列後反覆移除直到找不到為止。

第七步:修掉 IE8 的坑

最麻煩的瀏覽器是 IE8。這個小庫裡只需要補一個洞:IE8 不支援 Array.prototype.indexOf,而 removeClass 用得到它。

if (typeof Array.prototype.indexOf !== "function") {
    Array.prototype.indexOf = function (item) {
        for (var i = 0; i < this.length; i++) {
            if (this[i] === item) {
                return i;
            }
        }
        return -1;
    };
}

這不是完整實作(不支援第二個起始索引參數),但足以達成我們的目標。

第八步:attr

Dome.prototype.attr = function (attr, val) {
    if (typeof val !== "undefined") {
        return this.forEach(function (el) {
            el.setAttribute(attr, val);
        });
    } else {
        return this.mapOne(function (el) {
            return el.getAttribute(attr);
        });
    }
};

第九步:建立元素

var dome = {
    create: function (tagName, attrs) {
        var el = new Dome([document.createElement(tagName)]);
        if (attrs) {
            if (attrs.className) {
                el.addClass(attrs.className);
                delete attrs.className;
            }
            if (attrs.text) {
                el.text(attrs.text);
                delete attrs.text;
            }
            for (var key in attrs) {
                if (attrs.hasOwnProperty(key)) {
                    el.attr(key, attrs[key]);
                }
            }
        }
        return el;
    }
};

先建立元素並包成 Dome 實例,再逐一處理屬性。注意用完 className 與 text 後要 delete,否則後面遍歷其他鍵時會重複處理。

第十步:append 與 prepend

目標寫法:

dome1.append(dome2);
dome1.prepend(dome2);

需要涵蓋的情境有四類:新元素加入單一或多個既有元素、多個新元素加入單一或多個既有元素、既有元素加入單一或多個既有元素、多個既有元素加入多個既有元素。(「新元素」指尚未進入 DOM 的節點,「既有元素」則已在 DOM 中。)

Dome.prototype.append = function (els) {
    return this.forEach(function (parEl, i) {
        els.forEach(function (childEl) {
            if (i > 0) {
                childEl = childEl.cloneNode(true);
            }
            parEl.appendChild(childEl);
        });
    });
};

Dome.prototype.prepend = function (els) {
    return this.forEach(function (parEl, i) {
        for (var j = els.length - 1; j > -1; j--) {
            childEl = (i > 0) ? els[j].cloneNode(true) : els[j];
            parEl.insertBefore(childEl, parEl.firstChild);
        }
    });
};

關鍵在 if (i > 0):DOM 節點在同一時間只能有一個位置,若把同一個子元素塞進多個父元素,只有最後一次會生效。因此只有第一個父元素用原物,其餘都用 cloneNode(true) 複製。prepend 的差異是必須用倒序迴圈,否則多個元素插入後順序會反過來。

第十一步:remove

Dome.prototype.remove = function () {
    return this.forEach(function (el) {
        return el.parentNode.removeChild(el);
    });
};

移除之後,那個 Dome 物件依然可用——你還是能對它呼叫其他方法,甚至再把它插回 DOM。這是包裝成物件的附帶好處。

第十二步:事件處理

最後一環,也是最重要的一環。IE8 仍使用舊式事件模型,因此需要能力偵測;同時也要為 DOM 0 級事件預留退路。

Dome.prototype.on = (function () {
    if (document.addEventListener) {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el.addEventListener(evt, fn, false);
            });
        };
    } else if (document.attachEvent) {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el.attachEvent("on" + evt, fn);
            });
        };
    } else {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el["on" + evt] = fn;
            });
        };
    }
}());

Dome.prototype.off = (function () {
    if (document.removeEventListener) {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el.removeEventListener(evt, fn, false);
            });
        };
    } else if (document.detachEvent) {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el.detachEvent("on" + evt, fn);
            });
        };
    } else {
        return function (evt, fn) {
            return this.forEach(function (el) {
                el["on" + evt] = null;
            });
        };
    }
}());

這裡用 IIFE 做了一次性的能力偵測:外層立即執行,回傳符合當前環境的那個函式,最後被指派給 Dome.prototype.on。相比每次呼叫都重新偵測,這種寫法把判斷成本前置到載入階段,只付一次。

寫完之後

十二個步驟下來,你手上有一個能選元素、改文字與 HTML、操作 class 與屬性、增刪節點、綁解事件的迷你框架。它不完美,但每一行程式你都清楚它在做什麼——這正是讀框架原始碼永遠得不到的收穫。

接下來我強烈建議你去深入研讀一個你真正喜歡的框架的原始碼。帶著這次動手做過的經驗回去看,你會發現那些原本覺得理所當然的設計,其實都是權衡之後的選擇。

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