【發現趣味】要你命三千——老程式碼中的那些坑

本文作者：Wang Hyde
程式碼倉庫：
https://gitcafe.com/callmewhy
部落格地址：
http://callmewhy.gitcafe.io

最近在給以前的老專案維護，說起來工作很簡單，一個字：改 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

什麼？你說檔案要按照目錄存放？

    - Classes
      - MainControllers
        - MyController
        - Controllers
        - SettingControllers
        - ChatModel.h
        - ChatModel.m
        - SettingControllers (不是手誤)
      - Chatting
      - SearchView.h
      - SearchView.m
      - Voice
      - AgentModels
   - Public 
     - Common
     - PublicDef.h
     - PublicDef.m

什麼？聽說 OC 可以用宏定義？

 #define STRHASSBUSTR(str,subStr) ...

各位看官，這，能忍？

正所謂：

命名拼寫看心情，檔案目錄不分明。
隨機摻雜宏定義，雞不安也犬不寧。

第二回：介面全靠神奇數，保準看到就發怵

前陣子在做 iPhone4 和 iPhone6 以及 iPhone6 Plus 的適配工作。

由於歷史原因沒有用 AutoLayout ，也由於歷史原因老程式碼的佈局全是用數字一個一個寫死的。這就給適配帶來了莫大的困難。

隨便揀點程式碼給大家欣賞欣賞：

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;
    @property (nonatomic, assign) NSTimeInterval timeInterval;
    @property (nonatomic) BOOL fromSelf;
    @property (nonatomic) BOOL isGroup;
    @property (nonatomic, assign) HBTalkDataStatus talkDataStatus;
    @property (nonatomic) HBTalkDataContentType contentType;
    @property (nonatomic, strong) PersonInfo *personInfo;
    @property (nonatomic, strong) UserInfo *cardUser;
    @property (nonatomic, assign) CallType callType;
    @property (nonatomic, strong) NSString *duartion;
    @property (nonatomic, strong) NSString *mPhoneNumber;
    @property (nonatomic, strong) NSString *imageList;
    @property (nonatomic, strong) NSString *msgDesc;
    @property (nonatomic, readonly) UIImage *firstImage;
    @property (nonatomic, readonly) NSArray *imageArry;
    @property (nonatomic, assign) float     cellHeight;
    @property (nonatomic, assign) CGSize    textSize;
    @property (nonatomic) NSTimeInterval voiceDuration;
    @property (nonatomic) CGFloat dataSize;
    @property (nonatomic) NSUInteger bubbleCount;
    @property (nonatomic, copy) NSString *chatUserName;
    @property (nonatomic, strong) MessageEntity *originalMessage;
    @property (nonatomic, strong) HBTalkDataRegisterInfo *registerInfo;    
    -(void)reset;
    -(NSString *)bubbleDescription;
    ...
    @end

纖弱的標頭檔案裡塞滿了各種屬性定義和方法定義，彷彿可以聽到標頭檔案的不滿和嬌喘。

給大家出個題：看下下面的內容，猜一下這個類的檔名是什麼：

... // 此處省略20行

@interface PersonInfo : NSObject
... // 此處省略20行
@property (nonatomic, assign)BOOL     isGrey;
@property (nonatomic, assign)BOOL     isBlack;
@property (nonatomic, assign)BOOL     isTop;
@property (nonatomic, assign)BOOL     isStar;

- (BOOL)isStranger;
- (BOOL)isIndividual;
- (BOOL)isDuDuSecretary;

@end

@interface UserInfo : PersonInfo
... // 此處再省20行
@property (nonatomic, assign)BOOL     mobileVerified;
@property (nonatomic, strong)NSString *countryCode;
@property (nonatomic, readonly)NSString *dialogName;
@end

@interface GroupInfo : PersonInfo
... // 此處又省20行
@property (nonatomic, strong)NSString *creater;
@property (nonatomic, assign)int      memberCount;
@property (nonatomic, strong)NSString *members;
@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 就能簡單清晰的解決，現在卻被搞得這麼繁重，實在是沒有必要。

而且 NSNotificationCenter 的程式碼基本是一種變相的複製貼上，十分的不工整。這是個人恩怨了，撇開不提。

NSNotificationCenter 這種只是不痛不癢的小問題，僅僅是邏輯不夠優雅，關係不夠清晰罷了。但是如果委託使用不當那是噁心的不行。看下這個聊天頁面：

@interface ChattingViewController () <UITableViewDataSource, UITableViewDelegate, UITextViewDelegate, ChattingActionsPanelDelegate, ChatModelDelegate, UIImagePickerControllerDelegate, UINavigationControllerDelegate, HBTalkTableViewCellDelegate, EGORefreshTableHeaderDelegate, XTImagePickerControllerDelegate, ChattingInputPanelDelegate, VoiceRecordingButtonTrashBinViewContainer, ChattingUserDetailPanelDelegate, VoiceRecordingButtonDelegate>

這是一個真實的故事。整個類將近 3000 行，有 2000 多行是委託裡定義的方法，你能信？

在這三千行程式碼裡漫步，萬事都要小心。因為你不知道 callIn 這種方法到底是定義的私有方法，還是在委託裡定義的方法。#pragma mark 自然也是看心情加的，說不定加錯了你也不要當真。

有時候委託都刪了不見影子了，但是委託裡的各種方法還留在以前的類裡。

沒人敢動。

How to play.

正所謂：

非同步回撥用通知，委託多的令人痴。
反正老子看不懂，不寫程式碼光寫詩。

第五回：第三方庫無出處，隨手改動無備註

相信做 iOS 的都知道 AFNetworking 這個網路庫，在我們的專案裡 AFNetworking 分兩種，一個是別人家的 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;
- (void)deleteMessagesByUserInfo:(UserInfo *)user;
- (void)setAudioMessageBePlayed:(AudioMessageEntity *)audioMessage;
- (void)sendBubbleReplyWithCallMessage:(CallMessageEntity *)callMessage;
- (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 就行：

@property (nonatomic, assign)BOOL isShowVersionUpdate;

但是這個功能在 About 頁面又有點改動，簡單，再加個 BOOL 就行：

@property (nonatomic, assign)BOOL checkVersionFromAbout;

然後如果已經顯示了註冊頁面又要少一些請求，行，那再加個 BOOL 值：

@property (nonatomic, assign)BOOL isRegisterShow;

得了，這程式碼只有你能懂了：

@interface LoginModel ()
@property (nonatomic, strong)NSString *tcpURL;
@property (nonatomic, strong)UserInfo *offlineCallUser;
@property (nonatomic, assign)VersionStatus versionStatus;
@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 即可。

此時的程式碼便已經不再是一件藝術品，而只是一個平凡普通、毫無生機的花瓶了。

小結：

原本還是挺歡快的吐槽，突然就不想寫了。

看著以前的人寫的程式碼，不禁有些淒涼。

在專案裡用盡了各種低階下流的手段，只為了實現自己的業務。

這是對藝術的侮辱。

本文作者：Wang Hyde
程式碼倉庫：
https://gitcafe.com/callmewhy
部落格地址：
http://callmewhy.gitcafe.io

原文地址：http://callmewhy.gitcafe.io/2015/01/20/wtf-in-old-code/

【發現趣味】要你命三千——老程式碼中的那些坑

第一回：變數命名沒點數，有時寫著還手誤

第二回：介面全靠神奇數，保準看到就發怵

第三回：私有公有混一處，代理委託亦糊塗

第四回：訊息通知滿天飛，委託方法一大堆

第五回：第三方庫無出處，隨手改動無備註

第六回：單個物件多職責，悲傷逆向流成河

第七回：產品突增新功能，一行程式碼變大神

第八回：來了任務有委託，多寫一行都嫌多

小結：

相關文章