Objective-C高质量代码参考规范

标签（空格分隔）： 编码规范 Objective-C

---

本文内容大部分来自：程序员头条 英文原文：GitHub原文 高质量，我的理解是规范和高效的代码，本文也将围绕这两方面来讲。持续更新中...

如有不足或不妥，请留言纠正

---

#第一部分、代码规范

##一、语言表达 语言使用US（美式）英语 例如

UIColor *myColor = [UIColor whiteColor];
复制代码

而不是

UIColor *myColour = [UIColor whiteColor];
复制代码

##二、代码组织 在众多的方法定义和实现中使用#pragma mark - 来分类方法，如生命周期函数，协议方法，数据源协议方法，事件响应方法，自定义公共方法/私有方法等区分方式来分类方法，要遵循以下一般结构：

#pragma mark - Lifecycle  
- (instancetype)init {}  
- (void)dealloc {}  
- (void)viewDidLoad {}  
- (void)viewWillAppear:(BOOL)animated {}  
- (void)didReceiveMemoryWarning {}  

#pragma mark - Custom Accessors  
- (void)setCustomProperty:(id)value {}  
- (id)customProperty {}  

#pragma mark - IBActions  
- (IBAction)submitData:(id)sender {}  

#pragma mark - Public  
- (void)publicMethod {}  

#pragma mark - Private  
- (void)privateMethod {}  

#pragma mark - Protocol conformance  
#pragma mark - UITextFieldDelegate  
#pragma mark - UITableViewDataSource  
#pragma mark - UITableViewDelegate  

#pragma mark - NSCopying  
- (id)copyWithZone:(NSZone *)zone {}  

#pragma mark - NSObject  
 1. (NSString *)description {}  
复制代码

##三、空格、空行和换行

1. 列表项缩进使用4个空格，确保使用Xcode偏好设置来设置
2. 方法大括号和其他大括号(if/else/switch/while 等.)总是在同一行语句打开但在新行中关闭。 例如：

if (user.isHappy) {  
    //Do something  
} else {  
    //Do something else  
}  
复制代码

而不是
复制代码

if (user.isHappy)  
{  
  //Do something  
}  
else {  
  //Do something else  
}  
复制代码

3. 在方法之间应该有且只有一行空行，这样在视觉上易于分析和组织。方法/函数内部使用空白来分离功能，但通常不同功能会抽离出新函数
4. 优先使用auto-synthesis。但如果有必要，@synthesize和@dynamic应该在实现中每个都声明新的一行
5. 应该避免以冒号对其的方式来调用方法。有时方法签名可可有3个以上的冒号，冒号对其回事代码更易读，但如果冒号对其的方法包含代码块，这种对其方式会更加难以辩解。 例如：

// blocks are easily readable  
[UIView animateWithDuration:1.0 animations:^{  
  // something  
} completion:^(BOOL finished) {  
  // something  
}];
复制代码

而不是

// colon-aligning makes the block indentation hard to read  
[UIView animateWithDuration:1.0  
                 animations:^{  
                     // something  
                 }  
                 completion:^(BOOL finished) {  
                     // something  
                 }]; 
复制代码

##四、注释 一般注释都应用在注解比较难以理解的功能实现或者特殊代码。注释随代码更新，没用的及时删除。代码要尽量做到自解释，即看到方法的英文名就明白他是干嘛的，这也是Objective -C长方法名和带参数标注的好处。因而除了文档输出需要的注释以外，尽量避免使用块注释：/**/

##五、命名

1. 坚持描述性的方法名和变量名 例如：

UIUIButton *settingsButton; 
复制代码

而不是

UIButton *setBut; 
复制代码

2. 在类名和常量名前加前缀，比如对于raywenderlich.com都会使用RWT前缀。常量名应该使用大驼峰命名法，所有单词首字母大写加上前缀 例如：

static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;
复制代码

而不是

static NSTimeInterval const fadetime = 1.7; 
复制代码

属性使用小驼峰式，对属性使用auto-synthesis，而不是手动编写@synthesize语句 例如：

@property (strong, nonatomic) NSString *descriptiveVariableName; 
复制代码

而不是

id varnm; 
复制代码

##六、下划线 当使用属性时，实例变量应该使用self.来访问和改变。这就意味着所有属性将会视觉效果不同，因为它们前面都有self.。但有一个特例：在初始化方法里，实例变量(例如，_variableName)应该直接被使用来避免getters/setters潜在的副作用。局部变量不应该包含下划线。

##七、方法

在方法签名中，应该在方法类型(-/+符号)之后有一个空格。在方法各个段之间应该也有一个空格(符合Apple的风格)。在参数之前应该包含一个具有描述性的关键字来描述参数。 “and”这个词就不要用了。它不应该用于说明多个参数来，就像initWithWidth:height以下这个例子：

- (void)setExampleText:(NSString *)text image:(UIImage *)image;  
- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;  
- (id)viewWithTag:(NSInteger)tag;  
- (instancetype)initWithWidth:(CGFloat)width height:(CGFloat)height; 
复制代码

而不是

-(void)setT:(NSString *)text i:(UIImage *)image;  
- (void)sendAction:(SEL)aSelector :(id)anObject :(BOOL)flag;  
- (id)taggedView:(NSInteger)tag;  
- (instancetype)initWithWidth:(CGFloat)width andHeight:(CGFloat)height;  
- (instancetype)initWith:(int)width and:(int)height;  // Never do this.  
复制代码

##八、变量 变量尽量以描述性的方式来命名。单个字符的变量命名应该尽量避免，除了在for()循环中。

星号表示变量是指针。例如：

正确的是：NSString *text
既不是 NSString* text
也不是 NSString * text，除了一些特殊情况下的常量这里不考虑。
复制代码

私有变量应该尽可能代替实例变量的使用。尽管使用实例变量是一种有效的方式，但更偏向于使用属性来保持代码一致性。

通过使用(_variable，变量名前面有下划线)直接访问实例变量应该尽量避免，除了在初始化方法(init, initWithCoder:, 等…)，dealloc 方法和自定义的setters和getters。 例如

@interface RWTTutorial : NSObject  
@property (strong, nonatomic) NSString *tutorialName;  
@end  
复制代码

而不是

@interface RWTTutorial : NSObject {  
  NSString *tutorialName;  
}  
复制代码

##九、属性和其特性 所有属性特性应该显式地列出来，有助于新手阅读代码。属性特性的顺序应该是storage、atomicity，与在Interface Builder连接UI元素时自动生成代码一致。NSString应该使用copy而不是strong的属性特性。 为什么？即使你声明一个NSString的属性，有人可能传入一个NSMutableString的实例，然后在你没有注意的情况下修改它。 例如

@property (weak, nonatomic) IBOutlet UIView *containerView;  
@property (copy, nonatomic) NSString *tutorialName;
复制代码

而不是

@property (nonatomic, weak) IBOutlet UIView *containerView;  
@property (nonatomic) NSString *tutorialName; 
复制代码

##十、点符号语法 点语法是一种很方便封装访问方法调用的方式。当你使用点语法时，通过使用getter或setter方法，属性仍然可以被访问和修改。点语法应该总是被用来访问和修改属性，因为它使代码更加简洁。[]符号更偏向于用在其他例子。 例如

NSInteger arrayCount = [self.array count];  
view.backgroundColor = [UIColor orangeColor];  
[UIApplication sharedApplication].delegate; 
复制代码

而不是

NSInteger arrayCount = self.array.count; 
[view setBackgroundColor:[UIColor orangeColor]]; UIApplication.sharedApplication.delegate;
复制代码

##十一、字面量 NSString、NSDictionary、NSArray和NSNumber的字面值应该在创建这些类的不可变实例时被使用。请特别注意nil值不能传入NSArray和NSDictionary字面值，因为这样会导致crash。 例如

NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul"];  
NSDictionary *productManagers = @{@"iPhone": @"Kate", @"iPad": @"Kamal", @"Mobile Web": @"Bill"};  
NSNumber *shouldUseLiterals = @YES;  
NSNumber *buildingStreetNumber = @10018;
复制代码

而不是

NSArray *names = [NSArray arrayWithObjects:@"Brian", @"Matt", @"Chris", @"Alex", @"Steve", @"Paul", nil];  
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];  
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];  
NSNumber *buildingStreetNumber = [NSNumber numberWithInteger:10018];  
复制代码

##十二、常量 常量是容易重复被使用和无需通过查找和代替就能快速修改值。常量应该使用static来声明而不是使用#define，除非显式地使用宏。 例如

static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";  
static CGFloat const RWTImageThumbnailHeight = 50.0;
复制代码

而不是

#define CompanyName @"RayWenderlich.com"  
#define thumbnailHeight 2 
复制代码

##十三、枚举类型 当使用enum时，推荐使用新的固定基本类型规格，因为它有更强的类型检查和代码补全。现在SDK有一个宏NS_ENUM()来帮助和鼓励你使用固定的基本类型。 例如

typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {  
  RWTLeftMenuTopItemMain,  
  RWTLeftMenuTopItemShows,  
  RWTLeftMenuTopItemSchedule  
}; 
复制代码

你也可以显式地赋值(展示旧的k-style常量定义)

typedef NS_ENUM(NSInteger, RWTGlobalConstants) {  
  RWTPinSizeMin = 1,  
  RWTPinSizeMax = 5,  
  RWTPinCountMin = 100,  
  RWTPinCountMax = 500,  
};
复制代码

旧的k-style常量定义也应该避免。 而不是

enum GlobalConstants {  
  kMaxPinSize = 5,  
  kMaxPinCount = 500,  
}; 
复制代码

##十四、Case语句 大括号在case语句中并不是必须的，除非编译器强制要求。当一个case语句包含多行代码时，大括号应该加上。 例如

switch (condition) {  
  case 1:  
    // ...  
    break;  
  case 2: {  
    // ...  
    // Multi-line example using braces  
    break;  
  }  
  case 3:  
    // ...  
    break;  
  default:   
    // ...  
    break;  
}  
复制代码

当相同代码被多个cases使用很多次时，应该使用fall-through语法。fall-through就是在case最后移除’break’语句，这样就能够允许执行流程跳转到下一个case值。为了代码更加清晰，使用fall-through需要注释一下。

switch (condition) {  
  case 1:  
    // ** fall-through! **  
  case 2:  
    // code executed for values 1 and 2  
    break;  
  default:   
    // ...  
    break;  
} 
复制代码

当在switch使用枚举类型时，’default’是不需要的,例如：

RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;  
switch (menuType) {  
  case RWTLeftMenuTopItemMain:  
    // ...  
    break;  
  case RWTLeftMenuTopItemShows:  
    // ...  
    break;  
  case RWTLeftMenuTopItemSchedule:  
    // ...  
    break;  
} 
复制代码

##十五、私有属性 私有属性应该在类的实现文件中的类扩展(匿名分类)中声明，命名分类(比如RWTPrivate或private)应该从不使用除非是扩展其他类。匿名分类应该通过使用+Private.h文件的命名规则暴露给测试。 例如

@interface RWTDetailViewController ()  
@property (strong, nonatomic) GADBannerView *googleAdView;  
@property (strong, nonatomic) ADBannerView *iAdView;  
@property (strong, nonatomic) UIWebView *adXWebView;  
@end 
复制代码

##十六、布尔值 Objective-C使用YES和NO。因为true和false应该只在CoreFoundation，C或C++代码使用。既然nil解析成NO，也就没有必要在条件语句中进行比较。这是为了在不同文件保持一致性和在视觉上更加简洁而考虑。 例如：

if (someObject) {}  
if (![anotherObject boolValue]) {}  
复制代码

而不是

if (someObject == nil) {}  
if ([anotherObject boolValue] == NO) {}  
if (isAwesome == YES) {} // Never do this.  
if (isAwesome == true) {} // Never do this.
复制代码

果BOOL属性的名字是一个形容词，属性就能忽略”is”前缀，但要指定get访问器的惯用名称。

@property (assign, getter=isEditable) BOOL editable;
复制代码

##十七、条件语句 条件语句主体为了防止出错应该使用大括号包围，即使条件语句主体能够不用大括号编写(如，只用一行代码)。这些错误包括在if语句中添加第二行代码，甚至有更危险的可能，如果if语句里面一行代码被注释了，然后下一行代码不知不觉地成为if语句的一部分。除此之外，这种风格与其他条件语句的风格保持一致，所以更加容易阅读。 例如

if (!error) {  
  return success;  
}
复制代码

而不是

if (!error)  
  return success;  
复制代码

也不要

if (!error)  return success;  

复制代码

##十八、三元操作符 当需要提高代码的清晰性和简洁性时，三元操作符?:才会使用。单个条件求值常常需要它。多个条件求值时，如果使用if语句或重构成实例变量时，代码会更加易读。一般来说，最好使用三元操作符是在根据条件来赋值的情况下。 Non-boolean的变量与某东西比较，加上括号()会提高可读性。如果被比较的变量是boolean类型，那么就不需要括号。 例如

NSInteger value = 5;  
result = (value != 0) ? x : y;  
BOOL isHorizontal = YES;  
result = isHorizontal ? x : y; 
复制代码

而不是

result = a > b ? x = c > d ? c : d : y; 
复制代码

##十九、Init方法 Init方法应该遵循Apple生成代码模板的命名规则，返回类型应该使用instancetype而不是id。

- (instancetype)init {  
  self = [super init];  
  if (self) {  
    // ...  
  }  
  return self;  
} 
复制代码

##二十、类构造方法 当类构造方法被使用时，它应该返回类型是instancetype而不是id。这样确保编译器正确地推断结果类型。

@interface Airplane  
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;  
@end 
复制代码

##二十一、CGRect函数 当访问CGRect里的x, y, width, 或 height时，应该使用CGGeometry函数而不是直接通过结构体来访问。引用Apple的CGGeometry：

在这个参考文档中所有的函数，接受CGRect结构体作为输入，在计算它们结果时隐式地标准化这些rectangles。因此，你的应用程序应该避免直接访问和修改保存在CGRect数据结构中的数据。相反，使用这些函数来操纵rectangles和获取它们的特性。

例如：

CGRect frame = self.view.frame;  
CGFloat x = CGRectGetMinX(frame);  
CGFloat y = CGRectGetMinY(frame);  
CGFloat width = CGRectGetWidth(frame);  
CGFloat height = CGRectGetHeight(frame);  
CGRect frame = CGRectMake(0.0, 0.0, width, height); 
复制代码

不应该：

CGRect frame = self.view.frame;  
CGFloat x = frame.origin.x;  
CGFloat y = frame.origin.y;  
CGFloat width = frame.size.width;  
CGFloat height = frame.size.height;  
CGRect frame = (CGRect){ .origin = CGPointZero, .size = frame.size };
复制代码

##二十二、黄金路径 当使用条件语句编码时，左手边的代码应该是”golden” 或 “happy”路径。也就是不要嵌套if语句，多个返回语句也是OK。

例如

- (void)someMethod {  
  if (![someOther boolValue]) {  
    return;  
  }  
  //Do something important  
}
复制代码

不应该：

- (void)someMethod {  
  if ([someOther boolValue]) {  
    //Do something important  
  }  
} 
复制代码

##二十三、错误处理 当方法通过引用来返回一个错误参数，判断返回值而不是错误变量。 例如

NSError *error;  
if (![self trySomethingWithError:&error]) {  
  // Handle Error  
} 
复制代码

不应该：

NSError *error;  
[self trySomethingWithError:&error];  
if (error) {  
  // Handle Error  
} 
复制代码

在成功的情况下，有些Apple的APIs记录垃圾值(garbage values)到错误参数(如果non-NULL)，那么判断错误值会导致false负值和crash

##二十三、单例模式 单例对象应该使用线程安全模式来创建共享实例。 例如

+ (instancetype)sharedInstance {  
  static id sharedInstance = nil;  
  static dispatch_once_t onceToken;  
  dispatch_once(&onceToken, ^{  
    sharedInstance = [[self alloc] init];  
  });  
  return sharedInstance;  
}
复制代码

这会防止possible and sometimes prolific crashes。

##二十四、换行符 换行符是一个很重要的主题，因为它的风格指南主要为了打印和网上的可读性。 例如：

self.productsRequest = [[SKProductsRequest alloc] initWithProductIdentifiers:productIdentifiers];  

复制代码

一行很长的代码应该分成两行代码，下一行用两个空格隔开。

self.productsRequest = [[SKProductsRequest alloc]   
  initWithProductIdentifiers:productIdentifiers]; 
复制代码

##二十五、Xcode工程 物理文件应该与Xcode工程文件保持同步来避免文件扩张。任何Xcode分组的创建应该在文件系统的文件体现。代码不仅是根据类型来分组，而且还可以根据功能来分组，这样代码更加清晰。

尽可能在target的Build Settings打开”Treat Warnings as Errors，和启用以下additional warnings。如果你需要忽略特殊的警告，使用Clang’s pragma feature