iOS開發總結之代碼規范
本文是投稿文章，作者：RylanJIN
最近被安排fix項目的隨機crash問題, 大大小小修復了差不多10個issue, 總結一下發現這些問題或多或少都是由代碼習慣和編程規范引起的, 可見一個好的編碼習慣是多么的重要! 趁著這兩天休假將自己所認為的一些比較好的代碼規范整理一下, 并結合之前遇到的實際case跟大家分享一下.
命名規范
總的來說, iOS命名兩大原則是:可讀性高和防止命名沖突(通過加前綴來保證). Objective-C 的命名通常都比較長, 名稱遵循駝峰式命名法. 一個好的命名標準很簡單, 就是做到在開發者一看到名字時, 就能夠懂得它的含義和使用方法. 另外, 每個模塊都要加上自己的前綴, 前綴在編程接口中非常重要, 可以區分軟件的功能范疇并防止不同文件或者類之間命名發生沖突, 比如相冊模塊(PhotoGallery)的代碼都以PG作為前綴: PGAlbumViewController, PGDataManager.
1). 常量的命名
對于常量的命名最好在前面加上字母k作為標記. 如:
static const NSTimeInterval kAnimationDuration = 0.3;
定義作為NSDictionary或者Notification等的Key值字符串時加上const關鍵字, 以防止被修改. 如:
NSString *const UIApplicationDidEnterBackgroundNotification
Tips:
I. 若常量作用域超出編譯單元(實現文件), 需要在類外可見時, 使用extern關鍵字, 并加上該類名作為前綴. 如 extern NSString *const PGThumbnailSize
II.全局常量(通知或者關鍵字等)盡量用const來定義. 因為如果使用宏定義, 一來宏可能被重定義. 二來引用不同的文件可能會導致宏的不同. P.S. 對于＃define也添加一下前綴k(強迫癥, 哈哈...)
2). 枚舉的命名
對于枚舉類型, 經常會看到之前的C的定義方式:
typedef enum : {
CameraModeFront,
CameraModeLeft,
CameraModeRight,
} CameraMode; 不知道是腫么了, 每次看到這種定義方式總是感覺怪怪的, 作為一個正宗的iOS開發者當然要以Objective-C的方式來定義啦, 哈哈... 那Objective-C是怎么定義的呢? 很簡單, 到SDK里面看看Apple是怎么做滴:
typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
UIViewAnimationTransitionNone,
UIViewAnimationTransitionFlipFromLeft,
UIViewAnimationTransitionFlipFromRight,
UIViewAnimationTransitionCurlUp,
UIViewAnimationTransitionCurlDown,
}; 這邊需要注意的是: 枚舉類型命名要加相關類名前綴并且枚舉值命名要加枚舉類型前綴.
3). 變量和對象的命名
給一個對象命名時建議采用修飾+類型的方式. 如果只用修飾命名會引起歧義, 比如title (這個到底是個NSString還是UILabel?). 同樣的, 如果只用類型來命名則會缺失作用信息, 比如label (好吧, 我知道你是個UILabel, 但是我不知道它是用來做什么的呀?). So, 正確的命名方式為:
titleLabel //表示標題的label, 是UILabel類型 confirmButton //表示確認的button, 是UIButton類型
對于BOOL類型, 應加上is前綴, 比如- (BOOL)isEqualToString:(NSString *)aString這樣會更加清晰. 如果某方法返回非屬性的 BOOL 值, 那么應根據其功能, 選用 has 或 is 當前綴, 如- (BOOL)hasPrefix:(NSString *)aString
Tip: 如果某個命名已經很明確了, 為了簡潔可以省去類型名. 比如scores, 很明顯是個array了, 就不必命名成scoreArray了
編碼規范
編碼規范簡單來說就是為了保證寫出來的代碼具備三個原則:可復用, 易維護, 可擴展. 這其實也是面向對象的基本原則. 可復用, 簡單來說就是不要寫重復的代碼, 有重復的部分要盡量封裝起來重用. 否則修改文件的時候得滿地找相同邏輯的地方...這個就用no zuo no die來描述吧, 哈哈...易維護, 就是不要把代碼復雜化, 不要去寫巨復雜邏輯的代碼, 而是把復雜的邏輯代碼拆分開一個個小的模塊, 這也是Do one thing的概念, 每個模塊(或者函數)職責要單一, 這樣的代碼會易于維護, 也不容易出錯. 可擴展則是要求寫代碼時要考慮后面的擴展需求, 這個屬于架構層面的東東, 利用對應的設計模式來保證, 后面有機會單獨寫文探討。
編碼規范直接通過示例來介紹, 畢竟對于程序員來說一個Demo勝過千行文字(有同感的小伙伴讓我看到你們的雙手, 哈哈O(∩_∩)O~~). 下面的部分示例選自richieyang博文, 寫的很好的一篇文章, 推薦大家看一下, 我自己也是受益匪淺.
1). 判斷nil或者YES/NO
Preferred:
if (someObject) { ... }
if (!someObject) { ... } Not preferred:
if (someObject == YES) { ...}
if (someObject != nil) { ...} if (someObject == YES)容易誤寫成賦值語句, 自己給自己挖坑了...而且if (someObject)寫法很簡潔, 何樂而不為呢?
2). 條件賦值
Preferred:
result = object ? : [self createObject];
Not preferred:
result = object ? object : [self createObject];
如果是存在就賦值本身, 那就可以這樣簡寫, 多簡潔啊, 哈哈...
3). 初始化方法
Preferred:
NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve"];
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018; 第一個好處還是簡潔, 第二個好處是可以防止初始化進去nil值造成crash
4). 定義屬性
Preferred:
@property (nonatomic, readwrite, copy) NSString *name;
建議定義屬性的時候把所有的參數寫全, 尤其是如果想定義成只讀的(防止外面修改)那一定要加上readonly, 這也是代碼安全性的一個習慣.
如果是內部使用的屬性, 那么就定義成私有的屬性(定義到.m的class extension里面)
對于擁有Mutable子類型的對象(e.g. NSString, NSArray, NSDictionary)一定要定義成copy屬性. Why? 示例: NSArray的array = NSMutableArray的mArray; 如果mArray在某個地方改變了, 那array也會跟著改變. So, make sense?
盡量不要暴露mutable類型的對象在public interface, 建議在.h定義一個Inmutable類型的屬性, 然后在.m的get函數里面返回一個內部定義的mutable變量. Why? For security as well!
5). BOOL賦值
Preferred:
BOOL isAdult = age > 18;
Not preferred:
BOOL isAdult;
if (age > 18)
{
isAdult = YES;
}
else
{
isAdult = NO;
} 為什么要這么寫呢, 我不告訴你, 哈哈哈...
6) 拒絕死值
Preferred:
if (car == Car.Nissan)
or
const int adultAge = 18; if (age > adultAge) { ... } Not preferred:
if (carName == "Nissan")
or
if (age > 18) { ... } 死值每次修改的時候容易被遺忘, 地方多了找起來就悲劇了. 而且定義成枚舉或者static可以讓錯誤發生在編譯階段. 另外僅僅看到一個數字, 完全不知道這個數字代表的意義. 納尼?
7). 復雜的條件判斷
Preferred:
if ([self canDeleteJob:job]) { ... }
- (BOOL)canDeleteJob:(Job *)job
{
BOOL invalidJobState = job.JobState == JobState.New
|| job.JobState == JobState.Submitted
|| job.JobState == JobState.Expired;
BOOL invalidJob = job.JobTitle && job.JobTitle.length;
return invalidJobState || invalidJob;
} Not preferred:
if (job.JobState == JobState.New
|| job.JobState == JobState.Submitted
|| job.JobState == JobState.Expired
|| (job.JobTitle && job.JobTitle.length))
{
//....
} 清晰明了, 每個函數DO ONE THING!
8). 嵌套判斷
Preferred:
if (!user.UserName) return NO; if (!user.Password) return NO; if (!user.Email) return NO;return YES;</pre>
Not preferred:
BOOL isValid = NO; if (user.UserName) {if (user.Password) { if (user.Email) isValid = YES; } } return isValid;</pre>
一旦發現某個條件不符合, 立即返回, 條理更清晰
9). 參數過多
Preferred:
- (void)registerUser(User *user) {// to do... }</pre>
Not preferred:
- (void)registerUserName:(NSString *)userName password:(NSString *)password email:(NSString *)email { // to do... }當發現實現某一功能需要傳遞的參數太多時, 就預示著你應該聚合成一個model類了...這樣代碼更整潔, 也不容易因為參數太多導致出錯。
10). 回調方法
Preferred:
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath;函數調用的可知性, 回調時被調用者要知道其調用者, 方便信息的傳遞, 所以建議在回調方法中第一個參數中加上調用者。
Well, 不知不覺已經整理了10個了, 額, 太多了, 不知道童鞋們還有木有耐心看了, 好吧, 這一段就到此為止吧, 下面寫一下block的編碼規范, 各位看官, 預知后事如何, 且繼續look look, 哈哈...
Block的循環引用問題
Block確實是個好東西, 但是用起來一定要注意循環引用的問題, 否則一不小心你就會發現, Oh My God, 我的dealloc腫木不走了...
__weak typeof(self) weakSelf = self; dispatch_block_t block = ^{ [weakSelf doSomething]; // weakSelf != nil // preemption, weakSelf turned nil [weakSelf doSomethingElse]; // weakSelf == nil };如此在上面定義一個weakSelf, 然后在block體里面使用該weakSelf就可以避免循環引用的問題. 那么問題來了...是不是這樣就完全木有問題了? 很不幸, 答案是NO, 還是有問題。問題是block體里面的self是weak的, 所以就有可能在某一個時段self已經被釋放了, 這時block體里面再使用self那就是nil, 然后...然后就悲劇了...那么腫么辦呢?
__weak typeof(self) weakSelf = self; myObj.myBlock = ^{ __strong typeof(self) strongSelf = weakSelf; if (strongSelf) { [strongSelf doSomething]; // strongSelf != nil // preemption, strongSelf still not nil [strongSelf doSomethingElse]; // strongSelf != nil } else { // Probably nothing... return; } };解決方法很簡單, 就是在block體內define一個strong的self, 然后執行的時候判斷下self是否還在, 如果在就繼續執行下面的操作, 否則return或拋出異常.
什么情況下會出現block里面self循環引用的問題? 這個問題問的好, 哈哈...簡單來說就是雙邊引用, 如果block是self類的property (此時self已經retain了block), 然后在block內又引用了self, 這個情況下就肯定會循環引用了...
P.S. RAC里面有定義好的@weakify(self)和@strongify(self), 用起來灰常灰常的方便, 勸君嘗試一下^_^
那些年遇到的Crash
-
多線程同步問題造成的Crash
</li> </ul>這個其實還蠻常見的, 尤其是在多線程泛濫使用的今天...你可以使用多線程, 但你要知道保護它呀, 哈哈. 對于數據源或model類一定要注意多線程同時訪問的情況, 我個人比較喜歡用GCD的串行隊列來同步線程.
-
Observer的移除
</li> </ul>現在的代碼里面很多需要用到Observer, 根據被觀察對象的狀態來相應的Update UI或者執行某個操作. 注冊observer很簡單, 但是移除的時候就出問題了, 要么是忘記移除observer了, 要么是移除的時機不對. 如果某個被觀察對象已經被釋放了, observer還在, 那結果只能是crash了, 所以切記至少在dealloc里面移除一下observer...
-
NSArray, NSDictionary成員的判空保護
</li> </ul>在addObject或insertObject到NSArray或者NSDictionary時最好加一下判空保護, 尤其是網絡相關的邏輯, 如果網絡返回為空(jason解析出來為空), 但你還是毅然決然的add到array里面, 那么...
最后一點就是commit代碼之前一定要保證木有warning, 木有內存泄露, 確保都OK之后再上傳代碼. 其實很簡單, 上傳代碼之前Command + Shift + B靜態分析一下, 看看有木有什么issue...就先寫這么多吧, 以后遇到更多的坑后, 我一定會爬出來再過來補充的, to be continued...
References:
http://www.cnblogs.com/richieyang/p/4840614.html
-
-