原文出處:Limboy。
網路上相關的資源不多,開源且品質還不錯的 iOS 專案也是少之又少。最近剛好和同事合作了一個 iOS 專案,來談談自己的一些想法。
文章目錄
一個合理的目錄結構,首先必須清晰:讓人一眼看上去就能大致了解各目錄的職責,並且容易應對後續的變化。我們的切法是這樣:
AppDelegate Models Macro General Helpers Vendors Sections Resources
放 AppDelegate.h / .m,整個應用的入口檔案,所以單獨拉出來。
放與資料相關的 Model 檔案:
Models |- BaseModel.h |- BaseModel.m |- CollectionModel.h |- CollectionModel.m ...
放整個應用會用到的巨集定義:
Macro |- AppMacro.h |- NotificationMacro.h |- VendorMacro.h |- UtilsMacro.h ...
AppMacro.h 放 app 相關的巨集,例如:
// 表情相關 #define EMOTION_CACHE_PATH @"cachedemotions" #define EMOTION_RECENT_USED @"recentusedemotions" #define EMOTION_CATEGORIES @"categoryemotions" #define EMOTION_TOPICS @"emotiontopics" // 收藏相關 #define COLLECT_CACHE_PATH @"collected" // 配圖相關 #define WATERFALL_ITEM_HEIGHT_MAX 300 #define WATERFALL_ITEM_WIDTH 146
NotificationMacro.h 放通知名稱相關的巨集;UtilsMacro.h 放一些方便使用的小工具:
#define UIColorFromRGB(r,g,b) [UIColor colorWithRed:r/255.0 green:g/255.0 blue:b/255.0 alpha:1] #define NSStringFromInt(intValue) [NSString stringWithFormat:@"%d", intValue]
VendorMacro.h 則放第三方常量:
#define UMENG_KEY @"xxxxx" #define UMENG_CHANNEL_ID @"xxx"
如果出現新的類型,再新建一個相關的 Macro.h 即可。
放會被重複使用的 Views / Classes 與 Categories:
General
|- Views
| |- TPKScollView
| |- TPKPullToRefresh
| ...
|- Classes
| |- TPKBaseViewController
| |- TPKHorizontalView
| ...
|- Categories
|- UIViewController+Sizzle
|- UIImageView+Downloader
...
這裡的 TPK 是專案名稱的字母縮寫。
放各種助手類別,檔名與功能掛鉤:
Helpers |- TPKShareHelper |- TPDBHelper |- TPKEmotionHelper ...
助手類的主要作用是幫 Controller 瘦身,同時提供一定程度的複用。
放第三方的類庫 / SDK,如 UMeng、WeiboSDK、WeixinSDK 等。
對應 app 的具體業務單元,如導航、瀑布流等:
Sections |- Menu |- Setting |- Collection ...
放 app 會用到的資源,主要是圖片。
與業務無關的類庫可以透過 Cocoapods 方便地管理,如 SDWebImage、Reachability 等。還有一些是多個應用都會用到的基礎模組,比如公司內部的 API 層、社群分享層、基礎工具層(此處以 HBFoundation 為例),可以建一個私有的 git repo 加進 Podfile。這樣一旦上游有更新,只要 pod update 一下就行了。
順帶一提基礎工具庫的價值:這個 git 倉庫可以放一些幾乎所有應用都會用到的小模組。例如很多 app 都會隔一段時間跳出一個「求好評」的 alertView,寫成一個 Rating 類之後,需要的 app 只要加上一句 [HBRating checkIfShouldPopupWithAppID:(NSInteger)appID] 就搞定。又比如 app 普遍都有接收 push notification 的需求,也可以抽成獨立類別。
拿到設計稿後,第一件事不是埋頭寫畫面,而是先從設計稿中抽離出可複用的 Classes / Views / Helpers,想清楚某個效果該怎麼實作,並選用合適的設計模式來避免大量 if/else 嵌套。
不要一開始就鑽進 Sections 裡逐頁實作。乍看之下可能快一點,但只要專案稍有複雜度,這種做法到後期只會吃盡苦頭——程式碼會越來越難維護。所以前期一定要把準備工作做足。
經驗有限,如果你有更好的想法,歡迎交流。