最近在維護一個老項目,說起來工作內容很簡單,就一個字:改 Bug。看似平淡無奇,實際上卻凶險無比、暗坑密布。折騰到現在,只覺得整个人都得到了「升華」。趁睡前抽空寫篇博客,和大夥兒分享分享這些踩坑經歷,一塊兒細細品味其中的酸甜苦辣(甜是沒有的)。
為了保護個資隱私,文中代碼均為化名,敬請諒解;如有雷同,純屬巧合(可以 git blame 查查看是誰寫的)。
如果要折磨一個強迫症,最好的辦法就是用各種奇葩變量名把他噁心死。
什麼?你說首字母要大寫?
@property (nonatomic, assign) PERSONTYPE personType;
什麼?你說單詞裡要小寫?
typedef enum tagPersonType{
person_type = 1,
group_type,
} PERSONTYPE;什麼?你說要用英文單詞命名?
- (void)uploadSeccess:(MessageEntity *)message;
什麼?你說類名前要加前綴避免衝突?
@interface PMWLogger : NSObject ... @interface PMTool : NSObject ... @interface MainControler : NSObject
什麼?你說文件要按目錄歸置?
什麼?聽說 OC 能用宏定義?
#define STRHASSBUSTR(str,subStr) ...
各位看官,這,能忍?正所謂:
命名拼寫看心情,文件目錄不分明。
隨機摻雜宏定義,雞不安也犬不寧。
前陣子在做 iPhone 4、iPhone 6 與 iPhone 6 Plus 的適配。由於歷史原因沒用 Auto Layout,老代碼的布局全靠一個個數字硬寫出來,這可給適配添了大麻煩。
隨手揀段代碼給大家「欣賞」:
UILabel *infoLabel = [[UILabel alloc] initWithFrame:CGRectMake(0, 241, 320, 28)];
0 還好說,241 就完全讓人摸不著頭腦;320 換成屏幕寬度也罷了,可 28 這種「神奇數字」又是從哪冒出來的?這種代碼簡直是抱著「干死隊友不償命」的心態寫的:寫着容易,維護要命,可讀性極差。一旦有多個控件布局,依賴關係不明顯,想調個布局就得挨個重算重設,那份酸爽,誰用誰知道。
說到神奇數字,集大成者莫過於此:
CGRect rect = CGRectMake(12.2+(page-1)*320+42.5*(i%7),((totalRows-1)%3)*55+2,42.5,42.5);
那天早上看到這行,差點抱著鍵盤委屈地哭出來。正所謂:
界面寫法各不同,歪門邪道千萬種。
有朝一日被辭了,你的代碼我不懂。
聊天時看到這麼一個數據類:
@interface HBTalkData : NSObject {
UIImage *_firstImage;
NSArray *_imageArry;
id _contents;
}
@property (nonatomic, assign) NSInteger messageId;
@property (nonatomic, strong) id contents;
// ...(此處省略大量屬性與方法)
@end纖弱的頭文件裡塞滿了各種屬性與方法定義,仿佛能聽到它的「呻吟」。
再出道題:看下面這段,猜猜這個類的文件名叫什麼?
@interface PersonInfo : NSObject ... @end @interface UserInfo : PersonInfo ... @end @interface GroupInfo : PersonInfo ... @end
嗯,然後這文件叫做 UserInfo.h,頭文件將近 100 行。大兄弟,我書讀得少,你可別騙我。把三個類硬塞進一個文件,除了難為隊友,實在看不出別的動機。正所謂:
頭文件裡地方小,塞到一處並不好。
外部對象都知道,安全問題可不小。
我時常在想,到底是什麼,讓這項目的開發者對 NSNotificationCenter 如此癡迷,癡迷到令人陶醉。
通過 Model 調用業務邏輯時,它這樣發了條命令:
// 喂,LOGIN_MODEL,幫我查下有沒有更新 [LOGIN_MODEL versionCheckFromAbout:YES];
這業務用 GCD 開了新線程在後台檢查更新,若有更新,版本號後面會加個感嘆號。問題來了:你咋告訴我到底有沒有更新?難道要寫個委託、定義方法、指定委託、有結果再回告?聽著就煩,那乾脆用通知好了:
if (self.versionStatus != VersionStatusNormal) {
[[NSNotificationCenter defaultCenter] postNotificationName:NOTIFY_HAS_NEW_VERSION object:nil];
}然後在需要處理的類裡加個 Observer 就搞定了:
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(myIconShouldChange) name:NOTIFY_HAS_NEW_VERSION object:nil];
哈哈哈哈搞定!——搞定你個頭啊!整個項目裡類似的通知就有十來個,這還是帶宏定義、算好追查的;那些沒宏定義、隨手複製粘貼的,還不知道要填多少坑。通知雖好,可不要貪杯啊。它看似輕鬆,post 一下就完事,但 Debug 時頗麻煩,尤其是多個 Observer 牽一發而動全身。本來一個 block 或 delegate 就能清爽解決的事,非要搞得這般繁重,實在沒必要。
通知好歹只是「不痛不癢」,邏輯不夠優雅罷了;但若委託用不當,那就噁心得不行。看這個聊天頁面:
@interface ChattingViewController () < UITableViewDataSource, UITableViewDelegate, UITextViewDelegate, ChattingActionsPanelDelegate, ChatModelDelegate, UIImagePickerControllerDelegate, UINavigationControllerDelegate, HBTalkTableViewCellDelegate, EGORefreshTableHeaderDelegate, XTImagePickerControllerDelegate, ChattingInputPanelDelegate, VoiceRecordingButtonTrashBinViewContainer, ChattingUserDetailPanelDelegate, VoiceRecordingButtonDelegate>
這是個真實的故事:整個類將近 3000 行,其中 2000 多行都是委託裡定義的方法,你敢信?在這三千行裡漫步,事事都得小心,因为你根本分不清 callIn 到底是私有方法還是委託方法。#pragma mark 也是看心情加,加錯了你別當真;有的委託都刪得不見蹤影了,方法卻還留在舊類裡——沒人敢動。正所謂:
異步回調用通知,委託多的令人癡。
反正老子看不懂,不寫代碼光寫詩。
做 iOS 的都知道 AFNetworking。在我們項目裡,AFNetworking 分兩種:別人家的,和咱們的——對,就這麼任性。在一個 300 行的頭文件裡,於第 99 行那樣低調的位置,靜靜插進了自己的方法,還在上面一本正經地寫了「準確」的註釋:
/*擴展*/
- (void)setDDCImageWithURL:(NSURL *)url
placeholderImage:(UIImage *)placeholderImage
success:(void (^)(NSURLRequest *request, NSHTTPURLResponse *response, UIImage *image))success
failure:(void (^)(NSURLRequest *request, NSHTTPURLResponse *response, NSError *error))failure;擴展個頭啊!加在人家頭文件裡還說自己是擴展,誰信?這種改動遍地都是,特點是極其低調、難以察覺,連 TTTAttributedLabel 這類 UI 庫也未能倖免——改了 init 來統一字體和顏色……你說這代碼,誰敢動?我曾天真地想給項目加 Cocoapods 更新第三方庫,現在想想,太 Naive,還是等寫到新獨立模塊再說吧。正所謂:
項目勤用三方庫,隨意穿插改無數。
即使類庫有更新,試問代碼誰維護。
聊天模塊裡有個 ChatModel,簡直是個「多面手」。
上能跟服務器對話,上傳消息、同步聊天記錄:
- (void)reSendMessages; - (void)receiveSecretaryMessage:(MessageEntity *)msgEntity; - (int)saveMessage:(MessageEntity *)message;
下能做本地緩存管理,增刪改查樣樣精通:
- (void)saveCacheMsg:(NSString *)msg UserMd5:(NSString *)md5; - (NSString *)loadCacheMsgWithMd5:(NSString *)md5; - (void)clearCacheMsgWithMd5:(NSString *)md5;
至於彈窗提醒、上傳進度、完成提示,也是輕鬆拿下。以至於你改着改着不知不覺就走到這裡——它處理了太多業務邏輯,每次 DEBUG 追着斷點回到這裡,都像久別重逢的相遇,似曾相識。正所謂:
一人做事一人當,切忌都往類裡裝。
開發人員幹的爽,維護人員很受傷。
需求來也匆匆去也匆匆,讓人猝不及防。比如一個簡單的登錄邏輯:
@interface LoginModel () @property (nonatomic, strong) NSString *tcpURL; @property (nonatomic, strong) UserInfo *offlineCallUser; @property (nonatomic, assign) VersionStatus versionStatus; @end
突然要加個 API 檢查,簡單,加個 BOOL 需要時設 YES 就行;About 頁又要改,再加個 BOOL;已經顯示註冊頁又要少發請求,行,再加個 BOOL……得,這代碼只有你自己看得懂了:
@interface LoginModel () @property (nonatomic, strong) NSString *tcpURL; @property (nonatomic, assign) BOOL isShowVersionUpdate; @property (nonatomic, assign) BOOL checkVersionFromAbout; @property (nonatomic, assign) BOOL isRegisterShow; @end
想象一下實現裡對這堆 BOOL 標記的各種特殊處理,再想象一下 N 層 if 嵌套的「壯觀」場景。心塞。正所謂:
凡是都要聽產品,各種業務催的緊。
天塌下來也別怕,邏輯清晰自然挺。
所謂悲哀就是:當程序員發現一個 delegate 就能訪問上級對象,於是把各種要通知上級的事都塞進委託方法裡,哪怕八竿子打不着,為了跑通功能也顧不上什麼設計與美觀了。一個簡單的 @optional,甚至能用同一個 @protocol 拿到各種不同的上級對象,每次調用加個 respondsToSelector 就行。寫上十幾個可選方法,取個通俗的委託名比如 MyDelegate,你若持有我、我又想調你的方法,so easy,扔進 MyDelegate 即可。此時的代碼,早已不是一件藝術品,而是個毫無生氣的花瓶了。
原本還是挺歡快地在吐槽,寫着寫着突然就不想寫了。看着前人留下的代碼,心裡不禁有些淒涼——在項目裡用盡各種「低級下流」的手段,只為跑通自己的業務,這對藝術是何等的侮辱。
(本文作者:@請叫我汪二)