iOS工程目錄結構的思考

一、前言

@漢斯哈哈哈iOS 項目的目錄結構能看出你的開發經驗 這篇博客里提到一點:

  • 面試iOS開發,面試官竟然問他『怎么分目錄結構』的,而且還具體問到每個子目錄的文件名。
  • 清晰的目錄結構,可讓人一眼知道對應目錄的職能,這也能體現開發者的經驗和架構能力。

恰巧,有一次我參加面試,也被問到過類似的問題。
??在日常工作中我自己對此也深有感觸,《代碼大全》里有個觀點:

代碼首先是給人看的

我覺得,一個項目的目錄結構也是如此。以下是我個人的一些看法。

二、不合理的目錄結構

我想應該沒人覺得一個項目的 「工程目錄結構」這個東西不重要。
??沒人討論這個可能是因為項目不同、團隊風格不一樣、目錄結構沒有個通用的標準,不太好下個結論。
??而且項目工程目錄結構這個東西,除非開始一個新項目,其它時候大多都是沿用舊項目里已有的目錄結構。真正從無到有的完整搭一個新項目,除了軟件外包公司,我想機會不是很多。

我因為非科班出身,剛入行時不是很懂,為了先找到一份工作,同時想著快速接觸更多的項目(靠數量增加經驗),所以在軟件外包公司待過一段時間,接觸了不少新開始的項目,也接手了不少舊項目的版本升級、維護等工作。

這是我接觸過的一些項目的結構目錄:

為什么不合理:

我覺得普遍存在以下幾個問題
1 、目錄結構沒有層次性:
??有的工程,一級目錄展開后就是十幾個二級目錄的文件夾。


2 、目錄結構層次過深:
??文件夾過多、層級過深,會增加點擊的成本。
3、單個目錄下文件數過多
??某級目錄內文件數量過多,展開后超過一屏。出現這種情況,我覺得就是目錄結構設置不合理導致的。
4、目錄命名不能夠「見名知意」:
??大量的 CommonToolHelperOther這樣的文件夾名。
5、沒有項目目錄結構的ReadMe說明;
??這個屬于代碼文檔中不容忽視的一點。
6、目錄存在使用中文命名的情況;
7、結虛擬文件夾與實體文件夾沒有一一對應:

可能導致的問題:

1、一個糟糕的目錄會讓人對工程瞬間失去興趣。
??2、如果打開一個工程,沒辦法通過閱讀目錄結構獲得對整個項目結構的大致的了解,這樣的目錄結構就是不夠合理的。這樣會導致在不熟悉項目的情況下,很難明白各個模塊、各個文件夾里的類的作用。
??3、目錄結構如果沒有統一的規范,類文件的命名也很難有相應的規則來進行約束;
??4、對于新加入項目的人,如果需要新增一些類文件,會不知道究竟該放在哪個目錄下合適,只能先"憑感覺"隨便找個地方一放。這樣的工程維護起來,只會越來越亂。

三、我的個人經驗

1、 簡叔在 iOS 項目的目錄結構能看出你的開發經驗 一文下的評論:

看到這條評論不勝贊同。
??我自己就很喜歡整理,不論是電腦上的盤符目錄,還是印象筆記下的筆記本目錄,我都習慣于編個號、定期整理。


??這樣一般我要找一個存在自己電腦上的東西,在找之前,頭腦里就已經基本想到它會在那個大目錄、哪個子目錄下。配合搜索功能,很少會找不到文件。
??同時,存的時候也不會隨便找個地方一放,亂七八糟。基本已經形成一套自己熟悉的規則了。

2、 高質量iOS開發系列之(一)-iOS項目工程及目錄結構 中提高的幾個基本原則:

  • 一個合理的目錄結構應該是清晰的,讓人一眼就能了解目錄職責,并且是容易擴展的。
  • 不管是第三方庫還是自己的庫,盡量用CocoPods來管理/區分不同層次的通用組件。
- General Level, 最通用的組件,可以在不同項目里復用。
- Project Level, 可以在該項目里復用。
- Section Level, 可以在某個功能模塊里復用。
  • 對于General Level的組件,以Library的形式分出來,不要放在主工程。
  • 對于基礎庫,保證質量,通用性,可擴展性,易用性,可以不斷迭代

此外,該文章中講到的各模塊注意事項,非常切合iOS開發的實際。建議閱讀原文,我就不在這里搬運了。

3、 @漢斯哈哈哈 提到的兩種常用目錄結構的分法:

1.主目錄按照業務分類,內目錄按照模塊分類
2.主目錄按照模塊分類,內目錄按照業務分類

我個人偏向于第二種:按照業務模塊劃分。因為:

1> 第一種如果項目較大,經常會出現找個控制器對應的tableviewcell找半天。如果不是自己寫的,更難找。
2> 開發某一具體功能的時候,涉及到的類基本都是該業務模塊里面的類,很少會出現跨目錄的情況。而第一種情況則需要經常會跨目錄。
3> 從文件耦合度來講,各業務模塊里的文件耦合度相對來說比較高。放在一個目錄內,也符合軟件設計中的高內聚低耦合思想。

4、一個簡單的工程結構目錄的Demo

  • 一級目錄如下:(中文備注是為了便于理解,實際項目中不要加)


  • 二級目錄如下:


5、公用的類、模塊放在哪里:
??一般的做法是遇到共用模塊單獨建一個模塊叫common,都放到這里。(這樣其實也不是很好,Common也是屬于定義模糊的命名)
6、多個Target的情況:
??可以單獨出一個Project文件夾,按Target名分各個子目錄,內放各個Target中獨有的文件。
7、圖片資源最好都用 Images.xcassets 去管理。
??Images.xcassets 文件里邊也按業務模塊分子文件夾,這樣可以方便的預覽圖片。

四、Tips

在定位項目中的文件時,善用以下快捷鍵可以節省大量時間:

1、Xcode左下角的搜索框 (不支持模糊搜索、會展開對應目錄)

快捷鍵: Command + option + j

2、工程全局搜索(支持模糊搜索、不會展開對應目錄)

快捷鍵: Command + shift + O


注:

以上只是我個人的一些經驗,總結的不是很完善。同時有很多地方借鑒了以下文章的觀點。有什么能改進的地方,歡迎在評論區討論!

</br>

參考:

高質量iOS開發系列之(一)-iOS項目工程及目錄結構
iOS項目的目錄結構和開發流程
iOS 項目的目錄結構能看出你的開發經驗

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

推薦閱讀更多精彩內容