iOS編碼規(guī)范
GitHub 地址https://github.com/CodeOuyang/iOS-note.git
目錄
命名
基本原則:清晰
盡可能遵守 Apple 的命名約定，命名應(yīng)該盡可能的清晰和簡潔蛔翅，但在Objective-C中，清晰比簡潔更重要笋轨。
- 類名采用大駝峰（UpperCamelCase）
- 類成員翩腐、方法小駝峰（lowerCamelCase）
- 局部變量小駝峰
- C函數(shù)的命名用大駝峰
- 本工程統(tǒng)一用VK前綴
推薦：
insertObject:atIndex:
removeObjectAtIndex:
反對(duì)：
//insert的對(duì)象類型和at的位置屬性沒有說明
insert:at:
//remove的對(duì)象類型沒有說明何什，參數(shù)的作用沒有說明
remove:
不要使用單詞的簡寫伶贰，拼寫出完整的單詞：
推薦：
ID, URL, JSON, WWW
destinationSelection
setBackgroundColor:
反對(duì)：
id, Url, json, www
//不要使用簡寫
destSel
setBkgdColor:
一致性
整個(gè)工程的命名風(fēng)格要保持一致性泥畅，最好和蘋果SDK的代碼保持統(tǒng)一。不同類中完成相似功能的方法應(yīng)該叫一樣的名字聂抢，比如我們總是用count來返回集合的個(gè)數(shù)琳疏，不能在A類中使用count而在B類中使用getNumber。
使用前綴
如果代碼需要打包成Framework給別的工程使用我注，或者工程項(xiàng)目非常龐大，需要拆分成不同的模塊奔缠，使用命名前綴是非常有用的。
- 前綴由大寫的字母縮寫組成闷哆，比如Cocoa中NS前綴代表Founation框架中的類，IB則代表Interface Builder框架嘀倒。
- 可以在為類、協(xié)議康二、函數(shù)沫勿、常量以及typedef宏命名的時(shí)候使用前綴，但注意不要為成員變量或者方法使用前綴洽故，因?yàn)樗麄儽旧砭桶陬惖拿臻g內(nèi)。
- 命名前綴的時(shí)候不要和蘋果SDK框架沖突荒适。
命名類和協(xié)議
類名以大寫字母VK開頭刀诬，應(yīng)該包含一個(gè)名詞來表示它代表的對(duì)象類型，同時(shí)可以加上必要的前綴糠馆，比如NSString, NSDate, NSScanner, NSApplication等等又碌。
而協(xié)議名稱應(yīng)該清晰地表示它所執(zhí)行的行為，而且要和類名區(qū)別開來皂岔，所以通常使用ing詞尾來命名一個(gè)協(xié)議姓建，比如NSCopying,NSLocking。
命名頭文件
源碼的頭文件名應(yīng)該清晰地暗示它的功能和包含的內(nèi)容：
- 如果頭文件內(nèi)只定義了單個(gè)類或者協(xié)議活玲，直接用類名或者協(xié)議名來命名頭文件，比如NSLocale.h定義了NSLocale類镀迂。
- 如果頭文件內(nèi)定義了一系列的類、協(xié)議妓柜、類別藏雏，使用其中最主要的類名來命名頭文件，比如NSString.h定義了NSString和NSMutableString杯巨。
- 每一個(gè)Framework都應(yīng)該有一個(gè)和框架同名的頭文件服爷，包含了框架中所有公共類頭文件的引用，比如Foundation.h
- Framework中有時(shí)候會(huì)實(shí)現(xiàn)在別的框架中類的類別擴(kuò)展舔涎，這樣的文件通常使用被擴(kuò)展的框架名+Additions的方式來命名掘而，比如NSBundleAdditions.h袍睡。
命名方法
Objective-C的方法名通常都比較長，這是為了讓程序有更好地可讀性止潘，按蘋果的說法“好的方法名應(yīng)當(dāng)可以以一個(gè)句子的形式朗讀出來”。
方法一般以小寫字母打頭么夫，每一個(gè)后續(xù)的單詞首字母大寫，方法名中不應(yīng)該有標(biāo)點(diǎn)符號(hào)（包括下劃線）钞它，有兩個(gè)例外：
- 可以用一些通用的大寫字母縮寫打頭方法，比如
PDF,TIFF等锯仪。 - 可以用帶下劃線的前綴來命名私有方法或者類別中的方法。
如果方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作久窟，使用動(dòng)詞打頭來命名，注意不要使用do稀颁，does這種多余的關(guān)鍵字棱烂，動(dòng)詞本身的暗示就足夠了：
//動(dòng)詞打頭的方法表示讓對(duì)象執(zhí)行一個(gè)動(dòng)作
- (void)invokeWithTarget:(id)target;
- (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;
如果方法是為了獲取對(duì)象的一個(gè)屬性值张肾，直接用屬性名稱來命名這個(gè)方法吞瞪，注意不要添加get或者其他的動(dòng)詞前綴：
統(tǒng)一類中的方法名
UIViewController<VKViewControllerProtocol>
@protocol VKViewControllerProtocol <NSObject>
@optional
- (void)setUp;
- (void)addSubviews;
- (void)layoutNavigation;
- (void)requestData;
@end
UITableViewCell<VKViewConfigProtocol>
@protocol VKViewConfigProtocol <NSObject>
@optional
- (void)configWithModel:(id)model;
@end
推薦：
//使用屬性名來命名方法
- (NSSize)cellSize;
反對(duì)：
//添加了多余的動(dòng)詞前綴
- (NSSize)calcCellSize;
- (NSSize)getCellSize;
對(duì)于有多個(gè)參數(shù)的方法翠勉，務(wù)必在每一個(gè)參數(shù)前都添加關(guān)鍵詞荆虱，關(guān)鍵詞應(yīng)當(dāng)清晰說明參數(shù)的作用：
推薦：
//保證每個(gè)參數(shù)都有關(guān)鍵詞修飾
- (void)sendAction:(SEL)aSelector toObject:(id)anObject forAllCells:(BOOL)flag;
反對(duì)：
//錯(cuò)誤，遺漏關(guān)鍵詞
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;
推薦：
- (id)viewWithTag:(NSInteger)aTag;
反對(duì)：
//關(guān)鍵詞的作用不清晰
- (id)taggedView:(int)aTag;
不要用and來連接兩個(gè)參數(shù)朽们，通常and用來表示方法執(zhí)行了兩個(gè)相對(duì)獨(dú)立的操作（從設(shè)計(jì)上來說怀读，這時(shí)候應(yīng)該拆分成兩個(gè)獨(dú)立的方法）：
推薦：
//使用"and"來表示兩個(gè)相對(duì)獨(dú)立的操作
- (BOOL)openFile:(NSString *)fullPath withApplication:(NSString *)appName andDeactivate:(BOOL)flag;
反對(duì)：
//不要使用"and"來連接參數(shù)
- (int)runModalForDirectory:(NSString *)path andFile:(NSString *)name andTypes:(NSArray *)fileTypes;
方法的參數(shù)命名也有一些需要注意的地方:
- 和方法名類似，參數(shù)的第一個(gè)字母小寫骑脱，后面的每一個(gè)單詞首字母大寫
- 不要再方法名中使用類似
pointer,ptr這樣的字眼去表示指針菜枷，參數(shù)本身的類型足以說明 - 不要使用只有一兩個(gè)字母的參數(shù)名
- 不要使用簡寫叁丧，拼出完整的單詞
下面列舉了一些常用參數(shù)名：
...action:(SEL)aSelector
...alignment:(int)mode
...atIndex:(int)index
...content:(NSRect)aRect
...doubleValue:(double)aDouble
...floatValue:(float)aFloat
...font:(NSFont *)fontObj
...frame:(NSRect)frameRect
...intValue:(int)anInt
...keyEquivalent:(NSString *)charCode
...length:(int)numBytes
...point:(NSPoint)aPoint
...stringValue:(NSString *)aString
...tag:(int)anInt
...target:(id)anObject
...title:(NSString *)aString
命名存取方法
存取方法是指用來獲取和設(shè)置類屬性值的方法枫耳，屬性的不同類型捷沸，對(duì)應(yīng)著不同的存取方法規(guī)范：
//屬性是一個(gè)名詞時(shí)的存取方法范式
- (type)noun;
- (void)setNoun:(type)aNoun;
//例子
- (NSString *)title;
- (void)setTitle:(NSString *)aTitle;
//屬性是一個(gè)形容詞時(shí)存取方法的范式
- (BOOL)isAdjective;
- (void)setAdjective:(BOOL)flag;
//例子
- (BOOL)isEditable;
- (void)setEditable:(BOOL)flag;
//屬性是一個(gè)動(dòng)詞時(shí)存取方法的范式
- (BOOL)verbObject;
- (void)setVerbObject:(BOOL)flag;
//例子
- (BOOL)showsAlpha;
- (void)setShowsAlpha:(BOOL)flag;
命名存取方法時(shí)不要將動(dòng)詞轉(zhuǎn)化為被動(dòng)形式來使用：
推薦：
- (void)setAcceptsGlyphInfo:(BOOL)flag;
- (BOOL)acceptsGlyphInfo;
反對(duì)：
//不要使用動(dòng)詞的被動(dòng)形式
- (void)setGlyphInfoAccepted:(BOOL)flag;
- (BOOL)glyphInfoAccepted;
可以使用can,should,will等詞來協(xié)助表達(dá)存取方法的意思姜贡，但不要使用do,和does：
推薦：
- (void)setCanHide:(BOOL)flag;
- (BOOL)canHide;
- (void)setShouldCloseDocument:(BOOL)flag;
- (BOOL)shouldCloseDocument;
反對(duì)：
//不要使用"do"或者"does"
- (void)setDoesAcceptGlyphInfo:(BOOL)flag;
- (BOOL)doesAcceptGlyphInfo;
為什么Objective-C中不適用get前綴來表示屬性獲取方法余耽？因?yàn)?code>get在Objective-C中通常只用來表示從函數(shù)指針返回值的函數(shù)：
//三個(gè)參數(shù)都是作為函數(shù)的返回值來使用的，這樣的函數(shù)名可以使用"get"前綴
- (void)getLineDash:(float *)pattern count:(int *)count phase:(float *)phase;
命名委托
當(dāng)特定的事件發(fā)生時(shí)铐然，對(duì)象會(huì)觸發(fā)它注冊(cè)的委托方法桐罕。委托是Objective-C中常用的傳遞消息的方式滚澜。委托有它固定的命名范式。
一個(gè)委托方法的第一個(gè)參數(shù)是觸發(fā)它的對(duì)象橡淆，第一個(gè)關(guān)鍵詞是觸發(fā)對(duì)象的類名构韵，除非委托方法只有一個(gè)名為sender的參數(shù)：
//第一個(gè)關(guān)鍵詞為觸發(fā)委托的類名
- (BOOL)tableView:(NSTableView *)tableView shouldSelectRow:(int)row;
- (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;
//當(dāng)只有一個(gè)"sender"參數(shù)時(shí)可以省略類名
- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;
根據(jù)委托方法觸發(fā)的時(shí)機(jī)和目的杂数，使用should,will,did等關(guān)鍵詞
- (void)browserDidScroll:(NSBrowser *)sender;
- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、
- (BOOL)windowShouldClose:(id)sender;
集合操作類方法
有些對(duì)象管理著一系列其它對(duì)象或者元素的集合，需要使用類似“增刪查改”的方法來對(duì)集合進(jìn)行操作碍遍，這些方法的命名范式一般為：
//集合操作范式
- (void)addElement:(elementType)anObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;
//例子
- (void)addLayoutManager:(NSLayoutManager *)obj;
- (void)removeLayoutManager:(NSLayoutManager *)obj;
- (NSArray *)layoutManagers;
注意鹰溜，如果返回的集合是無序的，使用NSSet來代替NSArray兔港。如果需要將元素插入到特定的位置兑徘，使用類似于這樣的命名：
- (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
- (void)removeLayoutManagerAtIndex:(int)index;
如果管理的集合元素中有指向管理對(duì)象的指針橄仍，要設(shè)置成weak類型以防止引用循環(huán)锁孟。
下面是SDK中NSWindow類的集合操作方法：
- (void)addChildWindow:(NSWindow *)childWin ordered:(NSWindowOrderingMode)place;
- (void)removeChildWindow:(NSWindow *)childWin;
- (NSArray *)childWindows;
- (NSWindow *)parentWindow;
- (void)setParentWindow:(NSWindow *)window;
命名屬性和實(shí)例變量
屬性和對(duì)象的存取方法相關(guān)聯(lián)，屬性的第一個(gè)字母小寫炕淮，后續(xù)單詞首字母大寫，不必添加前綴褐鸥。屬性按功能命名成名詞或者動(dòng)詞：
//名詞屬性
@property (strong) NSString *title;
//動(dòng)詞屬性
@property (assign) BOOL showsAlpha;
屬性也可以命名成形容詞，這時(shí)候通常會(huì)指定一個(gè)帶有is前綴的get方法來提高可讀性：
@property (assign, getter=isEditable) BOOL editable;
命名實(shí)例變量肖卧，在變量名前加上_前綴（有些有歷史的代碼會(huì)將_放在后面），其它和命名屬性一樣：
@implementation MyClass {
BOOL _showsTitle;
}
一般來說，類需要對(duì)使用者隱藏?cái)?shù)據(jù)存儲(chǔ)的細(xì)節(jié)熟史，所以不要將實(shí)例方法定義成公共可訪問的接口，可以使用@private翁脆，@protected前綴。
命名常量
如果要定義一組相關(guān)的常量兔甘，盡量使用枚舉類型（enumerations）疑苔，枚舉類型的命名規(guī)則和函數(shù)的命名規(guī)則相同扯夭。
建議使用 NS_ENUM 和 NS_OPTIONS 宏來定義枚舉類型，參見官方的 Adopting Modern Objective-C 一文：
//定義一個(gè)枚舉
typedef NS_ENUM(NSInteger, NSMatrixMode) {
NSRadioModeMatrix,
NSHighlightModeMatrix,
NSListModeMatrix,
NSTrackModeMatrix
};
定義bit map：
typedef NS_OPTIONS(NSUInteger, NSWindowMask) {
NSBorderlessWindowMask = 0,
NSTitledWindowMask = 1 << 0,
NSClosableWindowMask = 1 << 1,
NSMiniaturizableWindowMask = 1 << 2,
NSResizableWindowMask = 1 << 3
};
使用const定義浮點(diǎn)型或者單個(gè)的整數(shù)型常量瓮顽，如果要定義一組相關(guān)的整數(shù)常量谍倦，應(yīng)該優(yōu)先使用枚舉怕轿。常量的命名規(guī)范和函數(shù)相同：
const float NSLightGray;
不要使用#define宏來定義常量碌宴，如果是整型常量楼入，盡量使用枚舉，浮點(diǎn)型常量瞄勾，使用const定義喳资。#define通常用來給編譯器決定是否編譯某塊代碼匿乃，比如常用的：
#ifdef DEBUG
注意到一般由編譯器定義的宏會(huì)在前后都有一個(gè)__，比如__MACH__。
命名通知
通知常用于在模塊間傳遞消息，所以通知要盡可能地表示出發(fā)生的事件，通知的命名范式是：
[觸發(fā)通知的類名] + [Did | Will] + [動(dòng)作] + Notification
例子：
NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification
注釋
讀沒有注釋代碼的痛苦你我都體會(huì)過仪芒，好的注釋不僅能讓人輕松讀懂你的程序，還能提升代碼的逼格。注意注釋是為了讓別人看懂也拜，而不是僅僅你自己。
文件注釋
每一個(gè)文件都必須寫文件注釋，文件注釋通常包含
- 文件所在模塊
- 作者信息
- 歷史版本信息
- 版權(quán)信息
- 文件包含的內(nèi)容讶请，作用
一段良好文件注釋的栗子：
/*******************************************************************************
Copyright (C), 2011-2013, Andrew Min Chang
File name: AMCCommonLib.h
Author: Andrew Chang (Zhang Min)
E-mail: LaplaceZhang@126.com
Description:
This file provide some covenient tool in calling library tools. One can easily include
library headers he wants by declaring the corresponding macros.
I hope this file is not only a header, but also a useful Linux library note.
History:
2012-??-??: On about come date around middle of Year 2012, file created as "commonLib.h"
2012-08-20: Add shared memory library; add message queue.
2012-08-21: Add socket library (local)
2012-08-22: Add math library
2012-08-23: Add socket library (internet)
2012-08-24: Add daemon function
2012-10-10: Change file name as "AMCCommonLib.h"
2012-12-04: Add UDP support in AMC socket library
2013-01-07: Add basic data type such as "sint8_t"
2013-01-18: Add CFG_LIB_STR_NUM.
2013-01-22: Add CFG_LIB_TIMER.
2013-01-22: Remove CFG_LIB_DATA_TYPE because there is already AMCDataTypes.h
Copyright information:
This file was intended to be under GPL protocol. However, I may use this library
in my work as I am an employee. And my company may require me to keep it secret.
Therefore, this file is neither open source nor under GPL control.
********************************************************************************/
文件注釋的格式通常不作要求，能清晰易讀就可以了匣距，但在整個(gè)工程中風(fēng)格要統(tǒng)一县匠。
代碼注釋
好的代碼應(yīng)該是“自解釋”（self-documenting）的，但仍然需要詳細(xì)的注釋來說明參數(shù)的意義描馅、返回值、功能以及可能的副作用隅肥。
方法舞虱、函數(shù)镊靴、類旋讹、協(xié)議、類別的定義都需要注釋，推薦采用Apple的標(biāo)準(zhǔn)注釋風(fēng)格，好處是可以在引用的地方alt+點(diǎn)擊自動(dòng)彈出注釋夸盟，非常方便偏螺。
Xcode8注釋快捷鍵
[圖片上傳失敗...(image-5cb941-1556524583880)]
一些良好的注釋：
/**
* Create a new preconnector to replace the old one with given mac address.
* NOTICE: We DO NOT stop the old preconnector, so handle it by yourself.
*
* @param type Connect type the preconnector use.
* @param macAddress Preconnector's mac address.
*/
- (void)refreshConnectorWithConnectType:(IPCConnectType)type Mac:(NSString *)macAddress;
/**
* Stop current preconnecting when application is going to background.
*/
-(void)stopRunning;
/**
* Get the COPY of cloud device with a given mac address.
*
* @param macAddress Mac address of the device.
*
* @return Instance of IPCCloudDevice.
*/
-(IPCCloudDevice *)getCloudDeviceWithMac:(NSString *)macAddress;
// A delegate for NSApplication to handle notifications about app
// launch and shutdown. Owned by the main app controller.
@interface MyAppDelegate : NSObject {
...
}
@end
協(xié)議行疏、委托的注釋要明確說明其被觸發(fā)的條件：
/** Delegate - Sent when failed to init connection, like p2p failed. */
-(void)initConnectionDidFailed:(IPCConnectHandler *)handler;
如果在注釋中要引用參數(shù)名或者方法函數(shù)名，使用||將參數(shù)或者方法括起來以避免歧義：
// Sometimes we need |count| to be less than zero.
// Remember to call |StringWithoutSpaces("foo bar baz")|
定義在頭文件里的接口方法套像、屬性必須要有注釋酿联！
空格
類方法聲明在方法類型與返回類型之間要有空格。
推薦：
- (void)methodName:(NSString *)string;
反對(duì)：
-(void)methodName:(NSString *)string;
條件判斷的括號(hào)內(nèi)側(cè)不應(yīng)有空格夺巩。
推薦：
if (a < b) {
// something
}
反對(duì)：
if ( a < b ) {
// something
}
關(guān)系運(yùn)算符（如 >=贞让、!=）和邏輯運(yùn)算符（如 &&、||）兩邊要有空格柳譬。
推薦：
(someValue > 100)? YES : NO
(items)?: @[]
二元算數(shù)運(yùn)算符兩側(cè)加空格喳张，根據(jù)情況自己定。一元運(yùn)算符與操作數(shù)之前沒有空格美澳。
函數(shù)的書寫
一個(gè)典型的Objective-C函數(shù)應(yīng)該是這樣的：
- (void)writeVideoFrameWithData:(NSData *)frameData timeStamp:(int)timeStamp {
...
}
在-和(void)之間應(yīng)該有一個(gè)空格销部，第一個(gè)大括號(hào){的位置在函數(shù)所在行的末尾，同樣應(yīng)該有一個(gè)空格人柿。（我司的C語言規(guī)范要求是第一個(gè)大括號(hào)單獨(dú)占一行柴墩，但考慮到OC較長的函數(shù)名和蘋果SDK代碼的風(fēng)格，還是將大括號(hào)放在行末凫岖。）
如果一個(gè)函數(shù)有特別多的參數(shù)或者名稱很長江咳，應(yīng)該將其按照:來對(duì)齊分行顯示：
-(id)initWithModel:(IPCModle)model
ConnectType:(IPCConnectType)connectType
Resolution:(IPCResolution)resolution
AuthName:(NSString *)authName
Password:(NSString *)password
MAC:(NSString *)mac
AzIp:(NSString *)az_ip
AzDns:(NSString *)az_dns
Token:(NSString *)token
Email:(NSString *)email
Delegate:(id<IPCConnectHandlerDelegate>)delegate;
在分行時(shí)，如果第一段名稱過短哥放，后續(xù)名稱可以以Tab的長度（4個(gè)空格）為單位進(jìn)行縮進(jìn)：
- (void)short:(GTMFoo *)theFoo
longKeyword:(NSRect)theRect
evenLongerKeyword:(float)theInterval
error:(NSError **)theError {
...
}
函數(shù)調(diào)用
函數(shù)調(diào)用的格式和書寫差不多歼指，可以按照函數(shù)的長短來選擇寫在一行或者分成多行：
推薦：
//寫在一行
[myObject doFooWith:arg1 name:arg2 error:arg3];
//分行寫爹土，按照':'對(duì)齊
[myObject doFooWith:arg1
name:arg2
error:arg3];
//第一段名稱過短的話后續(xù)可以進(jìn)行縮進(jìn)
[myObj short:arg1
longKeyword:arg2
evenLongerKeyword:arg3
error:arg4];
反對(duì)：
//錯(cuò)誤，要么寫在一行踩身，要么全部分行
[myObject doFooWith:arg1 name:arg2
error:arg3];
[myObject doFooWith:arg1
name:arg2 error:arg3];
//錯(cuò)誤胀茵，按照':'來對(duì)齊，而不是關(guān)鍵字
[myObject doFooWith:arg1
name:arg2
error:arg3];
@public和@private標(biāo)記符
@public和@private標(biāo)記符應(yīng)該以一個(gè)空格來進(jìn)行縮進(jìn)：
@interface MyClass : NSObject {
@public
...
@private
...
}
@end
協(xié)議（Protocols）
在書寫協(xié)議的時(shí)候注意用<>括起來的協(xié)議和類型名之間是沒有空格的挟阻，比如IPCConnectHandler()<IPCPreconnectorDelegate>,這個(gè)規(guī)則適用所有書寫協(xié)議的地方琼娘，包括函數(shù)聲明、類聲明附鸽、實(shí)例變量等等：
@interface MyProtocoledClass : NSObject<NSWindowDelegate> {
@private
id<MyFancyDelegate> _delegate;
}
- (void)setDelegate:(id<MyFancyDelegate>)aDelegate;
@end
閉包（Blocks）
根據(jù)block的長度脱拼，有不同的書寫規(guī)則：
- 較短的block可以寫在一行內(nèi)。
- 如果分行顯示的話坷备，block的右括號(hào)
}應(yīng)該和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊熄浓。 - block內(nèi)的代碼采用4個(gè)空格的縮進(jìn)。
- 如果block過于龐大省撑，應(yīng)該單獨(dú)聲明成一個(gè)變量來使用赌蔑。
-
^和(之間，^和{之間都沒有空格竟秫，參數(shù)列表的右括號(hào))和{之間有一個(gè)空格娃惯。
//較短的block寫在一行內(nèi)
[operation setCompletionBlock:^{ [self onOperationDone]; }];
//分行書寫的block，內(nèi)部使用4空格縮進(jìn)
[operation setCompletionBlock:^{
[self.delegate newDataAvailable];
}];
//使用C語言API調(diào)用的block遵循同樣的書寫規(guī)則
dispatch_async(_fileIOQueue, ^{
NSString* path = [self sessionFilePath];
if (path) {
// ...
}
});
//較長的block關(guān)鍵字可以縮進(jìn)后在新行書寫肥败，注意block的右括號(hào)'}'和調(diào)用block那行代碼的第一個(gè)非空字符對(duì)齊
[[SessionService sharedService]
loadWindowWithCompletionBlock:^(SessionWindow *window) {
if (window) {
[self windowDidLoad:window];
} else {
[self errorLoadingWindow];
}
}];
//較長的block參數(shù)列表同樣可以縮進(jìn)后在新行書寫
[[SessionService sharedService]
loadWindowWithCompletionBlock:
^(SessionWindow *window) {
if (window) {
[self windowDidLoad:window];
} else {
[self errorLoadingWindow];
}
}];
//龐大的block應(yīng)該單獨(dú)定義成變量使用
void (^largeBlock)(void) = ^{
// ...
};
[_operationQueue addOperationWithBlock:largeBlock];
//在一個(gè)調(diào)用中使用多個(gè)block石景，注意到他們不是像函數(shù)那樣通過':'對(duì)齊的，而是同時(shí)進(jìn)行了4個(gè)空格的縮進(jìn)
[myObject doSomethingWith:arg1
firstBlock:^(Foo *a) {
// ...
}
secondBlock:^(Bar *b) {
// ...
}];
字面量語法糖
應(yīng)該使用可讀性更好的語法糖來構(gòu)造NSArray拙吉，NSDictionary等數(shù)據(jù)結(jié)構(gòu)，避免使用冗長的alloc,init方法揪荣。
推薦：
//在語法糖的"[]"或者"{}"兩端不留有空格
NSArray *array = @[[foo description], @"Another String", [bar description]];
NSDictionary *dict = @{NSForegroundColorAttributeName : [NSColor redColor]};
反對(duì)：
NSArray* array = @[ [foo description], [bar description] ];
NSDictionary* dict = @{ NSForegroundColorAttributeName: [NSColor redColor] };
如果構(gòu)造代碼不寫在一行內(nèi)筷黔，構(gòu)造元素需要使用兩個(gè)空格來進(jìn)行縮進(jìn)，右括號(hào)]或者}寫在新的一行仗颈，并且與調(diào)用語法糖那行代碼的第一個(gè)非空字符對(duì)齊：
NSArray *array = @[
@"This",
@"is",
@"an",
@"array"
];
NSDictionary *dictionary = @{
NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
NSForegroundColorAttributeName : fontColor
};
構(gòu)造字典時(shí)佛舱，字典的Key和Value與中間的冒號(hào):都要留有一個(gè)空格，多行書寫時(shí)挨决，也可以將Value對(duì)齊：
推薦：
//冒號(hào)':'前后留有一個(gè)空格
NSDictionary *option1 = @{
NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
NSForegroundColorAttributeName : fontColor
};
//按照Value來對(duì)齊
NSDictionary *option2 = @{
NSFontAttributeName : [NSFont fontWithName:@"Arial" size:12],
NSForegroundColorAttributeName : fontColor
};
反對(duì)：
//冒號(hào)前應(yīng)該有一個(gè)空格
NSDictionary *wrong = @{
AKey: @"b",
BLongerKey: @"c",
};
//每一個(gè)元素要么單獨(dú)成為一行请祖，要么全部寫在一行內(nèi)
NSDictionary *alsoWrong= @{ AKey : @"a",
BLongerKey : @"b" };
//在冒號(hào)前只能有一個(gè)空格，冒號(hào)后才可以考慮按照Value對(duì)齊
NSDictionary *stillWrong = @{
AKey : @"b",
BLongerKey : @"c",
};
代碼組織
- 函數(shù)長度（行數(shù)）不應(yīng)超過2/3屏幕脖祈。
- 單個(gè)文件方法數(shù)不應(yīng)超過30個(gè)
- 禁止出現(xiàn)超過兩層循環(huán)的代碼肆捕，用函數(shù)或block替代。
推薦：
- (Task *)creatTaskWithPath:(NSString *)path {
if (![path isURL]) {
return nil;
}
if (![fileManager isWritableFileAtPath:path]) {
return nil;
}
if ([taskManager hasTaskWithPath:path]) {
return nil;
}
Task *aTask = [[Task alloc] initWithPath:path];
return aTask;
}
- (Task *)creatTaskWithPath:(NSString *)path {
BOOL flag = [path isURL];
BOOL flag1 = [fileManager isWritableFileAtPath:path];
BOOL flag2 = [taskManager hasTaskWithPath:path];
Task * (^resultHandle)(void) = ^{
return [[Task alloc] initWithPath:path];
};
NSDictionary *result = @{
@(YES): resultHandle
};
return result[@(flag && flag1 && !flag2)];
}
反對(duì):
// 為了簡化示例盖高，沒有錯(cuò)誤處理慎陵，并使用了偽代碼
- (Task *)creatTaskWithPath:(NSString *)path {
Task *aTask;
if ([path isURL]) {
if ([fileManager isWritableFileAtPath:path]) {
if (![taskManager hasTaskWithPath:path]) {
aTask = [[Task alloc] initWithPath:path];
}
else {
return nil;
}
}
else {
return nil;
}
}
else {
return nil;
}
return aTask;
}
編碼風(fēng)格
每個(gè)人都有自己的編碼風(fēng)格眼虱，我這里總結(jié)了一些比較好的Cocoa編程風(fēng)格和注意點(diǎn)。
Public_API要盡量簡潔
共有接口要設(shè)計(jì)的簡潔席纽，滿足核心的功能需求就可以了捏悬。不要設(shè)計(jì)很少會(huì)被用到，但是參數(shù)極其復(fù)雜的API润梯。如果要定義復(fù)雜的方法过牙，使用類別或者類擴(kuò)展。
#import和#include
#import是Cocoa中常用的引用頭文件的方式纺铭，它能自動(dòng)防止重復(fù)引用文件寇钉，什么時(shí)候使用#import，什么時(shí)候使用#include呢彤蔽？
- 當(dāng)引用的是一個(gè)Objective-C或者Objective-C++的頭文件時(shí)摧莽，使用
#import - 當(dāng)引用的是一個(gè)C或者C++的頭文件時(shí)，使用
#include顿痪，這時(shí)必須要保證被引用的文件提供了保護(hù)域（#define guard）镊辕。
為什么不全部使用#import呢？主要是為了保證代碼在不同平臺(tái)間共享時(shí)不出現(xiàn)問題蚁袭。
引用框架的根頭文件
上面提到過征懈，每一個(gè)框架都會(huì)有一個(gè)和框架同名的頭文件，它包含了框架內(nèi)接口的所有引用揩悄，在使用框架的時(shí)候卖哎，應(yīng)該直接引用這個(gè)根頭文件，而不是其它子模塊的頭文件删性，即使是你只用到了其中的一小部分亏娜，編譯器會(huì)自動(dòng)完成優(yōu)化的。
推薦：
//引用根頭文件
#import <Foundation/Foundation.h>
反對(duì)：
//不要單獨(dú)引用框架內(nèi)的其它頭文件
#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>
init和dealloc
推薦的代碼組織方式是將 dealloc 方法放在實(shí)現(xiàn)文件的最前面（直接在 @synthesize 以及 @dynamic 之后）蹬挺，init 應(yīng)該跟在 dealloc 方法后面维贺。
當(dāng)init``dealloc方法被執(zhí)行時(shí)，類的運(yùn)行時(shí)環(huán)境不是處于正常狀態(tài)的巴帮，使用存取方法訪問變量可能會(huì)導(dǎo)致不可預(yù)料的結(jié)果溯泣，因此應(yīng)當(dāng)在這兩個(gè)方法內(nèi)直接訪問實(shí)例變量。
推薦：
//直接訪問實(shí)例變量
- (instancetype)init {
self = [super init];
if (self) {
_bar = [[NSMutableString alloc] init];
}
return self;
}
- (void)dealloc {
[_bar release];
[super dealloc];
}
反對(duì)：
//不要通過存取方法訪問
- (instancetype)init {
self = [super init];
if (self) {
self.bar = [NSMutableString string];
}
return self;
}
- (void)dealloc {
self.bar = nil;
[super dealloc];
}
按照順序釋放資源
在類或者Controller的生命周期結(jié)束時(shí)榕茧，往往需要做一些掃尾工作垃沦，比如釋放資源，停止線程等用押，這些掃尾工作的釋放順序應(yīng)當(dāng)與它們的初始化或者定義的順序保持一致肢簿。這樣做是為了方便調(diào)試時(shí)尋找錯(cuò)誤，也能防止遺漏。
保證NSObject在賦值時(shí)被復(fù)制
在傳遞或者賦值時(shí)應(yīng)當(dāng)保證是以復(fù)制（copy）的方式進(jìn)行的译仗，這樣可以防止在不知情的情況下String的值被其它對(duì)象修改抬虽。
- (void)setFoo:(NSString *)aFoo {
_foo = [aFoo copy];
}
相等檢查
變量和常量做相等比較，變量在后纵菌，常量在前阐污，防止誤寫== 為 =。
推薦：
if (5 == count) {
...
}
反對(duì)：
if (count == 5) {
...
}
Delegate要使用弱引用
一個(gè)類的Delegate對(duì)象通常還引用著類本身咱圆，這樣很容易造成引用循環(huán)的問題笛辟，所以類的Delegate屬性要設(shè)置為弱引用。
/** delegate */
@property (nonatomic, weak) id <IPCConnectHandlerDelegate> delegate;
單例
如果可能序苏，請(qǐng)盡量避免使用單例而是依賴注入手幢。 然而，如果一定要用忱详，請(qǐng)使用一個(gè)線程安全的模式來創(chuàng)建共享的實(shí)例围来。對(duì)于 GCD，用 dispatch_once() 函數(shù)就可以咯匈睁。
+ (instancetype)sharedInstance
{
static id sharedInstance = nil;
static dispatch_once_t onceToken = 0;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
KVO
KVO觸發(fā)機(jī)制:一個(gè)對(duì)象(觀察者),檢測(cè)另一個(gè)對(duì)象(被觀察者)的某屬性是否發(fā)生變化,若被監(jiān)測(cè)的屬性發(fā)生了更改,會(huì)觸發(fā)觀察者的一個(gè)方法(方法名固定,類似代理方法)
- 注冊(cè)觀察者(為被觀察這指定觀察者以及被觀察者屬性)
- 實(shí)現(xiàn)回調(diào)方法
- 觸發(fā)回調(diào)方法
- 移除觀察者
一般KVO奔潰的原因:
- 被觀察的對(duì)象銷毀掉了(被觀察的對(duì)象是一個(gè)局部變量)
- 觀察者被釋放掉了,但是沒有移除監(jiān)聽(如模態(tài)推出,push,pop等)
- 注冊(cè)的監(jiān)聽沒有移除掉,又重新注冊(cè)了一遍監(jiān)聽
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary<NSKeyValueChangeKey,id> *)change context:(void *)context {
NSString *str = (__bridge NSString *)context;
if([keyPath isEqualToString:@"name"] &&
[object isEqual:self.aSon] &&
[str isEqualToString:@"xxx"]) {
} else {
[super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
}
}
Categories
雖然我們知道這樣寫很丑, 但是我們應(yīng)該要在我們的 category 方法前加上自己的小寫前綴以及下劃線监透，比如- (id)zoc_myCategoryMethod。 這種實(shí)踐同樣被蘋果推薦航唆。
這是非常必要的胀蛮。因?yàn)槿绻跀U(kuò)展的 category 或者其他 category 里面已經(jīng)使用了同樣的方法名，會(huì)導(dǎo)致不可預(yù)計(jì)的后果糯钙。實(shí)際上粪狼，實(shí)際被調(diào)用的是最后被加載的那個(gè) category 中方法的實(shí)現(xiàn)。
一個(gè)好的實(shí)踐是在 category 名中使用前綴任岸。
** 例子 **
推薦：
@interface NSDate (ZOCTimeExtensions)
- (NSString *)zoc_timeAgoShort;
@end
反對(duì)：
@interface NSDate (ZOCTimeExtensions)
- (NSString *)timeAgoShort;
@end
分類可以用來在頭文件中定義一組功能相似的方法再榄。這是在 Apple的 Framework 也很常見的一個(gè)實(shí)踐（下面例子的取自NSDate 頭文件）。我們也強(qiáng)烈建議在自己的代碼中這樣使用享潜。
我們的經(jīng)驗(yàn)是不跟，創(chuàng)建一組分類對(duì)以后的重構(gòu)十分有幫助。一個(gè)類的接口增加的時(shí)候米碰，可能意味著你的類做了太多事情，違背了類的單一功能原則购城。
之前創(chuàng)造的方法分組可以用來更好地進(jìn)行不同功能的表示吕座，并且把類打破在更多自我包含的組成部分里。
@interface NSDate : NSObject <NSCopying, NSSecureCoding>
@property (readonly) NSTimeInterval timeIntervalSinceReferenceDate;
@end
@interface NSDate (NSDateCreation)
+ (instancetype)date;
+ (instancetype)dateWithTimeIntervalSinceNow:(NSTimeInterval)secs;
+ (instancetype)dateWithTimeIntervalSinceReferenceDate:(NSTimeInterval)ti;
+ (instancetype)dateWithTimeIntervalSince1970:(NSTimeInterval)secs;
+ (instancetype)dateWithTimeInterval:(NSTimeInterval)secsToBeAdded sinceDate:(NSDate *)date;
// ...
@end
分類的命名需區(qū)分基礎(chǔ)分類和業(yè)務(wù)相關(guān)分類瘪板，業(yè)務(wù)相關(guān)分類的名字需加VK前綴吴趴，兩種分類，除名字的差別侮攀，無其他差別锣枝。
//基礎(chǔ)分類
UIViewController+Tracking.h
//業(yè)務(wù)相關(guān)分類
UIViewController+VKLargeTitle.h
基礎(chǔ)分類定義的方法不允許依賴任何業(yè)務(wù)相關(guān)的代碼和資源
Pragma Mark
#pragma mark是一個(gè)在類內(nèi)部組織代碼并且?guī)椭惴纸M方法實(shí)現(xiàn)的好辦法厢拭。 使用 #pragma mark - 來分離:
** 例子 **
#pragma mark - Lifecycle
- (void)dealloc {
}
- (void)viewDidLoad {
[super viewDidLoad];
}
- (void)viewWillAppear:(BOOL)animated {
[super viewWillAppear:animated];
}
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
}
- (void)didReceiveMemoryWarning {
[super didReceiveMemoryWarning];
}
#pragma mark - Event Response
#pragma mark - Network
#pragma mark - Delegate
#pragma mark -- TableView Delegate
- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section {
}
- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {
}
#pragma mark - Methods
#pragma mark - Navigation
- (void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender {
}
#pragma mark - Setter and Getter
路由添加
步驟
- 以添加
zze://vanke.com/user/decoration/list為例 - 找到
VKRouterMap.m,具體路徑(Modules->Base->VKRouter)- 在
getV2Map方法中有一個(gè)v2Map的字典,該字典裝著6個(gè)key.分別是user,im,common,property,community,main.每個(gè)key代表著一個(gè)大模塊.每個(gè)key對(duì)應(yīng)的value也是一個(gè)字典 - 找到
user模塊(key),在他的value(字典)中添加decoration/list為key,getDecorationListViewController為值. - <b>
getDecorationListViewController是有一定規(guī)則的.get+類名(如有VK開頭,需要把VK去掉),這個(gè)字符串其實(shí)是一個(gè)方法名稱.最終會(huì)通過VKUserAction執(zhí)行該方法</b>
- 在
+ (NSDictionary *)getV2Map {
NSMutableDictionary *v2Map = [NSMutableDictionary new];
···
···
[v2Map setValue:@{
@"moduleClassName": @"VKUserAction",
···
@"decoration/list" : @"getDecorationListViewController",
}
forKey:@"user"];
return v2Map;
}
- 查找
VKUserAction+Decoration.m,具體路徑(Modules->User->Decoration->Actions).以getDecorationListViewController為名稱建立一個(gè)返回裝修列表的VC即可
// VKUserAction+Decoration.m
...
// 裝修登記列表
- (UIViewController *)getDecorationListViewController:(NSDictionary *)parameter {
VKDecorationListViewController *ctl = [VKDecorationListViewController new];
return ctl;
}
- 查找
VKRouterCenter+User,具體路徑(Modules->Base->VKRouter->Category).
在此文件中生成一個(gè)新方法,方法的命名規(guī)則是vk_+getDecorationListViewController。具體如下
// VKRouterCenter+User
...
+ (UIViewController *)vk_getDecorationListViewController:(NSDictionary *)parameter {
return [self getViewControllerWithModule:module CMD:_cmd parameter:parameter];
}
- 完成了以上步驟就已經(jīng)添加成功了.最后
VKRouterUnitTests.m中.跑一下單元測(cè)試即可
// VKRouterUnitTests.m
...
// 裝修登記列表
- (void)testDecorationList {
testV2Router(@"zze://vanke.com/user/decoration/list", @"VKDecorationListViewController")
}
關(guān)于這個(gè)編程語言的所有規(guī)范撇叁，如果這里沒有寫到供鸠，那就在蘋果的文檔里：
