前端進階(2) - 目錄結構優化

目錄結構優化

現在前端項目越來越變得像大型工程了,而且越來越復雜了,需要處理好組員之間的協作,也需要做好業務分塊、去耦合來降低維護成本,并且還要保持高效率開發。

工程目錄結構的優化是能達到這個目的的一種方式。一般而言,不是多頁面工程還是單頁面應用,抑或二者都有,目錄結構都是以下兩種方式:

  1. 類型分組(按文件類型、業務類型等進行分組)
  2. 模塊分塊(按頁面模塊、業務模塊等進行分塊)

1. 類型分組

這種方式是以文件類型、業務類型或其他類型進行分組。

多頁面工程

|-- src/ 源代碼目錄

    |-- html/ html 文件目錄
        |-- page1.html page1 頁面的 html 文件
        |-- module1/ 子目錄
            |-- page2.html page2 頁面的 html 文件
            |-- ...
            
        |-- ...    
        
    |-- js/ js 文件目錄
        |-- common/ 公共文件目錄
        |-- page1/ page1 頁面的 js 目錄
        |-- module1/ 子目錄
            |-- page2/ page2 頁面的 js 目錄
            |-- ...
            
        |-- ...
        
    |-- css/ css 文件目錄
        |-- common/ 公共文件目錄
        |-- page1/ page1 頁面的 css 目錄
        |-- module1/ 子目錄
            |-- page2/ page2 頁面的 css 目錄
            |-- ...
            
        |-- ...
        
    |-- less/ less 文件目錄(內部結構跟上面類似)
    |-- images/ 圖片文件目錄(內部結構跟上面類似)
    |-- data/ api-mock 文件目錄(內部結構跟上面類似)
    |-- ...

單頁面應用

|-- src/ 源代碼目錄
    |-- components/ 組件文件目錄(如 react)
        |-- common/ 公共文件目錄
        |-- page1.js page1 頁面的組件文件
        |-- module1/ 子目錄
            |-- page2.js page2 頁面的組件文件
            |-- ...
            
        |-- ...    
        
    |-- services/ service 文件目錄
        |-- service1.js page1 頁面的 service
        |-- module1/ 子目錄
            |-- service2.js page2 頁面的 service
            |-- ...
            
        |-- ...
        
    |-- models/ model 文件目錄
        |-- model1.js page1 頁面的 model
        |-- module1/ 子目錄
            |-- model2.js page2 頁面的 model
            |-- ...
            
        |-- ...
        
    |-- ...
    
|-- images/ 圖片文件目錄(內部結構跟上面類似)
|-- data/ api-mock 文件目錄(內部結構跟上面類似)
|-- ...

這種方式的優勢是能使文件分類、功能分類非常清晰,并且能夠在一定程度上約束組員的書寫方式(目錄結構),也清晰明了、簡單易懂。但這種方式有很明顯的缺點:

  1. 不能很簡單快捷的知道某個頁面或某個功能塊有哪些文件;
  2. 創建、更新、刪除頁面會變得很低效,因為需要到不同文件類別目錄去找文件;
  3. 開發效率不高,并且很容易疲勞,因為編輯一個頁面的時候需要在編輯器的文件導航中展開各個文件,導航就會非常長。

所以,對前端項目而言,多數情況下我不會使用這種目錄結構。

2. 模塊分塊

這種方式是以頁面模塊、業務模塊或其他類型進行分塊。

多頁面工程

|-- src/ 源代碼目錄

    |-- page1/ page1 頁面的工作空間
        |-- index.html html 入口文件
        |-- index.js js 入口文件
        |-- index.(css|less|scss) 樣式入口文件
        |-- html/ html 片段目錄
        |-- js/ js 文件目錄
        |-- (css|less|scss)/ 樣式文件目錄
        |-- data/ 本地 json 數據模擬
        |-- images/ 圖片文件目錄
        |-- components/ 組件目錄(如果基于 react, vue 等組件化框架)
        |-- ...
        
    |-- module1/ 子目錄
        |-- page2/ page2 頁面的工作空間(內部結構跟 page1 類似)
        
    |-- ...
    
|-- html/ 公共 html 片段
|-- less/ 公共 less 目錄
|-- components/ 公共組件目錄
|-- images/ 公共圖片目錄
|-- data/ 公共 api-mock 文件目錄
|-- ...

單頁面應用

|-- src/ 源代碼目錄
    |-- page1/ page1 頁面的工作空間
        |-- index.js 入口文件
        |-- service.js
        |-- model.js
        |-- data/ 本地 json 數據模擬
        |-- images/ 圖片文件目錄
        |-- components/ 組件目錄(如果基于 react, vue 等組件化框架)
        |-- ...
        
    |-- module1/ 子目錄
        |-- page2/ page2 頁面的工作空間(內部結構跟 page1 類似)
        
    |-- ...
    
|-- images/ 公共圖片目錄
|-- data/ 公共 api-mock 文件目錄
|-- components/ 公共組件目錄   
|-- ... 

這種方式避免了“類型分組”的問題,但也有一些不足:

  1. 對組員的約束很小,每個工作空間下的目錄結構可以完全不一樣;
  2. 工作空間下的目錄結構不是很容易定義好,對開發人員水平要求要高一些。

盡管有一些不足,但是可以配合構建工具消除,所以一般情況下我會選擇這種目錄結構。

3. 配合使用

很多情況下,這兩種方式是可以配合使用的,比如多頁面工程中有小型單頁面應用。

|-- src/ 源代碼目錄

    |-- page1/ page1 頁面的工作空間
        |-- index.html html 入口文件
        |-- index.js js 入口文件
        |-- index.(css|less|scss) 樣式入口文件
        |-- html/ html 片段目錄
        |-- js/ js 文件目錄
            |-- ajax/ 對 ajax 封裝的目錄
            |-- util/ 工具類函數的目錄
            |-- pages/ spa 應用頁面目錄
            |-- data/ 靜態數據目錄
            |-- tpl/ 模板目錄
            |-- (event|view)/ 事件監聽文件目錄
            |-- ...
        |-- data/ 本地 json 數據模擬
        |-- (css|less|scss)/ 樣式文件目錄
        |-- images/ 圖片文件目錄
        |-- components/ 組件目錄(如果基于 react, vue 等組件化框架)
        |-- ...
        
    |-- ...
    

4. 后續

更多博客,查看 https://github.com/senntyou/blogs

作者:深予之 (@senntyou)

版權聲明:自由轉載-非商用-非衍生-保持署名(創意共享3.0許可證

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374

推薦閱讀更多精彩內容