DIV CSS 佈局教程網

提交 JS 代碼前,最好先做這 5 件事
編輯:關於JavaScript     

寫在前面

我們不得不承認一個現實:很多程序員並不習慣規劃自己的 JS 代碼。我們常常一口氣把代碼寫完、跑通、提交,可等到後續開發時再回頭看那些變量和函數,卻要花時間去猜它們到底代表什麼,麻煩就從這裡開始了。而當我們接手別人寫的腳本時,往往也會遇到同樣的困惑。所以,當你覺得「這塊寫完了,可以繼續下一個任務」時,最好先對腳本做下面這 5 件事。

問題描述

現在有個需求:給每一個 class 為 collapsible 的 DIV 內部插入一個超鏈接 A,用來顯示或隱藏該 DIV。下面是用模塊函數實現的初始版本:

復制代碼 代碼如下:

var collapser = (function(){
    var secs = document.getElementsByTagName('div');
    for(var i=0;i<secs.length;i++){
        if(secs[i].className.indexOf('collapsible')!==-1){
            var p = document.createElement('p');
            var a = document.createElement('a');
            a.setAttribute('href','#');
            a.onclick = function(){
                var sec = this.parentNode.nextSibling;
                if(sec.style.display === 'none'){
                    sec.style.display = 'block';
                    this.firstChild.nodeValue = 'collapse'
                } else {
                    sec.style.display = 'none';
                    this.firstChild.nodeValue = 'expand'
                }
                return false;
            };
            a.appendChild(document.createTextNode('expand'));
            p.appendChild(a);
            secs[i].style.display = 'none';
            secs[i].parentNode.insertBefore(p,secs[i]);
        }
    }
})();

這段代碼已經能準確實現需求,但它還有進一步重構的空間。

第一步:樣式(CSS)與行為(JavaScript)分離

我們可以通過添加一個 CSS class 選擇器,來消除 JS 中直接設置樣式的做法。這一步新手經常忽略。

復制代碼 代碼如下:

var collapser = (function(){
    var secs = document.getElementsByTagName('div');
    for(var i=0;i<secs.length;i++){
        if(secs[i].className.indexOf('collapsible')!==-1){
            secs[i].className += ' ' + 'collapsed';
            var p = document.createElement('p');
            var a = document.createElement('a');
            a.setAttribute('href','#');
            a.onclick = function(){
                var sec = this.parentNode.nextSibling;
                if(sec.className.indexOf('collapsed')!==-1){
                    sec.className = sec.className.replace(' collapsed','');
                    this.firstChild.nodeValue = 'collapse'
                } else {
                    sec.className += ' ' + 'collapsed';
                    this.firstChild.nodeValue = 'expand'
                }
                return false;
            }
            a.appendChild(document.createTextNode('expand'));
            p.appendChild(a);
            secs[i].parentNode.insertBefore(p,secs[i]);
        }
    }
})();

第二步:進一步做性能優化

這裡可以做兩件事:其一,循環中的 secs.length 用變量緩存起來,避免每次迭代都重新求值;其二,把事件處理器抽成可重複使用的函數,減少事件處理器數量,从而降低內存佔用。

復制代碼 代碼如下:

var collapser = (function(){
    var secs = document.getElementsByTagName('div');
    for(var i=0,j=secs.length;i<j;i++){
        if(secs[i].className.indexOf('collapsible')!==-1){
            secs[i].className += ' ' + 'collapsed';
            var p = document.createElement('p');
            var a = document.createElement('a');
            a.setAttribute('href','#');
            a.onclick = toggle;
            a.appendChild(document.createTextNode('expand'));
            p.appendChild(a);
            secs[i].parentNode.insertBefore(p,secs[i]);
        }
    }
    function toggle(){
        var sec = this.parentNode.nextSibling;
        if(sec.className.indexOf('collapsed')!==-1){
            sec.className = sec.className.replace(' collapsed','');
            this.firstChild.nodeValue = 'collapse'
        } else {
            sec.className += ' ' + 'collapsed';
            this.firstChild.nodeValue = 'expand'
        }
        return false;
    }
})();

第三步:添加配置對象

把代碼中硬編碼的內容——比如用到的文本標簽或自定義屬性名——收攏到一個配置對象裡,能讓後續維護變得輕鬆很多。

復制代碼 代碼如下:

var collapser = (function(){
    var config = {
        indicatorClass : 'collapsible',
        collapsedClass : 'collapsed',
        collapseLabel : 'collapse',
        expandLabel : 'expand'
    }
    var secs = document.getElementsByTagName('div');
    for(var i=0,j=secs.length;i<j;i++){
        if(secs[i].className.indexOf(config.indicatorClass)!==-1){
            secs[i].className += ' ' + config.collapsedClass;
            var p = document.createElement('p');
            var a = document.createElement('a');
            a.setAttribute('href','#');
            a.onclick = toggle;
            a.appendChild(document.createTextNode(config.expandLabel));
            p.appendChild(a);
            secs[i].parentNode.insertBefore(p,secs[i]);
        }
    }
    function toggle(){
        var sec = this.parentNode.nextSibling;
        if(sec.className.indexOf(config.collapsedClass)!==-1){
            sec.className = sec.className.replace(' ' + config.collapsedClass,'');
            this.firstChild.nodeValue = config.collapseLabel
        } else {
            sec.className += ' ' + config.collapsedClass;
            this.firstChild.nodeValue = config.expandLabel
        }
        return false;
    }
})();

第四步:為變量和函數起有意義的名字

把 secs 改為 sections、a 改為 trigger、toggle 改為 toggleSection,代碼的自說明性立刻提升一個檔次。

復制代碼 代碼如下:

var collapser = (function(){
    var config = {
        indicatorClass : 'collapsible',
        collapsedClass : 'collapsed',
        collapseLabel : 'collapse',
        expandLabel : 'expand'
    }
    var sections = document.getElementsByTagName('div');
    for(var i=0,j=sections.length;i<j;i++){
        if(sections[i].className.indexOf(config.indicatorClass) !== -1){
            sections[i].className += ' ' + config.collapsedClass;
            var paragraph = document.createElement('p');
            var trigger = document.createElement('a');
            trigger.setAttribute('href','#');
            trigger.onclick = toggleSection;
            trigger.appendChild(document.createTextNode(config.expandLabel));
            paragraph.appendChild(trigger);
            sections[i].parentNode.insertBefore(paragraph,sections[i]);
        }
    }
    function toggleSection(){
        var section = this.parentNode.nextSibling;
        if(section.className.indexOf(config.collapsedClass) !== -1){
            section.className = section.className.replace(' ' + config.collapsedClass,'');
            this.firstChild.nodeValue = config.collapseLabel
        } else {
            section.className += ' ' + config.collapsedClass;
            this.firstChild.nodeValue = config.expandLabel
        }
        return false;
    }
})();

第五步:添加必要的註釋

好的註釋能讓接手的人快速理解代碼意圖,尤其是像這種帶配置項的模塊,簡短說明能起到事半功倍的效果。

復制代碼 代碼如下:

// Collapse and expand section of the page with a certain class
// written by Christian Heilmann, 07/01/08
var collapser = (function(){
    // Configuration, change CSS class names and labels here
    var config = {
        indicatorClass : 'collapsible',
        collapsedClass : 'collapsed',
        collapseLabel : 'collapse',
        expandLabel : 'expand'
    }
    var sections = document.getElementsByTagName('div');
    for(var i=0,j=sections.length;i<j;i++){
        if(sections[i].className.indexOf(config.indicatorClass) !== -1){
            sections[i].className += ' ' + config.collapsedClass;
            var paragraph = document.createElement('p');
            var trigger = document.createElement('a');
            trigger.setAttribute('href','#');
            trigger.onclick = toggleSection;
            trigger.appendChild(document.createTextNode(config.expandLabel));
            paragraph.appendChild(trigger);
            sections[i].parentNode.insertBefore(paragraph,sections[i]);
        }
    }
    function toggleSection(){
        var section = this.parentNode.nextSibling;
        if(section.className.indexOf(config.collapsedClass) !== -1){
            section.className = section.className.replace(' ' + config.collapsedClass,'');
            this.firstChild.nodeValue = config.collapseLabel
        } else {
            section.className += ' ' + config.collapsedClass;
            this.firstChild.nodeValue = config.expandLabel
        }
        return false;
    }
})();

通過這五步,一段「能跑就行」的代碼就被打磨成了結構清晰、易讀易維護的模塊。這些習慣看似瑣碎,長期堅持卻能顯著提升代碼質量。

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