Objective-C 代码规范

Objective-C是一门面向对象的动态编程语言,主要用于编写iOS和Mac应用程序。

一、代码格式

1.1 函数的书写

一个典型的Objective-C函数应该是这样的:

- (instancetype)initWithAuthName:(NSString *)authName password:(NSString *)password token:(NSString *)token {

}

-(void) 之间应该有一个空格,第一个大括号 { 的位置在函数所在行的末尾,同样应该有一个空格。

如果一个函数有特别多的参数或者名称很长,可以将其按照 : 来对齐分行显示:

- (instancetype)initWithAuthName:(NSString *)authName
                     	password:(NSString *)password
                     		token:(NSString *)token
            		    	email:(NSString *)email
            		  phoneNumber:(NSString *)phoneNumber

1.2 函数调用

函数调用的格式和书写差不多,可以按照函数的长短来选择写在一行或者分成多行:

// 写在一行
[myObject initWithAuthName:arg1 password:arg2 token:arg3];

// 分行写,按照':'对齐
[myObject initWithAuthName:arg1
				   password:arg2
				   	  token:arg3];

以下写法是错误的:

// 错误,要么写在一行,要么全部分行
[myObject doFooWith:arg1 name:arg2
              error:arg3];
[myObject doFooWith:arg1
               name:arg2 error:arg3];

// 错误,按照':'来对齐,而不是关键字
[myObject doFooWith:arg1
		  name:arg2
		  error:arg3];

1.3 @[email protected]

@[email protected] 一个空格 来进行缩进:

@interface MyClass:NSObject{
 @public
  ...
 @private
  ...
}
@end

1.4 协议(Protocols)

在书写协议的时候注意用 <> 括起来的协议和类型名之间是没有空格的,这个规则适用所有书写协议的地方,包括函数声明、类声明、实例变量等等:

@interface StoreViewController()<UITableViewDelegate,UITableViewDataSource,UITextFieldDelegate,STSearchBarDelegate>

1.5 闭包(Blocks)

根据block的长度,有不同的书写规则:

  • 如果分行显示的话,block的右括号 } 应该和调用block那行代码的第一个非空字符对齐。
  • block内的代码采用 4个空格 的缩进。
  • ^( 之间, ^{ 之间都没有空格,参数列表的右括号 ){ 之间有一个空格。
// 较短的block写在一行内
[operation setCompletionBlock:^{ [self onOperationDone]; }];

// 分行书写的block,内部使用4空格缩进
[operation setCompletionBlock:^{
    [self.delegate newDataAvailable];
}];

// 使用C语言API调用的block遵循同样的书写规则
dispatch_async(_fileIOQueue, ^{
    NSString* path = [self sessionFilePath];
    if (path) {
      // ...
    }
});

// 较长的block关键字可以缩进后在新行书写,注意block的右括号'}'和调用block那行代码的第一个非空字符对齐
[[SessionService sharedService]
    loadWindowWithCompletionBlock:^(SessionWindow *window) {
        if (window) {
          [self windowDidLoad:window];
        } else {
          [self errorLoadingWindow];
        }
    }];

1.6 语法糖

应该使用可读性更好的语法糖来构造 NSArrayNSDictionary 等数据结构,避免使用冗长的 alloc , init 方法。

如果构造代码写在一行,需要在括号两端留有一个空格,使得被构造的元素于与构造语法区分开来:

// 正确,在语法糖的"[]"或者"{}"两端留有空格
NSArray *array = @[ [foo description], @"Another String", [bar description] ];
NSDictionary *dict = @{ NSForegroundColorAttributeName : [NSColor redColor] };

// 不正确,不留有空格降低了可读性
NSArray *array = @[[foo description], [bar description]];
NSDictionary *dict = @{NSForegroundColorAttributeName: [NSColor redColor]};

如果构造代码不写在一行内,构造元素需要使用 两个空格 来进行缩进,右括号 ] 或者 } 写在新的一行,并且与调用语法糖那行代码的第一个非空字符对齐:

NSArray *array = @[
  @"This",
  @"is",
  @"an",
  @"array"
];

NSDictionary *dictionary = @{
  NSFontAttributeName : [NSFont fontWithName:@"Helvetica-Bold" size:12],
  NSForegroundColorAttributeName : fontColor
};

二、命名规范

2.1 基本原则

2.1.1 清晰

命名应该尽可能的清晰和简洁,但在Objective-C中,清晰比简洁更重要。由于Xcode强大的自动补全功能,我们不必担心名称过长的问题。

// 清晰
insertObject:atIndex:

// 不清晰,insert的对象类型和at的位置属性没有说明
insert:at:

// 清晰
removeObjectAtIndex:

// 不清晰,remove的对象类型没有说明,参数的作用没有说明
remove:

不要使用单词的简写,拼写出完整的单词:

// 清晰
destinationSelection
setBackgroundColor:

// 不清晰,不要使用简写
destSel
setBkgdColor:

然而,有部分单词简写在Objective-C编码过程中是非常常用的,以至于成为了一种规范,这些简写可以在代码中直接使用,下面列举了部分:

alloc   == Allocate					max    == Maximum
alt     == Alternate				min    == Minimum
app     == Application				msg    == Message
calc    == Calculate				nib    == Interface Builder archive
dealloc == Deallocate				pboard == Pasteboard
func    == Function					rect   == Rectangle
horiz   == Horizontal				Rep    == Representation (used in class name such as NSBitmapImageRep).
info    == Information				temp   == Temporary
init    == Initialize				vert   == Vertical
int     == Integer

命名方法或者函数时要避免歧义

// 有歧义,是返回sendPort还是send一个Port?
sendPort

// 有歧义,是返回一个名字属性的值还是display一个name的动作?
displayName

2.1.2 一致性

整个工程的命名风格要保持一致性,最好和苹果SDK的代码保持统一。不同类中完成相似功能的方法应该叫一样的名字,比如我们总是用 count 来返回集合的个数,不能在A类中使用 count 而在B类中使用 getNumber

2.2 使用前缀

如果代码需要打包成Framework给别的工程使用,或者工程项目非常庞大,需要拆分成不同的模块,使用命名前缀是非常有用的。

  • 前缀由大写的字母缩写组成,比如Cocoa中 NS 前缀代表Founation框架中的类, IB 则代表Interface Builder框架。

  • 可以在为类、协议、函数、常量以及typedef宏命名的时候使用前缀,但注意 不要 为成员变量或者方法使用前缀,因为他们本身就包含在类的命名空间内。

  • 命名前缀的时候不要和苹果SDK框架冲突。

2.3 命名类和协议(Class&Protocol)

类名以大写字母开头,应该包含一个 名词 来表示它代表的对象类型,同时可以加上必要的前缀,比如 NSString , NSDate , NSScanner , NSApplication 等等。

而协议名称应该清晰地表示它所执行的行为,而且要和类名区别开来,所以通常使用 ing 词尾来命名一个协议,比如 NSCopying , NSLocking

有些协议本身包含了很多不相关的功能,主要用来为某一特定类服务,这时候可以直接用类名来命名这个协议,比如 NSObject 协议,它包含了id对象在生存周期内的一系列方法。

2.4 命名头文件(Headers)

源码的头文件名应该清晰地暗示它的功能和包含的内容:

  • 如果头文件内只定义了单个类或者协议,直接用类名或者协议名来命名头文件,比如 NSLocale.h 定义了 NSLocale 类。

  • 如果头文件内定义了一系列的类、协议、类别,使用其中最主要的类名来命名头文件,比如 NSString.h 定义了 NSStringNSMutableString

  • 每一个Framework都应该有一个和框架同名的头文件,包含了框架中所有公共类头文件的引用,比如 Foundation.h

  • Framework中有时候会实现在别的框架中类的类别扩展,这样的文件通常使用 被扩展的框架名 + Additions 的方式来命名,比如 NSBundleAdditions.h

2.5 命名方法(Methods)

Objective-C的方法名通常都比较长,这是为了让程序有更好地可读性,按苹果的说法 “好的方法名应当可以以一个句子的形式朗读出来”

方法一般以小写字母打头,每一个后续的单词首字母大写,方法名中不应该有标点符号( 包括下划线 ),有两个例外:

  • 可以用一些通用的大写字母缩写打头方法,比如 PDF , TIFF 等。
  • 可以用带下划线的前缀来命名私有方法或者类别中的方法。

如果方法表示让对象执行一个动作,使用动词打头来命名,注意不要使用 dodoes 这种多余的关键字,动词本身的暗示就足够了:

// 动词打头的方法表示让对象执行一个动作
- (void)invokeWithTarget:(id)target;
- (void)selectTabViewItem:(NSTabViewItem *)tabViewItem;

如果方法是为了获取对象的一个属性值,直接用属性名称来命名这个方法,注意不要添加 get 或者其他的动词前缀:

// 正确,使用属性名来命名方法
- (NSSize)cellSize;

// 错误,添加了多余的动词前缀
- (NSSize)calcCellSize;
- (NSSize)getCellSize;

对于有多个参数的方法,务必在每一个参数前都添加关键词,关键词应当清晰说明参数的作用:

// 正确,保证每个参数都有关键词修饰
- (void)sendAction:(SEL)selector toObject:(id)object forAllCells:(BOOL)flag;

// 错误,遗漏关键词
- (void)sendAction:(SEL)selector :(id)object :(BOOL)flag;

// 正确
- (id)viewWithTag:(NSInteger)tag;

// 错误,关键词的作用不清晰
- (id)taggedView:(int)tag;

方法的参数命名也有一些需要注意的地方:

  • 和方法名类似,参数的第一个字母小写,后面的每一个单词首字母大写
  • 不要在方法名中使用类似 pointer , ptr 这样的字眼去表示指针,参数本身的类型足以说明
  • 不要使用只有一两个字母的参数名
  • 不要使用简写,拼出完整的单词

下面列举了一些常用参数名:

action:(SEL)action
target:(id)target
font:(UIFont *)font
textColor:(UIColor *)textColor
frame:(CGRect)frame
tag:(NSUInteger)tag
atIndex:(int)index
title:(NSString *)title
text:(NSString *)text

2.6 存取方法(Accessor Methods)

存取方法是指用来获取和设置类属性值的方法,属性的不同类型,对应着不同的存取方法规范:

// 属性是一个名词时的存取方法范式
- (NSString *)title;
- (void)setTitle:(NSString *)aTitle;

// 属性是一个形容词时存取方法的范式
- (BOOL)isAdjective;
- (void)setAdjective:(BOOL)flag;
// example
- (BOOL)isEditable;
- (void)setEditable:(BOOL)flag;

// 属性是一个动词时存取方法的范式
- (BOOL)showsAlpha;
- (void)setShowsAlpha:(BOOL)flag;

可以使用 can , should , will 等词来协助表达存取方法的意思,但不要使用 do ,和 does

// 正确
- (void)setCanHide:(BOOL)flag;
- (BOOL)canHide;
- (void)setShouldCloseDocument:(BOOL)flag;
- (BOOL)shouldCloseDocument;

// 错误,不要使用"do"或者"does"
- (void)setDoesAcceptGlyphInfo:(BOOL)flag;
- (BOOL)doesAcceptGlyphInfo;

2.7 命名代理(Delegate)

当特定的事件发生时,对象会触发它注册的代理方法。代理是Objective-C中常用的传递消息的方式。代理有它固定的命名范式。

一个代理方法的第一个参数是触发它的对象,第一个关键词是触发对象的类名,除非代理方法只有一个名为 sender 的参数:

// 第一个关键词为触发委托的类名
- (BOOL)tableView:(UITableView *)tableView shouldSelectRow:(NSUInteger)row;
- (BOOL)application:(NSApplication *)sender openFile:(NSString *)filename;

// 当只有一个"sender"参数时可以省略类名
- (BOOL)applicationOpenUntitledFile:(NSApplication *)sender;

根据代理方法触发的时机和目的,可以使用 should , will , did 等关键词

- (void)browserDidScroll:(NSBrowser *)sender;

- (NSUndoManager *)windowWillReturnUndoManager:(NSWindow *)window;、

- (BOOL)windowShouldClose:(id)sender;

2.8 集合操作类方法(Collection Methods)

有些对象管理着一系列其它对象或者元素的集合,需要使用类似“增删查改”的方法来对集合进行操作,这些方法的命名范式一般为:

//集合操作范式
- (void)addElement:(elementType)anObj;
- (void)removeElement:(elementType)anObj;
- (NSArray *)elements;

// example
- (void)addLayoutManager:(NSLayoutManager *)obj;
- (void)removeLayoutManager:(NSLayoutManager *)obj;
- (NSArray *)layoutManagers;

注意,如果返回的集合是无序的,使用 NSSet 来代替 NSArray 。如果需要将元素插入到特定的位置,使用类似于这样的命名:

- (void)insertLayoutManager:(NSLayoutManager *)obj atIndex:(int)index;
- (void)removeLayoutManagerAtIndex:(int)index;

2.9 命名函数(Functions)

在很多场合仍然需要用到函数,比如说如果一个对象是一个单例,那么应该使用函数来代替类方法执行相关操作。

函数的命名和方法有一些不同,主要是:

  • 函数名称一般带有缩写前缀,表示方法所在的框架。
  • 前缀后的单词以“驼峰”表示法显示,第一个单词首字母大写。

函数名的第一个单词通常是一个动词,表示方法执行的操作:

NSHighlightRect
NSDeallocateObject

如果函数返回其参数的某个属性,省略动词:

unsigned int NSEventMaskFromType(NSEventType type)
float NSHeight(NSRect aRect)

如果函数通过指针参数来返回值,需要在函数名中使用 Get

const char *NSGetSizeAndAlignment(const char *typePtr, unsigned int *sizep, unsigned int *alignp)

函数的返回类型是BOOL时的命名:

BOOL NSDecimalIsNotANumber(const NSDecimal *decimal)

2.10 命名属性和实例变量(Properties&Instance Variables)

属性和对象的存取方法相关联,属性的第一个字母小写,后续单词首字母大写,不必添加前缀。属性按功能命名成名词或者动词:

//名词属性
@property (strong) NSString *title;

//动词属性
@property (assign) BOOL showsAlpha;

属性也可以命名成形容词,这时候通常会指定一个带有 is 前缀的get方法来提高可读性:

@property (assign, getter=isEditable) BOOL editable;

命名实例变量,在变量名前加上 _ 前缀,其它和命名属性一样:

@implementation MyClass{
    BOOL _showsTitle;
}

一般来说,类需要对使用者隐藏数据存储的细节,所以不要将实例方法定义成公共可访问的接口,可以使用 @private@protected 前缀。

2.11 命名常量(Constants)

如果要定义一组相关的常量,尽量使用枚举类型(enumerations),枚举类型的命名规则和函数的命名规则相同。

建议使用 NS_ENUMNS_OPTIONS 宏来定义枚举类型,参见官方的 Adopting Modern Objective-C 一文:

// 定义一个枚举
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 定义浮点型或者单个的整数型常量,如果要定义一组相关的整数常量,应该优先使用枚举。常量的命名规范和函数相同:

const float NSLightGray;

不要使用 #define 宏来定义常量,如果是整型常量,尽量使用枚举,浮点型常量,使用 const 定义。 #define 通常用来给编译器决定是否编译某块代码,比如常用的:

#ifdef DEBUG

注意到一般由编译器定义的宏会在前后都有一个 __ ,比如 __MACH__

2.12 命名通知(Notifications)

通知常用于在模块间传递消息,所以通知要尽可能地表示出发生的事件,通知的命名范式是:

[触发通知的类名] + [Did | Will] + [动作] + Notification

Example:

NSApplicationDidBecomeActiveNotification
NSWindowDidMiniaturizeNotification
NSTextViewDidChangeSelectionNotification
NSColorPanelColorDidChangeNotification

三、注释

读没有注释代码的痛苦你我都体会过,好的注释不仅能让人轻松读懂你的程序,还能提升代码的逼格。注意注释是为了让别人看懂,而不是仅仅你自己。

3.1 文件注释

每一个文件都 必须 写文件注释,简单描述文件的内容和作用

//
// CListViewController.h
// BCRM-iOS
//
// Created by xiao on 2017/3/3.
// Copyright © 2017年 xiao. All rights reserved.
//

/**
 *  渠道商列表页
 */
#import "BaseViewController.h"

@interface CListViewController:BaseViewController

@end

文件注释的格式通常不作要求,能清晰易读就可以了,但在整个工程中风格要统一。

3.2 代码注释

好的代码应该是“自解释”(self-documenting)的,但仍然需要详细的注释来说明参数的意义、返回值、功能以及可能的副作用。

方法、函数、类、协议、类别的定义都需要注释,推荐采用Apple的标准注释风格,好处是可以在引用的地方 alt+点击 自动弹出注释,非常方便。

Xcode快捷方式:Option + Command + /,可以自动生成Apple标准风格的注释

一些良好的注释:

/**
 空数据占位图即将出现

 @param scrollView 空数据占位图关联的scrollView
 */
- (void)emptyDataSetWillAppear:(UIScrollView *)scrollView;

/**
 结束刷新
 */
- (void)endRefreshing;

定义在头文件里的接口方法、属性必须要有注释!

四、编码风格

每个人都有自己的编码风格,这里总结了一些比较好的Cocoa编程风格和注意点。

4.1 不要使用new方法

尽管很多时候能用 new 代替 alloc init 方法,但这可能会导致调试内存时出现不可预料的问题。Cocoa的规范就是使用 alloc init 方法,使用 new 会让一些读者困惑。

4.2 Public API要尽量简洁

共有接口要设计的简洁,满足核心的功能需求就可以了。不要设计很少会被用到,但是参数极其复杂的API。如果要定义复杂的方法,使用类别或者类扩展。

4.3 #import和#include

#import 是Cocoa中常用的引用头文件的方式,它能自动防止重复引用文件,什么时候使用 #import ,什么时候使用 #include 呢?

  • 当引用的是一个Objective-C或者Objective-C++的头文件时,使用 #import
  • 当引用的是一个C或者C++的头文件时,使用 #include ,这时必须要保证被引用的文件提供了保护域(#define guard)。

Example:

#import <UIKit/UIKit.h>
#include "base/basictypes.h"

为什么不全部使用 #import 呢?主要是为了保证代码在不同平台间共享时不出现问题。

4.4 BOOL的使用

BOOL在Objective-C中被定义为 signed char 类型,这意味着一个BOOL类型的变量不仅仅可以表示 YES (1)和 NO (0)两个值,所以永远 不要 将BOOL类型变量直接和 YES 比较:

// 错误,无法确定|great|的值是否是YES(1),不要将BOOL值直接与YES比较
BOOL great = [foo isGreat];
if (great == YES)
  // ...be great!

//正确
BOOL great = [foo isGreat];
if (great)
  // ...be great!

同样的,也不要将其它类型的值作为BOOL来返回,这种情况下,BOOL变量只会取值的最后一个字节来赋值,这样很可能会取到0(NO)。但是,一些逻辑操作符比如 && , || , ! 的返回是可以直接赋给BOOL的:

// 错误,不要将其它类型转化为BOOL返回
- (BOOL)isBold {
  return [self fontTraits] & NSFontBoldTrait;
}
- (BOOL)isValid {
  return [self stringValue];
}

// 正确
- (BOOL)isBold {
  return ([self fontTraits] & NSFontBoldTrait) ? YES : NO;
}

// 正确,逻辑操作符可以直接转化为BOOL
- (BOOL)isValid {
  return [self stringValue] != nil;
}
- (BOOL)isEnabled {
  return [self isValid] && [self isBold];
}

另外BOOL类型可以和 _Bool , bool 相互转化,但是 不能Boolean 转化。

4.5 在init和dealloc中不要用存取方法访问实例变量

init``dealloc 方法被执行时,类的运行时环境不是处于正常状态的,使用存取方法访问变量可能会导致不可预料的结果,因此应当在这两个方法内直接访问实例变量。

// 正确,直接访问实例变量
- (instancetype)init {
  self = [super init];
  if (self) {
    _bar = [[NSMutableString alloc] init];
  }
  return self;
}
- (void)dealloc {
  [_bar release];
  [super dealloc];
}

// 错误,不要通过存取方法访问
- (instancetype)init {
  self = [super init];
  if (self) {
    self.bar = [NSMutableString string];
  }
  return self;
}
- (void)dealloc {
  self.bar = nil;
  [super dealloc];
}

4.6 按照定义的顺序释放资源

在类或者Controller的生命周期结束时,往往需要做一些扫尾工作,比如释放资源,停止线程等,这些扫尾工作的释放顺序应当与它们的初始化或者定义的顺序保持一致。这样做是为了方便调试时寻找错误,也能防止遗漏。

4.7 保证NSString在赋值时被复制

NSString 非常常用,在它被传递或者赋值时应当保证是以复制(copy)的方式进行的,这样可以防止在不知情的情况下String的值被其它对象修改。

@property (copy,nonatomic) NSString *text;

4.8 使用NSNumber的语法糖

使用带有 @ 符号的语法糖来生成NSNumber对象能使代码更简洁:

NSNumber *fortyTwo = @42;

4.9 nil检查

因为在Objective-C中向nil对象发送命令是不会抛出异常或者导致崩溃的,只是完全的“什么都不干”,所以,只在程序中使用nil来做逻辑上的检查。

另外,不要使用诸如 nil == Object 或者 Object == nil 的形式来判断。

// 正确,直接判断
if (!objc) {
	...	
}

// 错误,不要使用nil == Object的形式
if (nil == objc) {
	...	
}

4.10 属性的线程安全

定义一个属性时,编译器会自动生成线程安全的存取方法(Atomic),但这样会大大降低性能,特别是对于那些需要频繁存取的属性来说,是极大的浪费。所以如果定义的属性不需要线程保护,记得手动添加属性关键字 nonatomic 来取消编译器的优化。

4.11 点语法的使用

不要用点语法来调用方法,只用来访问属性。这样是为了防止代码可读性问题。

//正确,使用点分语法访问属性
NSString *oldName = myObject.name;
myObject.name = @"Alice";

//错误,不要用点分语法调用方法
NSArray *array = [NSArray arrayWithObject:@"hello"];
NSUInteger numberOfItems = array.count;
array.release;

4.12 Delegate要使用弱引用

一个类的Delegate对象通常还引用着类本身,这样很容易造成引用循环的问题,所以类的Delegate属性要设置为弱引用。

@property (nonatomic, weak) id <IPCConnectHandlerDelegate> delegate;
相关帖子
用户评论
开源开发学习小组列表