iOS中的编程规范

通用的约定

尽可能遵守 Apple 的命名约定,
推荐使用长的、描述性的方法和变量名。

通用约定:

UIButton *shareButton;
不推荐:
UIButton *shareBut;
//常量应该以驼峰法命名,并以相关类名作为前缀。
static const NSTimeInterval ZOCSignInViewControllerFadeOutAnimationDu    
ration = 0.4;
推荐使用常量来代替字符串字面值和数字,
这样能方便复用,而且还可以快速的修改,替换。
常量应该用static来声明为静态常量,而不要用#define,除非它明确的作为一个宏来使用。
static AppName @"最适码"
不推荐:
#define AppName @"最适码"
常量应该以如下方式暴露给外部:
extern NSString *const AppName;
并在实现文件中为它赋值。

方法

 方法名与方法类型 (-/+ 符号)之间应该以空格间隔。
方法段之间也应该以空格间隔。
- (id)viewWithTag:(NSInteger)tag;

字面值

使用字面值来创建不可变的 NSString, NSDictionary, NSArray,
 和 NSNumber 对象。
注意不要将 nil 传进 NSArray 和 NSDictionary 里,因为这样会导致崩溃。
NSDictionary *productManagers = @{@"iPhone" : @"Kate", @"iPad" : @"Kamal", @"Mobile Web" : @"Bill"};
NSNumber *shouldUseLiterals = @YES;
//不要这样
NSDictionary *productManagers = [NSDictionary dictionaryWithObjectsAndKeys: @"Kate", @"iPhone", @"Kamal", @"iPad", @"Bill", @"Mobile Web", nil];
NSNumber *shouldUseLiterals = [NSNumber numberWithBool:YES];

类名应该以三个大写字母作为前缀(双字母前缀为 Apple 的类预留)。
尽管这个规范看起来有些古怪,但是这样做可以减少 Objective-c 没有命名空间所带来的问题。

Initializer 和 dealloc

推荐的代码组织方式是将 dealloc 方法放在实现文件的最前面
(直接在 @synthesize 以及 @dynamic 之后),init 应该跟在 dealloc 方法后面。
如果有多个初始化方法, 指定初始化方法 (designated initializer) 应该放在最前面,
间接初始化方法 (secondary initializer) 跟在后面,
这样更有逻辑性。如今有了 ARC,dealloc 方法几乎不需要实现,
不过把 init 和 dealloc 放在一起可以从视觉上强调它们是一对的。
通常,在 init 方法中做的事情需要在 dealloc 方法中撤销。

init 方法应该是这样的结构:

- (instancetype)init
{
    self = [super init]; // call the designated initializer
    if (self) {
        // Custom initialization
    }
    return self;
}
为什么设置 self 为 [super init] 的返回值,以及中间发生了什么呢?这是一个十分有趣的话题。
我们退一步讲:我们常常写 [[NSObject alloc] init] 这样的代码,从而淡化了 alloc 和 init 的区别。Objective-C 的这个特性叫做 两步创建 。
这意味着申请分配内存和初始化被分离成两步,alloc 和 init。
alloc 负责创建对象,这个过程包括分配足够的内存来保存对象,
写入 isa 指针,初始化引用计数,以及重置所有实例变量。
 init 负责初始化对象,这意味着使对象处于可用状态。
这通常意味着为对象的实例变量赋予合理有用的值。
 alloc 方法将返回一个有效的未初始化的对象实例。
每一个对这个实例发送的消息会被转换成一次 objc_msgSend() 函数的调用,
形参 self 的实参是 alloc 返回的指针;这样 self 在所有方法的作用域内都能够被访问。

按照惯例,为了完成两步创建,新创建的实例第一个被调用的方法将是 init 方法。注意,NSObject 在实现 init 时,只是简单的返回了 self。
关于 init 的约定还有一个重要部分:这个方法可以(并且应该)通过返回 nil 来告诉调用者,初始化失败了;初始化可能会因为各种原因失败,比如一个输入的格式错误了,或者另一个需要的对象初始化失败了。 这样我们就能理解为什么总是需要调用 self = [super init]。如果你的父类说初始化自己的时候失败了,那么你必须假定你正处于一个不稳定的状态,因此在你的实现里不要继续你自己的初始化并且也返回 nil。如果不这样做,你可能会操作一个不可用的对象,它的行为是不可预测的,最终可能会导致你的程序崩溃。
init 方法在被调用的时候可以通过重新给 self 重新赋值来返回另一个实例,而非调用的那个实例。例如类簇,还有一些 Cocoa 类为相等的(不可变的)对象返回同一个实例。

单例

如果可能,请尽量避免使用单例而是依赖注入。 然而,如果一定要用,请使用一个线程安全的模式来创建共享的实例。对于 GCD,用 dispatch_once() 函数就可以咯
+ (instancetype)sharedInstance
{
static id sharedInstance = nil;
static dispatch_once_t onceToken = 0;
dispatch_once(&onceToken, ^{
sharedInstance = [[self alloc] init];
});
return sharedInstance;
}
使用 dispatch_once(),来控制代码同步,取代了原来的约定俗成的用法。
dispatch_once()
的优点是,它更快,而且语法上更干净,因为dispatch_once()的意思就是 “把一些东西执行一次”,就像我们做的一样。 这样同时可以避免 possible and sometimes prolific crashes.
经典的单例对象是:一个设备的GPS以及它的加速度传感器(也称动作感应器)。
虽然单例对象可以子类化,但这种方式能够有用的情况非常少见。
必须有证据表明,给定类的接口趋向于作为单例来使用。
所以,单例通常公开一个sharedInstance的类方法就已经足够了,
没有任何的可写属性需要被暴露出来。

属性

NSString *text;
不要这样 :
 NSString* text;NSString * text;

点符号

当使用 setter getter 方法的时候尽量使用点符号。应该总是用点符号来访问以及设置属性。

view.backgroundColor = [UIColor orangeColor];
[UIApplication sharedApplication].delegate;
不要这样
[view setBackgroundColor:[UIColor orangeColor]];UIApplication.sharedApplication.delegate;

方法

参数断言
 你的方法可能要求一些参数来满足特定的条件(比如不能为nil),
在这种情况下啊最好使用 NSParameterAssert() 来断言条件是否成立或是抛出一个异常。

私有方法

永远不要在你的私有方法前加上 _ 前缀。
这个前缀是 Apple 保留的。不要冒重载苹果的私有方法的险。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,108评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,699评论 1 296
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,812评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,236评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,583评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,739评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,957评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,704评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,447评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,643评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,133评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,486评论 3 256
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,151评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,108评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,889评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,782评论 2 277
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,681评论 2 272

推荐阅读更多精彩内容