《Effective Objective-C 2.0编写高质量iOS与OS X代码的52个方法》要点回顾(三)第三章 接口和API设计

如果决定重用代码,那么我们在编写接口时,就会将其设计成易于复用的形式。这需要用到�Objective-C语言中常见的编程范式,同时还需要了解各种可能碰到的陷阱。

15. 使用前缀避免命名空间冲突

重名符号错误:duplicate symbol error

1). 选用的前缀应该是3个字母的,Apple保留了使用全部2个字母开头的权利。
如:

Apple: NSObject
项目中: WZZObject

2). 总是应该给C函数的命名也应加上前缀。如加上模块名、类名等。若出现问题,方便回溯。

要点总结:
  • 选择与你的公司、应用程序或二者都有关联的名称作为前缀,并在项目所有代码中使用这一前缀。
  • 若自己开发的应用程序用到了第三方库,则应为其中的名称加上前缀。

16. 提供 全能初始化方法

要点总结:
  • 在类中提供一个全能初始化方法,并与文档里指明。其它初始化方法均应调用此方法。
  • 若全能初始化方法 与超类不同,则应覆写超类中对应的方法。
  • 若超类的初始化方法不适用于子类,那么应该覆写这个超类中的方法,并抛出异常

17. 实现description

要想输出更为有用的信息,可以在定义的类中,覆写 description 方法,将描述此对象的字符串返回即可。

- (NSString *)description {
    
    return [NSString stringWithFormat:@"名字%@ _薪水%lu", self.name, (unsigned long)self.salary];
    
}

- (NSString *)debugDescription {
    return [NSString stringWithFormat:@"<%@: %p> 名字%@ _薪水%lu", [self class], self, self.name, (unsigned long)self.salary];
}

//输出:
NSLog: 名字Samara _薪水200
(lldb) po aEmployee
<EOCEmployeeDeveloper: 0x600000226640> 名字Samara _薪水200
要点总结:
  • 实现 description 方法返回一个有意义的字符串,来描述该实例。
  • 若想在调试时打印更详尽的信息,可以实现 debugDescription 方法。

18. 尽量使用不可变对象

//  EOCPerson.h

#import <Foundation/Foundation.h>

@interface EOCPerson : NSObject

@property (nonatomic, copy, readonly) NSString *firstName;

@property (nonatomic, copy, readonly) NSString *lastName;

@property (assign, readonly) NSUInteger age;

@property (nonatomic, strong, readonly) NSSet *friends;


- (id)initWithFirstName:(NSString *)firstName
               lastName:(NSString *)lastName;

@end




- (id)initWithFirstName:(NSString *)firstName
               lastName:(NSString *)lastName {

    if ((self = [super init])) {
        _firstName = firstName;
        _lastName = lastName;
    }
    return self;
}

/***********************/
//  EOCPerson.m

#import "EOCPerson.h"

@interface EOCPerson()

@property (nonatomic, copy, readwrite) NSString *firstName;

@property (nonatomic, copy, readwrite) NSString *lastName;

@end

@implementation EOCPerson {
    NSMutableSet *_mutableSet;
}

- (id)initWithFirstName:(NSString *)firstName
               lastName:(NSString *)lastName {

    if ((self = [super init])) {
        _firstName = firstName;
        _lastName = lastName;
        _mutableSet = [NSMutableSet new];
    }
    return self;
}

- (NSString *)firstName {
    return [_mutableSet copy];
}

- (void)addFriends:(NSSet *)objects {
    [_mutableSet addObject:objects];
}
- (void)removeFriends:(NSSet *)objects {
    if ([_mutableSet containsObject:objects]) {
        [_mutableSet removeObject:objects];
    }
}
@end
要点总结:
  • 尽量创建不可变的对象
  • 若某属性仅可用于对象内部修改,则在 “class-continuation分类” 中将由 readonly 改为 readwrite 属性。(见27条)
  • 不要把可变的collection作为属性公开,而应提供相应方法,以此来修改对象中的可变collection。

注意readonly 可以使用KVC(键值编码)修改这些值;
直接用类型信息查询功能查出属性所对应的实例变量在内存中的偏移量。

19. 使用清晰而协调的命名方式

方法的命名规则总结

  • 如果 方法的返回值新创建的,那么方法的 首个单词 应该是返回值的类型,除非前面还有修饰语,例如 localizedString

    注意,属性的存取方法 不遵循 这种命名方式,因为一般认为这些方法不会创建新对象。即使有时返回内部对象的一份拷贝,我们也认为那相当于原有的对象。这些方法应该按照其所对应的属性来命名。

  • 应该把表示参数类型的名词放 参数 前面。

  • 如果方法要在当前对象上执行操作,那么就应该包含动词;若执行操作时还需要参数,则需要在动词后加入一个或多个名词。

  • 不要使用 str 这种简称,应该使用 string 这样的全称。

  • Boolean 属性应该加上 is 前缀,如果某方法返回非属性的 Boolean 值,应该根据其功能 采用 hasis

如:-(NSString *)hasPrefix:(NSString *)string;
  • get 这个前缀保留给那些借由 “输出参数” 来保存返回值的方法。

    把返回值填充到“C语言数组”(C-style array)里的那种方法就可以使用这个前缀。

要点总结:

  • 起名时应遵循标准的 Objective-C 命名规范,这样创建出来的接口更容易被开发者理解;
  • 方法名言简意赅,从左到右读起来像句子一样才好。
  • 方法里不要使用缩略后的类型名称。
  • 给方法起名时的第一要务就是,确保其风格与自己的代码或所要集成的框架相符。

20. 为私有方法名加上前缀

/** 公开方法 */
- (void)publicMethod {}
/** 私有方法 “p_”开头 */
- (void)p_privateMethod {}
要点总结:
  • 给(.m文件中的)私有方法加上前缀,这样可以很容易的将其同公共方法区分开。
  • 不要单用一个下划线( _ ) 作私有方法的前缀,因为这种方法是预留给苹果公司用的。

21. 理解Objective-C错误模型

/** 定义错误组件 */
//.h
//专用的“错误范围”字符串
extern NSString *const EOCErrorDomain;

//错误码
typedef NS_ENUM(NSUInteger, EOCErrorCode) {
    EOCErrorUnkown                  = -1,
    EOCErrorInternalInconsistency   = 100,
    EOCErrorGeneralFault            = 105,
    EOCErrorBadInput                = 500,
};

//.m
NSString *const EOCErrorDomain = @"EOCErrorDomain";

//例如
- (void)doSomething:(EOCError* *)error;
要点总结:
  • 只有发生了可使整个应用程序发生崩溃时,才应使用 异常 NSException。抛出异常如下
@throw [NSException exceptionWithName:@"Error" reason:@"can not init" userInfo:nil];
  • 在错误不那么严重的情况下,可以采用 “委托方法” (delegate method) 来处理错误,也可以把错误信息放在 NSError 对象里,经由 “输出参数” 反给回调者。

22. 理解 NSCopying 协议

要点总结

需求是:使用对象时经常需要拷贝它。

  • 若想令自己的所写对象具有拷贝功能,则需实现 NSCopying 协议。
//浅拷贝
- (id)copyWithZone:(NSZone *)zone {
    
    EOCPerson *copy = [[[self class] allocWithZone:zone] initWithFirstName:_firstName lastName:_lastName];
    copy->_mutableSet = [_friends mutableCopy];
    return copy;
}

  • 如果自定义的对象分为可变版本不可变版本,需要同时实现 NSCopyingNSMutableCopying 协议。
  • 复制对象时要采用浅拷贝还是深拷贝,一般情况下应该尽量执行浅拷贝
  • 如果你所写的对象需要执行深拷贝,那么考虑新增一个专门执行深拷贝的方法。
//执行深拷贝
- (id)deepCopy {
    
    EOCPerson *copy = [[[self class] alloc] initWithFirstName:_firstName lastName:_lastName];
    
    copy->_mutableSet = [[NSMutableSet alloc] initWithSet:_friends copyItems:YES];
    
    return copy;
}

系列文章

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

推荐阅读更多精彩内容