iOS开发代码规范

iOS命名两大原则是:可读性高和防止命名冲突(通过加前缀来保证). Objective-C 的命名通常都比较长, 名称遵循驼峰式命名法. 一个好的命名标准很简单, 就是做到在开发者一看到名字时, 就能够懂得它的含义和使用方法. 另外, 每个模块都要加上自己的前缀, 前缀在编程接口中非常重要, 可以区分软件的功能范畴并防止不同文件或者类之间命名发生冲突, 比如相册模块(PhotoGallery)的代码都以PG作为前缀: PGAlbumViewController, PGDataManager.

• 1). 常量的命名

  • 1
    static const NSTimeInterval kAnimationDuration = 0.3;
  • 定义作为NSDictionary或者Notification等的Key值字符串时加上const关键字, 以防止被修改. 如:NSString *const UIApplicationDidEnterBackgroundNotification
  • 若常量作用域超出编译单元(实现文件), 需要在类外可见时, 使用extern关键字, 并加上该类名作为前缀. 如 extern NSString *const PGThumbnailSize
  • 全局常量(通知或者关键字等)尽量用const来定义. 因为如果使用宏定义, 一来宏可能被重定义. 二来引用不同的文件可能会导致宏的不同. P.S. 对于＃define也添加一下前缀k

• 2). 枚举的命名

  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了

• 编码规范

  • 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). 初始化方法 多用字面值初始化
    NSArray *names = @[@"Brian", @"Matt", @"Chris", @"Alex", @"Steve"];
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal"};
NSNumber *shouldUseLiterals = @YES;
NSNumber *buildingZIPCode = @10018;
    
    • 第一个好处还是简洁, 第二个好处是可以防止初始化进去nil值造成crash
  • 4). 定义属性
    
    • 建议定义属性的时候把所有的参数写全, 尤其是如果想定义成只读的(防止外面修改)那一定要加上readonly, 这也是代码安全性的一个习惯.
    • 如果是内部使用的属性, 那么就定义成私有的属性(定义到.m的class extension里面)
    • 对于拥有Mutable子类型的对象(e.g. NSString, NSArray, NSDictionary)一定要定义成copy属性. Why? 示例: NSArray的array = NSMutableArray的mArray; 如果mArray在某个地方改变了, 那array也会跟着改变.
    • 尽量不要暴露mutable类型的对象在public interface, 建议在.h定义一个Inmutable类型的属性, 然后在.m的get函数里面返回一个内部定义的mutable变量.

  • 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]) { ... } </li>
<li>(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;
    • Not preferred:
      BOOL isValid = NO;
      if (user.UserName)
{
if (user.Password)
{
if (user.Email) isValid = YES;
}
}
return isValid;
    • 一旦发现某个条件不符合, 立即返回, 条理更清晰

  • 9). 参数过多

    • Preferred:
      - (void)registerUser(User *user)
{
// to do...
}
    • Not preferred:
      - (void)registerUserName:(NSString *)userName
password:(NSString *)password
email:(NSString *)email
{
// to do...
}
    • 当发现实现某一功能需要传递的参数太多时, 就预示着你应该聚合成一个model类了...这样代码更整洁, 也不容易因为参数太多导致出错。
  • 10). 回调方法:
    
    • Preferred:
      - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath;
    • 函数调用的可知性, 回调时被调用者要知道其调用者, 方便信息的传递, 所以建议在回调方法中第一个参数中加上调用者。

• References:

  • iOS开发总结之代码规范