Objective-C 编码风格指南

发表于 | 更新于: | 分类于 ，
阿里云产品限时红包，最高 ￥1888 元，立即领取。

文件编码

源文件编码格式为 UTF-8

语言

使用英语，变量的命名等已英语单词命名，不要使用汉语拼音。

代码组织

使用 #pragma mark 来为方法分组。

间距与空白

  • 一个缩进使用 4 个空格，不要使用制表符。可以在 Xcode 中配置自动将 Tab 转化为空格。在 Xcode > Preferences > Text Editing 将 Tab 和自动缩进都设置为 4 个空格。
  • 行尾不允许留有空格。
  • 关键字及符号之间需要留有 1 个空格。
  • 方法或者代码块之间留有一行空白。

大括号

  • 方法和大括号及其他大括号( if / else / switch / while 等等)始终和声明在同一行开始，在新的一行结束。

以下是正确的：

1
2
3
4
5
if (user.isHappy) {
  //Do something
} else {
  //Do something else
}

以下是不正确的：

1
2
3
4
5
6
7
if (user.isHappy)
{
    //Do something
}
else {
    //Do something else
}

对齐

  • 应该避免以冒号对齐的方式来调用方法。因为有时方法签名可能有3个以上的冒号和冒号对齐会使代码更加易读。请不要这样做，尽管冒号对齐的方法包含代码块，因为 Xcode 的对齐方式令它难以辨认。

应该：

1
2
3
4
5
6
// blocks are easily readable
[UIView animateWithDuration:1.0 animations:^{
  // something
} completion:^(BOOL finished) {
  // something
}];

不应该：

1
2
3
4
5
6
7
8
// colon-aligning makes the block indentation hard to read
[UIView animateWithDuration:1.0
                 animations:^{
                     // something
                 }
                 completion:^(BOOL finished) {
                     // something
                 }];

命名

  • 长的，描述性的方法和变量命名是好的。

应该：

1
UIButton *settingsButton;

不应该：

1
UIButton *setBut;

三个字符前缀应该经常用在类和常量命名，但在Core Data的实体名中应被忽略。

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

应该：

1
static NSTimeInterval const RWTTutorialViewControllerNavigationFadeAnimationDuration = 0.3;

不应该：

1
static NSTimeInterval const fadetime = 1.7;
  • 属性也是使用驼峰式，但首单词的首字母小写。对属性使用auto-synthesis，而不是手动编写@synthesize语句，除非你有一个好的理由。

应该：

1
@property (strong, nonatomic) NSString *descriptiveVariableName;

不应该：

1
id varnm;

下划线

当使用属性时，实例变量应该使用 self. 来访问和改变。这就意味着所有属性将会视觉效果不同，因为它们前面都有 self. 。

但有一个特例：在初始化方法里，实例变量(例如，_variableName)应该直接被使用来避免 getters/setters 潜在的副作用。

局部变量不应该包含下划线。

方法

在方法签名中，应该在方法类型(-/+ 符号)之后有一个空格。在方法各个段之间应该也有一个空格(符合 Apple 的风格)。在参数之前应该包含一个具有描述性的关键字来描述参数。

“and”这个词的用法应该保留。它不应该用于多个参数来说明，就像 initWithWidth:height 以下这个例子：

应该：

1
2
3
4
- (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;

不应该：

1
2
3
4
5
-(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，除了一些特殊情况下常量。

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

通过使用’back’属性( _variable ，变量名前面有下划线)直接访问实例变量应该尽量避免，除了在初始化方法( init , initWithCoder: , 等…)， dealloc 方法和自定义的 setters 和 getters 。想了解关于如何在初始化方法和 dealloc 直接使用 Accessor 方法的更多信息，查看这里。

应该：

1
2
3
@interface RWTTutorial : NSObject
@property (strong, nonatomic) NSString *tutorialName;
@end

不应该：

1
2
3
@interface RWTTutorial : NSObject {
    NSString *tutorialName;
}

属性特性

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

应该：

1
2
@property (weak, nonatomic) IBOutlet UIView *containerView;
@property (strong, nonatomic) NSString *tutorialName;

不应该：

1
2
@property (nonatomic, weak) IBOutlet UIView *containerView;
@property (nonatomic) NSString *tutorialName;
  • NSString应该使用copy而不是strong的属性特性。

为什么？即使你声明一个NSString的属性，有人可能传入一个NSMutableString的实例，然后在你没有注意的情况下修改它。

应该：

1
@property (copy, nonatomic) NSString *tutorialName;

不应该：

1
@property (strong, nonatomic) NSString *tutorialName;

点符号语法

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

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

应该：

1
2
3
NSInteger arrayCount = [self.array count];
view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;

不应该：

1
2
3
NSInteger arrayCount = self.array.count;
[view setBackgroundColor:[UIColor orangeColor]];
UIApplication.sharedApplication.delegate;

字面值

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

应该：

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

不应该：

1
2
3
4
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，除非显式地使用宏。

常量常用的命名方法是：若常量局限于某“编译单元”（translation unit，也就是“实现文件”， implementation file）之内，则在前面加字母k, 如kAnimationDuration；若常量在类之外可见，则通常以类名为前缀。应该如 static NSString * const 而不是 static const NSString *。

应该：

1
2
static NSString * const RWTAboutViewControllerCompanyName = @"RayWenderlich.com";
static CGFloat const RWTImageThumbnailHeight = 50.0;

不应该：

1
2
static const NSString *RWTAboutViewControllerCompanyName = @"RayWenderlich.com";
static const CGFloat RWTImageThumbnailHeight = 50.0;

或

1
2
#define CompanyName @"RayWenderlich.com"
#define thumbnailHeight 2
  • 常量指针：初始化之后不能赋值。
1
NSString * const pt1;
  • 指向常量的指针：初始化之后可以赋值，即指向别的常量，指针本身的值可以修改。
1
const NSString * pt2;
  • 指向常量的常量指针
1
const NSString * const pt3;

枚举类型

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

例如：

1
2
3
4
5
typedef NS_ENUM(NSInteger, RWTLeftMenuTopItemType) {
    RWTLeftMenuTopItemMain,
    RWTLeftMenuTopItemShows,
    RWTLeftMenuTopItemSchedule
};

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

1
2
3
4
5
6
typedef NS_ENUM(NSInteger, RWTGlobalConstants) {
    RWTPinSizeMin = 1,
    RWTPinSizeMax = 5,
    RWTPinCountMin = 100,
    RWTPinCountMax = 500,
};

旧的 k-style 常量定义应该避免，除非编写 Core Foundation C 的代码。

不应该：

1
2
3
4
enum GlobalConstants {
    kMaxPinSize = 5,
    kMaxPinCount = 500,
};

Case语句

  • 大括号在 case 语句中必须的，不仅仅是 case 语句包含多行代码时，大括号都应该加上。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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需要注释一下。
1
2
3
4
5
6
7
8
9
10
switch (condition) {
    case 1:
        // ** fall-through! **
    case 2:
        // code executed for values 1 and 2
        break;
    default: 
        // ...
        break;
}
  • 当在switch使用枚举类型时，’default’是不需要的。例如：
1
2
3
4
5
6
7
8
9
10
11
12
RWTLeftMenuTopItemType menuType = RWTLeftMenuTopItemMain;
switch (menuType) {
    case RWTLeftMenuTopItemMain:
        // ...
        break;
    case RWTLeftMenuTopItemShows:
        // ...
        break;
    case RWTLeftMenuTopItemSchedule:
        // ...
        break;
}

私有属性

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

例如：

1
2
3
4
5
@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位。

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

应该：

1
2
if (someObject) {}
if (![anotherObject boolValue]) {}

不应该：

1
2
3
4
if (someObject == nil) {}
if ([anotherObject boolValue] == NO) {}
if (isAwesome == YES) {} // Never do this.
if (isAwesome == true) {} // Never do this.
  • 如果BOOL属性的名字是一个形容词，属性就能忽略”is”前缀，但要指定get访问器的惯用名称。例如：
1
@property (assign, getter=isEditable) BOOL editable;

条件语句

  • 条件语句主体为了防止出错应该使用大括号包围，即使条件语句主体能够不用大括号编写(如，只用一行代码)。这些错误包括添加第二行代码和期望它成为 if 语句；还有，even more dangerous defect 可能发生在if语句里面一行代码被注释了，然后下一行代码不知不觉地成为if语句的一部分。除此之外，这种风格与其他条件语句的风格保持一致，所以更加容易阅读。

应该：

1
2
3
if (!error) {
    return success;
}

不应该：

1
2
if (!error)
    return success;

或者：

1
if (!error) return success;

三元操作符

当需要提高代码的清晰性和简洁性时，三元操作符 ?: 才会使用。单个条件求值常常需要它。多个条件求值时，如果使用 if 语句或重构成实例变量时，代码会更加易读。一般来说，最好使用三元操作符是在根据条件来赋值的情况下。

Non-boolean 的变量与某东西比较，加上括号()会提高可读性。如果被比较的变量是 boolean 类型，那么就不需要括号。

应该：

1
2
3
4
NSInteger value = 5;
result = (value != 0) ? x : y;
BOOL isHorizontal = YES;
result = isHorizontal ? x : y;

不应该：

1
result = a > b ? x = c > d ? c : d : y;

Init方法

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

1
2
3
4
5
6
7
- (instancetype)init {
    self = [super init];
    if (self) {
        // ...
    }
    return self;
}

类构造方法

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

1
2
3
@interface Airplane
+ (instancetype)airplaneWithType:(RWTAirplaneType)type;
@end

关于更多 instancetype，请查看这里。

CGRect函数

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

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

应该：

1
2
3
4
5
6
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);

不应该：

1
2
3
4
5
6
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。

应该：

1
2
3
4
5
6
- (void)someMethod {
    if (![someOther boolValue]) {
        return;
    }
    //Do something important
}

不应该：

1
2
3
4
5
- (void)someMethod {
    if ([someOther boolValue]) {
        //Do something important
    }
}

错误处理

当方法通过引用来返回一个错误参数，判断返回值而不是错误变量。

应该：

1
2
3
4
NSError *error;
if (![self trySomethingWithError:&error]) {
    // Handle Error
}

不应该：

1
2
3
4
5
NSError *error;
[self trySomethingWithError:&error];
if (error) {
    // Handle Error
}

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

单例模式

单例对象应该使用线程安全模式来创建共享实例。

1
2
3
4
5
6
7
8
+ (instancetype)sharedInstance {
    static id sharedInstance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedInstance = [[self alloc] init];
    });
    return sharedInstance;
}

这可以防止有时可能产生的崩溃

换行符

换行符是一个很重要的主题，因为它的风格指南主要为了打印和网上的可读性。

例如：

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

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

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

导入

如果有一个以上的 import 语句，就对这些语句进行分组。每个分组的注释是可选的。
注：对于模块使用 @import 语法。

1
2
3
4
5
6
7
8
9
// Frameworks
@import QuartzCore;
  
// Models
#import "NYTUser.h"

// Views
#import "NYTButton.h"
#import "NYTUserView.h"

飞博可接受的缩略词

缩略词 说明
VC ViewController
VM ViewModel

参考

中文版

Google Objective-C Style Guide 中文版

Apple 官方 Cocoa 编码规范

Objective-C编码规范：26个方面解决iOS开发问题

纽约时报 移动团队 Objective-C 规范指南

英文版

Google Objective-C Style Guide

Coding Guidelines for Cocoa

Raywenderlich.com Objective-C style guide

NYTimes Objective-C Style Guide