DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> WEB網站前端 >> 關於網頁技巧
Web前端弱架構如何滋生代碼污染
編輯:關於網頁技巧     

就要開始新項目了,全站的前端架構也得著手構思。得益於此前做雅虎關系時那些或成功或失敗的實踐總結,我認為還是要從架構層面著手,去解決前端團隊開發中的一些問題。

如今市面上有著形形色色的JS庫和框架,但"庫"和"框架"其實有很大區別。首先,"庫"是widget的集合,特點是上手容易、使用簡便——照著例子,大概只需往頁面里引一個script標簽,再補上一些類似a.start(config)的啟動代碼就行了;而框架則是網站樹狀結構的抽象,包含模塊關系、功能之間的依賴、入口的先後順序,以及性能的hack等等。所幸的是,阿裡還是比較明智地選擇了YUI作為前端架構的底層。只是由於YUI2強大而豐富的widget庫,多數人反而認為YUI2更像一個庫而非框架;而YUI2的YuiLoader又僅僅是一個可選模塊,這就更淡化了YUI2在框架層面靈活強大的表現力。個人認為,如果網站沒有以YuiLoader搭建起來的模塊樹作支撐,YUI2的作用無疑是"殺雞用牛刀"。而在YUI3中,這種情況有了根本改變:框架層面的模塊化取代了簡單的庫,這對團隊開發的大型網站很有啟發。

當然,做前端開發時,使用loader必然要多寫幾行代碼、多做幾次封裝,又麻煩又不方便,那這樣做到底好在什麼地方?這個話題說來話長,這裡只從網站規模和項目特點的角度作個簡單說明。

像淘寶這種大型網站,前端開發占的分量不小。這類網站一般會按大類劃分成不同產品,每個產品相當於一個獨立完整的網站,只有整體樣式風格和組件會和主站保持一致。

那麼從Web前端角度看,這類網站大致包含四部分內容:

1)網站下轄站點所需的全局變量和函數,包括所有子站共通的部分;
2)子站外框(公共頭尾);
3)網頁主體內容;
4)組件。

根據三者的特點,各自的重用情況為:

1)全站的全局變量和函數:幾乎每個頁面都要用到;
2)子站外框:幾乎每個子站的網頁都保持一致;
3)網頁的主體內容:不可重用;
4)組件:重用率高,但被有選擇地調用,只在必要時才引用。

從需求角度講,這類網站的特點是更新頻繁;從工程角度講,代碼的維護成本大於、甚至遠遠大於開發成本。也就是說,隨著時間推移,修改功能的項目數量要遠遠大於新功能的開發。到了項目中後期,工程師的大部分時間不是寫新代碼,而是花大量精力去讀舊代碼,或做性能優化,或針對新需求改進。無論是性能改進還是需求改進,都會增加代碼的熵,代碼污染也會越來越嚴重,維護成本急劇攀升,讓後期開發的工程師苦不堪言。究其原因,一是項目前期文檔不全,缺少寫代碼的必要約束和約定;二是註釋不夠及時規范,導致代碼可讀性差;三是工程師水平參差不齊,有些人在改代碼時會無意識地破壞原有結構;四是時間壓力導致代碼質量下降;五是框架結構本身不合理。

完善文檔和規范、加大新人培訓力度,能解決一部分問題,但這往往又和制度、執行力度有關。從項目生命周期來看,項目分為疊代開發和快速開發:快速開發時間短,不需與其他項目並行,及時開發、及時測試、及時打包上線,與其他項目發生沖突的可能性很小;而簡單迭代的開發模式,則是基於分支和主干的多線程並行開發,在此基礎上的前端開發也要和後端保持同步迭代。迭代的優點是項目並行、減少沖突。從後端角度看,經常多人開發同一個頁面,只是每人負責的模塊不同而已——一般情況下頁面里只有include的入口,然後調用各自工程師的代碼,這樣頁面中的代碼污染就比較低;但隨著頁面復雜度增加,後端代碼會越來越多地直接出現在頁面中,比如更多地用echo代替模版,在HTML里嵌套更多的if判斷和for循環,這就加重了代碼污染。從前端角度看,也經常出現多人合作開發同一個頁面的情況,每人負責不同功能模塊。這裡有兩種情形:一是多人同時開發不同的應用模塊,兩者沒有依賴關系;二是多人分別開發框架和應用,兩者之間有依賴關系,應用依賴框架。而兩者之間的耦合,應當僅以入口調用作接口,因此前端框架應當考慮到這種情況,即多人開發的前端功能代碼應當盡可能地分離。

在JS代碼的寫法上,自然推薦把代碼都封裝到頁面的JS文件中,在page里只留出入口。然而實際情況並非如此:在缺少框架約束的情況下,多數人不會選擇去讀懂之前那些爛代碼、再在其基礎上添加自己的代碼,通常會用最簡單粗暴的方式——直接引一個script標簽加一段script代碼塊寫啟動入口,甚至連script標簽都寫得亂七八糟,直接在原有代碼塊中開辟一塊地方塞自己的代碼。這種做法該怎麼看?從庫的角度講,庫里給了很多模塊的實例,使用模塊的方式大多也是手寫一個script標簽引一個JS文件,再在頁面中添加啟動入口。那麼當多人開發同一頁面中不同功能時,就會這樣:

首先,a在頁面中實現了一個功能,大致是這樣:

<script src="base.js" /><!--庫的種子-->
<script src="a.js" />
<script>
a.start();
</script>

b也實現了另一個功能,大致是這樣:

<script src="base.js" /><!--庫的種子-->
<script src="b.js" />
<script>
b.start();
</script>

b在coding時,多數情況不會去review頁面代碼,或者說review了那些爛代碼也看不懂,又或者兩人並行開發、並不知曉對方的實現。這樣就會導致base.js被重復引用。

另外一種情況是,如果一個例子比較復雜、需要引用多個JS文件,比如:

<script src="base.js" /><!--庫的種子-->
<script src="a.js" />
<script src="b.js" />
<script>
m.start();
</script>

那麼a.js和b.js的引用順序就需特別注意。但在實際開發中,並不能保證每個人都會細心地把JS文件順序排好,一旦排亂,調試成本就比較高。由此可見,純粹基於"庫"模式的開發會帶來很多隱患。這裡只提到了開發過程中常遇到的問題;此外,這種手寫JS標簽引用JS文件的方式,既缺乏語義,又犧牲了性能(每個script src都要占一個HTTP請求?),同時inline script block散布在頁面的各個角落,儘管每個script block都被匿名函數閉包起來,開發速度很快,但這種代碼毫無結構性可言,對其他人來說晦澀難懂,等到項目中後期,維護成本會很高。所以說,換作誰都不願意接手維護一個這樣coding的項目。因此,可以認為這種coding方式導致的代碼污染,會大大降低生產率(這裡的生產率包括開發和維護兩部分)和頁面性能。

而YUI3強制使用YuiLoader,從結構上一定程度地保證了代碼質量和可讀性。按照YUI3的思路,項目前期應當花大力氣去梳理模塊的依賴,在此基礎上開發出豐富的widget;使用過程中只需load模塊名字,而不必去操心模塊依賴哪些JS、這些JS的先後順序是什麼。另外,通過簡單的hack,loader可以將YUI3以及所有項目JS都combo在一起(淘寶的assetcdn目前不提供這種功能,不過很快就會有),再多的模塊也能合並到一個JS HTTP請求里,外加一個種子,一個頁面的JS HTTP請求頂多隻有兩個。

那麼是否可以說,像淘寶這種復雜多變(需求變更頻繁)的大網站,就能用YUI3來架構、從而避免深度的代碼污染了呢?非也。YUI3在設計上並不能滿足類似淘寶的這種門戶。上文提到網站的四個組成部分——全局、外框、主內容區和組件,它們之間的關係應當如何?顯然,頁面render時,應當先加載全局變量,然後初始化load頁面所屬子站的公共頭和公共尾,之後再執行頁面邏輯。因此,網站三個層次的邏輯關系很明確,三者之間必然發生耦合,而框架需要做的,就是把這三個層次之間的耦合降到最低。因為實際情況可能是:很多人同時開發框架功能、模塊、頁面主邏輯和底層庫的維護,所以需要每個部分負責團隊的代碼相互隔離,以保證並行開發中不發生沖突。鑒於此,純粹基於YUI3的代碼結構有三種:

1. 通過YUI().use()的嵌套,把層次之間的邏輯關系表達清楚。比如a的代碼屬於框架,b屬於應用,c屬於子應用:

YUI().use(*,function(){
    //a的代碼
    YUI().use(*,function(){
        //b的代碼
        YUI().use(*,function(){
            //c的代碼
        });
    });
});

三個閉包的嵌套,讓這段代碼層次感比較清晰:把a看作框架,b看作應用,c看作子應用,調用關系一目了然——框架執行完畢後加載並執行應用的代碼,應用加載並執行完後再執行子應用。但三段的代碼緊密耦合在一塊,在團隊並行開發中將經常發生沖突。如果代碼一次編寫、不再修改,這種寫法並無大礙;但代碼往往需要反復修改,因此這種顯式依賴的編碼風格無法避免代碼污染。而且最可能被污染得最嚴重的,是b部分的代碼——因為應用可能包含多個子應用,比如產品的列表頁、瀏覽頁和詳情頁可能都包含相同的右側廣告位,這樣b的代碼中就可能出現平級的多個YUI().use()。另外,每個YUI().use相當於一個loader,每次loader加載都會把本閉包內所需模塊對應的JS文件加載進頁面,這樣三次loader加載若有重復,就無法去重,造成不必要的HTTP請求增加一倍以上,嚴重影響性能。

2. 一個閉包,各自入口:

YUI().use(/*a,b,c的modules*/,function(){
    a.start();
    b.start();
    c.start();
});

這種寫法比較精煉,調用順序一目了然。同樣,若代碼一次編寫不再修改,這是一種不錯的寫法;但考慮到代碼的頻繁修改,它仍有三個缺點:其一,a、b、c各自需要引用各自的模塊,而各自的模塊是作為參數寫在use的非倒數第一個參數中的,誰也分不清哪些是a的、哪些是b的、哪些是c的,這種歧義代碼是多人協作項目中必須要避免的;其二,a、b、c之間看不出依賴關系,而實際上框架、應用、子應用之間的調用是有順序的,可在維護過程中,這個順序隨時可能被改動;其三,三個人寫的代碼仍然擠在一起,不敢保證每次修改都會把模塊封裝到頁面中,一旦有人圖省事開了先例、把模塊代碼直接寫進這個閉包,往後的修改就會一發不可收拾,導致每次需求變更都更加污染代碼。這種情況在雅虎關系的開發中頻頻發生,最終導致代碼極其臃腫,後期哪怕開發一個類似tab new的小功能,都要耗費半個月。

3. 各自閉包,互不干擾:

YUI.use(*,function(Y){
    //a的代碼
});

YUI.use(*,function(Y){
    //b的代碼
});

YUI.use(*,function(Y){
    //c的代碼
});

三個人寫的代碼完全分開,不存在相互干擾的問題;再者,即便某個人的代碼寫得亂七八糟,也不會影響其他人的代碼健康。但缺點有兩個:其一,代碼實際上是有依賴關系的,這裡卻看不出來;其二,同樣的性能問題。

因此,如上所述種種因框架約束不足帶來的代碼污染、維護成本攀升的現象,應當通過更加強壯的框架來解決。目前正在開發中的cubee框架,將在很大程度上緩解上述問題。

嗯?什麼是cubee,它有什麼用?首先可以確定,cubee是框架、非庫,初衷就是解決團隊項目中的代碼污染、降低高昂的維護成本。關於cubee的設計細節,以後再分享吧。

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