最近在搭建新項(xiàng)目的iOS框架,一直在思考如何才能搭建出高可用App框架酿傍,能否避免后期因?yàn)榇a質(zhì)量問題的重構(gòu)烙懦。以前接手過許多“爛代碼”,架構(gòu)松散赤炒,底層混亂氯析,缺少規(guī)范,導(dǎo)致團(tuán)隊(duì)開發(fā)時代碼風(fēng)格迥異莺褒,清晰的項(xiàng)目結(jié)構(gòu)和良好的代碼規(guī)范是保證產(chǎn)品質(zhì)量的關(guān)鍵掩缓,下面分享一下我的架構(gòu)思路。
架構(gòu)圖:
架構(gòu)圖
架構(gòu)原則:易讀性遵岩、易維護(hù)性你辣、易擴(kuò)展性。
一尘执、思考
做好一件事舍哄,花在思考上的時間應(yīng)該多于執(zhí)行。
首先根據(jù)產(chǎn)品需求和設(shè)計圖誊锭,腦中先建立一個產(chǎn)品架構(gòu):
1. 產(chǎn)品的定位是什么表悬。
社交?媒體丧靡?游戲蟆沫?運(yùn)動?音視頻温治?電商……要搞清楚你要做一個什么類型的App饭庞,不同類型的產(chǎn)品,技術(shù)選型也有所不同熬荆,在這我是搭建一個基礎(chǔ)App架構(gòu)舟山,可以在此基礎(chǔ)上拓展社交、電商、音視頻等捏顺!
2. 技術(shù)選型
根據(jù)當(dāng)前產(chǎn)品的需求以及未來可能有的需求(我怎么知道未來會有什么需求六孵?可以參照競品,可以發(fā)揮想象幅骄,如果產(chǎn)品說:“我們要做IM文字聊天,只做文字本今!不做音視頻拆座,以后都不做!” 類似這樣的承諾冠息,你如果信了他的邪……后面的故事就精彩了挪凑。。哈哈哈哈哈哈逛艰。躏碳。。散怖。所以說這時候你就要考慮到后面會有語音+視頻聊天菇绵,在設(shè)計的時候不要偷懶,預(yù)留一定空間镇眷,當(dāng)某天產(chǎn)品反悔的時候咬最,你可以微微一笑,從容應(yīng)對欠动。
一把拉回話題永乌,接著說技術(shù)選型,通常我會選擇一些當(dāng)下比較熱門具伍、好用的第三方框架翅雏,例如:YYKit?,YYKit 是一組龐大人芽、功能豐富的 iOS 組件望几,包含Model解析、圖片加載啼肩、緩存等基礎(chǔ)服務(wù)橄妆,都是基于Category設(shè)計的,使用方便且性能高于一些老的框架祈坠,用過的都說好害碾。
其他框架的選擇可以根據(jù)項(xiàng)目需求,去GitHub上搜索赦拘,星星多的每個都看一下慌随,會給你增加一些思路。
程序猿長得可以保守,思想一定不能太保守阁猜。
二丸逸、搭建目錄結(jié)構(gòu)
目錄圖解
如上圖,我是這樣搭建App目錄結(jié)構(gòu)的剃袍,從下到上黄刚,使用Pods管理第三方框架,將第三方框架進(jìn)行二次封裝民效,供給頂層使用憔维,盡可能減少各模塊之間的耦合度,只為更清晰畏邢。
三业扒、封裝基礎(chǔ)類
1.應(yīng)用入口
1. AppDelegate是應(yīng)用的代理,應(yīng)用級的事件都委托它處理舒萎,包含啟動退出程储、推送等事件,以及IM臂寝、支付等第三方的回調(diào)章鲤,這使得AppDelegate內(nèi)代碼龐大,錯綜復(fù)雜交煞,十分不利于閱讀和維護(hù)咏窿,因此我新增了一個AppDelegate+AppService類別,用來處理生命周期之外的業(yè)務(wù)素征,AppDelegate作為事件入口集嵌,具體實(shí)現(xiàn)直接調(diào)用類別里的方法,只為更清晰御毅。
2. 功能模塊
2. Modules包含了應(yīng)用內(nèi)的功能模塊根欧,根據(jù)底部Tab欄劃分并關(guān)聯(lián)實(shí)體文件夾(默認(rèn)是虛擬的要手動建立實(shí)體文件夾拖進(jìn)來),每個模塊內(nèi)使用的是MVC模式端蛆,有人會問為什么多了Resource和Service文件夾凤粗,MVC是一種設(shè)計思想,并非死套路就仨文件夾今豆,根據(jù)實(shí)際需求適當(dāng)增加嫌拣,在這我選擇在Service封裝數(shù)據(jù)請求,VC里調(diào)用拿數(shù)據(jù)即可呆躲,至于Resource為什么在這异逐,我認(rèn)為當(dāng)功能模塊層級較多時,每個大功能模塊都對應(yīng)許多資源插掂,對應(yīng)到模塊內(nèi)用起來方便灰瞻,當(dāng)然也可以放到最外層的Resource文件夾里腥例,建立對應(yīng)的模塊名稱,在這兒我是選擇把公共的放到最外層Resource里酝润,功能相關(guān)的放到模塊里的Resource文件夾內(nèi)燎竖,只為更清晰。
3. 管理模塊
3. Manager的定義是全局基礎(chǔ)服務(wù)要销,通常使用類方法或者單例來實(shí)現(xiàn)构回,主要包含對應(yīng)用、用戶的管理和服務(wù)疏咐,例如網(wǎng)絡(luò)狀態(tài)監(jiān)聽捐凭,廣告頁應(yīng)用介紹頁等;用戶快速登錄退出操作以及登錄狀態(tài)的獲取等凳鬓。只為更清晰。
4.工具類
4. Utils文件夾內(nèi)主要包含全局通用工具患民,來源于對三方框架的二次封裝缩举,或是自己寫的工具類。在這個項(xiàng)目里匹颤,我封裝了帶AES加密網(wǎng)絡(luò)請求工具仅孩,全局Toast提示,廣告頁等印蓖。只為更清晰辽慕。
5. 基類
5. Base文件夾用來存放項(xiàng)目的基類,基類作用包含一些定制化的內(nèi)容赦肃,例如頁面樣式溅蛉,空數(shù)據(jù)頁面等,使用基類來實(shí)現(xiàn)他宛,可以統(tǒng)一控制船侧,利于維護(hù),減少冗余厅各,也為更清晰镜撩。
6.第三方 & 7.全局宏定義
6. 第三方文件夾放一些第三方的類庫和對第三方封裝,比如第三方登錄队塘、支付袁梗、IM等,現(xiàn)在項(xiàng)目我還沒有添加第三方框架憔古。
7.全局宏顧名思義是定義了一些全局通用宏遮怜。我這里定義了四個:
UtilsMacros定義的是一些工具宏,比如獲取屏幕寬高投放,系統(tǒng)版本奈泪,數(shù)據(jù)類型驗(yàn)證等;
URLMacros定義服務(wù)器接口地址以及環(huán)境開關(guān);
FontAndColorMacros定義全局用的色值涝桅、字體大小拜姿,這里建議跟設(shè)計師共同維護(hù)一個設(shè)計規(guī)范,例如:定義一個主色調(diào)宏 MainColor冯遂,色值是 0x333333蕊肥,我們?nèi)质褂肕ainColor宏作為背景顏色,當(dāng)某天App改版蛤肌,色值改變壁却,我們只需要去更改 0x333333即可,其他代碼不需要動裸准,同時也能一定程度約束設(shè)計師展东,不要隨便增加一種顏色,非常接近的顏色應(yīng)當(dāng)使用一個炒俱。如果設(shè)計師不愿意維護(hù)這個規(guī)范盐肃,你可以嘗試打一架,打不過的話权悟,就只能自己維護(hù)了砸王,只為更清晰。
ThirdMacros 包含第三方框架相關(guān)的定義峦阁,例如keySecret等谦铃。只為更清晰。
8. 資源文件
8. 資源文件榔昔,上面說到過驹闰,這里我是存放了全局的一些資源文件,功能模塊的我放到了模塊內(nèi)的Resource文件夾內(nèi)件豌,個人喜好疮方,只為更清晰。
9. Pods三方管理
9. CocoaPods是iOS項(xiàng)目的依賴管理工具茧彤,開發(fā)iOS項(xiàng)目不可避免地要使用第三方開源庫骡显,CocoaPods的出現(xiàn)使得我們可以節(jié)省設(shè)置和第三方開源庫的時間曾掂。
下面對你也許有幫助:
iOS 團(tuán)隊(duì)編碼規(guī)范—— 團(tuán)隊(duì)開發(fā)需要共同遵守的代碼規(guī)范
代碼注釋,教你用快捷鍵+代碼塊實(shí)現(xiàn)快速注釋—— 讓注釋不再是負(fù)擔(dān)珠洗,快捷鍵幫你解決
通用工具類宏定義—— 進(jìn)一步提升編碼效率