關于工程目錄結構和代碼管理,每個開發者可能都有自己的理念和習慣,但是都應該以簡單、清晰、容易查找為原則。比較混亂的結構,會讓新同事甚至自己在開發的過程當中都會絆手絆腳。這里就舉個反栗子,直接貼一下我們公司項目兩年多前1.0版本的工程結構。當初剛剛看到這個工程,我是直接暈了過去,想走的心都有了。。。這里就不說這樣的結構有什么問題,相信哪位同事現在也應該不會搞出這樣的東東來。
我開始參與這個項目之后,1.1版本第一件做的事就是對工程目錄結構進行了調整。不過經過兩年40多個版本的迭代開發,項目結構很多代碼文件又開始有點混亂的感覺,一些文件的查找很不方便。這次趁著項目重構的機會,又對工程的目錄結構進行一下調整。下面是新工程目錄結構的導圖。
主要有三大部分,Core存放我們的代碼,也是文章主要說明的部分。Resource存放資源,例如圖片、音效、文件等等,至于圖片現在很多基本都用assets來管理了;SupporrtingFiles存放pch、main.m等等,一般我們也不能把文件放到這個位置。因為這個分組的點擊次數是最少的,所以放到最下面。
Core的分組主要分為AppDelegate、Modules、NetWork/Requests、Services、General、Macro、Vendors等六個大模塊。
AppDelegate
這里只放AppDelegate的h和m文件,也可以放入其他跟AppDelegate有關的文件,比如我們寫了一個AppDelegate+Router的Category文件,用來處理rootViewController的變化,這個也應該放到這個分組來比較清晰,而不是放到General的Category。
Modules
Modules放應用的業務邏輯代碼,比如微信可以分‘微信’、‘通訊錄’、‘發現’、‘我’等四個主模塊,然后‘我’里面還可以分收藏、錢包、表情等等模塊。總而言之,Modules就是放App主要業務邏輯和功能代碼的地方。
Network/Request
Network這一模塊,又可以命名為Request,主要放我們的網絡請求方法。每個Path包含的請求寫一個類。這一塊當然大家可以根據的自己的項目來定,因為我們后臺的api,同一個Path下面的方法,有可能被Modules里面不同的模塊調用,所以,我這里把網絡請求方法獨立出來了。
Services
服務模塊,這一模塊,主要提供應用的基礎服務,比如說Apns推送管理,數據庫,本地推送等等,這一類的封裝之后的功能模塊。
General
General用來放通用性的代碼,CustomUI指我們寫的UI控件;Category指我們寫的Category文件了;Base指基類,如baseModel,baseViewController等等;Utils指工具類。
這里要強調是General必須是不涉及Modules里面邏輯的代碼。舉個栗子,我們編寫的一個ChartView,用來顯示各類投資收益占比的餅圖,它已經包含了投資收益的計算邏輯(最好這類邏輯也不好寫入控件),這個時候,這個ChartView已經不適合其他地方去使用,所以它更適合放到Modules對應模塊的View分組去。
Macros
Macros模塊宏定義的文件,我個人習慣定義不同的宏文件,比如說ConfigMacrof主要包含跟App配置相關的宏,UtilMacro包含工具類的宏等等。一些pch包含的定義性文件也可以放到這里來,比如說CommonEnum主要保存一些常用的枚舉定義,我也會把它放到Macros這個模塊來。
Vendors
所有的第三方類庫都放到Vendors里面。
最后提一下Assets,我個人在使用的Assets的時候,一般是根據Modules里面的功能模塊也分組存放圖片的。大部分的圖片資源也是用在這些Modules,這樣就很方便我們在開發的時候查找圖片,已經后續修改對應的模塊,也容易替換資源。