iOS开发Objective-C编码规范

摘要：由于每个人的Objective-C编码风格都不一致，这样不易于保持代码一致性和难以Code Review。为了保证项目代码的优雅、一致和易读性，所以，每个参与此项目的开发人员都需要尽量支持统一的Objective-C编码风格指南。以下作为此项目的编码规范，如有更好的规范，可以陆续优化。

一、_ 语言 _

应该使用US英语

二、_ 代码组织 _

• 在函数分组和protocol/delegate实现中使用#pragma mark -来分类方法，要遵循以下一般结构：

   #prama mark - Lifecycle
   #prama mark -
  - (void)ViewDidLoad{}
  
  - (void)viewWillAppear:(BOOL)animated {} 
  
   #pragma mark - Custom Accessors
   #pragma mark -
  - (void)setCustomProperty:(id)value {}  
  - (id)customProperty {}  
  
   #pragma mark - Public
   #pragma mark - 
  - (void)publicMethod {}  
  
   #pragma mark - Private
   #pragma mark - 
  - (void)privateMethod {} 

  三、_ 空格 _

• 缩进使用4个空格，确保在Xcode偏好设置来设置

• 方法大括号和其他大括号(if/else/switch/while 等.)总是在可以同一行语句打开 或是新一行语句打开但在新行中关闭

  个人喜好为新一行语句打开和新行中关闭，如下所示

  if (user.isHappy)  
  {  
    //Do something  
  }  
  else 
  {  
    //Do something else  
  } 

四、_ 注释 _

• 注释很重要，但除了开头的版权声明，尽可能把代码写的如同文档一样，让别人直接看代码就知道意思，写代码时别担心名字太长，相信Xcode的提示功能。

• 实例变量应该在实现文件.m中声明或以@property形式在.h文件中声明，一定要直接在.h文件声明，加上@priavte，另外，使用@private、@public，前面需要一个缩进空格。

• 尽可能保证 .h文件的简洁性，可以不公开的API就不要公开了，写在实现文件中即可。

  属性注释：

  @property (nonatomic,assign) NSInteger xLineCount;  /**< 格子横线数量 */
  

  只需要这样注释，在设置其属性时候，可以清晰了解到当前属性对应的注释信息
  如果每次都手动写类似格式，可以Xcode自定义代码模块，设置当前的代码块为/*< <#注释描述#> /

  方法注释：

  /*!
   *  @brief 用一组数据初始化柱形图
   *
   *  @param frame 初始化frame
   *  @param data  设置当前的图表百分比
   *
   *  @return 对象本身
   */
  - (instancetype)initWithFrame:(CGRect)frame dictionary:(NSDictionary *)data;
  

  Tips：有很多可以自动生成注释格式的插件，推荐使用 VVDocumenter

五、_ 命名 _

• iOS声明属性或方法等需要遵循驼峰式命名规则

• 类名首字母大写，方法首字母小写，方法中的参数首字母小写，同时尽量让方法的命名读起来是一句话，能够传达出方法的意思，同时取值方法前不要加前缀get 或 set(和自带set或get混淆)，变量名小写字母开头，常量以小写字母k开头，后续首字母大写

• 声明类或方法时，注意空格的使用，参数过多时可换行保持对齐，调用方法时也是如此，参数都写在一行或换行冒号对齐

• 常量应该使用驼峰式命名规则，所有的单词首字母大写和加上与类名有关的前缀。

六、_ 下划线 _

• 当使用属性时，实例变量应该使用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;
  

八、_ 变量 _

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

• 星号表示变量是指针。例如， NSString text 既不是 NSString text 也不是 NSString * text_，除了一些特殊情况下常量。

九、_ 属性特性 _

• 所有属性特性应该显式地列出来，有助于新手阅读代码。属性特性的顺序应该是storage、atomicity，与在Interface Builder连接UI元素时自动生成代码一致。

  @property (weak, nonatomic) IBOutlet UIView *containerView;

  @property (strong, nonatomic) NSString *tutorialName;

十、_ 点符号语法 _

• 点语法是一种很方便封装访问方法调用的方式。当你使用点语法时，通过使用getter或setter方法，属性仍然被访问或修改。

• 点语法应该 _ 总是 _ 被用来访问和修改属性，因为它使代码更加简洁。[]符号更偏向于用在其他例子。

十一、_ 字面值 _

• 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常量定义应该避免除非编写Core Foundation C的代码。

  不应该：

  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，所以没有必要在条件语句比较。不要拿某样东西直接与YES比较，因为YES被定义为1和一个BOOL能被设置为8位。

  这是为了在不同文件保持一致性和在视觉上更加简洁而考虑。

  应该：

  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语句；还有，even more dangerous defect可能发生在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分组的创建应该在文件系统的文件体现。代码不仅是根据类型来分组，而且还可以根据功能来分组，这样代码更加清晰。