《EffectiveObjective-c 2.0》第三章 接口与API设计

第15条:用前缀避免命名空间冲突

  1. 选择与你的公司,应用程序或二者皆有关联之名称作为类名的前缀,并在所有代码中使用这以前缀,包括纯C函数及全局变量。前缀应该以三个大写字母为前缀,用前缀还有一个好处,就是有些app在混淆代码的时候,很方便快捷的混淆自己的iOS代码。
  2. 若自己开发的应用程序需要为其他程序提供插件支持,那么自己的开发的应用程序中使用到的第三方插件也需要修改其前缀。
  3. 此条看到了一个符号表,此表的功能是显示iOS文件的文件名,函数名,行数等。由此找到腾讯的Bugly插件,此插件可以在iOSAPP发布后,如果APP发生crash,或是卡顿等问题,可以及时查看到问题,定位问题很准确,且还有解决方案。
    参考地址Bugly

第16条:提供“全能初始化方法”

  1. 对于提供多个初始化方法的类,应该提供一个全能的初始化方法,其他初始化方法以此方法为基础进行扩展。
    2 在全能初始化方法里进行存储数据等,如果有存储机制改变等原有只需修改全能初始化方法即可。
  2. 若全能初始化方法与超类不同,则需覆写超类中的对应方法。--强调对应的方法,不是乱调用方法。
  3. 如果超类的初始化方法不适用于子类,那么应该覆写这个超类方法,并在其中抛出异常。

第17条:实现description方法

  1. 实现decription方法返回一个有意义的字符串,用以描述该实例。
  2. 若想在调试时打印更详尽的对象描述,则应实现debugDescription方法。

第18条:尽量使用不可变对象

  1. 在公共接口中(.h文件)声明属性的时候,尽量使用不可变对象。
  2. 在公共接口中,集合使用不可变对象时,尽量使用readonly特征修饰,且提供相应的增加移除方法,并重写属性的get方法。

情况一

.h文件

@interface WCCPerson : NSObject
@property (nonatomic, copy) NSString *myName;
@property (nonatomic, copy, readonly)NSArray *friends;

- (instancetype)initWithName:(NSString *)myName;
@end

@interface NSArray (WCCPerson)
- (NSString *)toString;
@end

.m文件

@interface WCCPerson ()
@property (nonatomic, copy, readwrite)NSArray *friends;//将对外的属性中的readonly,改成readwrite
@end

@implementation WCCPerson

- (instancetype)initWithName:(NSString *)myName{
    if (self = [super init]) {
        _myName = [myName copy];
       _friends = @[@"json", @"mike"];
    }
    return self;
}

- (NSArray *)friends{
    return _friends;
}

@end

@implementation NSArray (WCCPerson)
- (NSString *)toString{
    NSMutableString *string = [NSMutableString string];
    for (NSUInteger i = 0; i < [self count]; i++) {
        [string appendFormat:@"array[%lu] value is %@, ", (unsigned long)i, self[i]];
    }
    return [string copy];
}
@end

如果按照上面的写法也是可以的,对象内部操作_friends属性,对象内部对属性进行赋值,只允许外部获取。但这样有一些问题,如果用户使用如下方式,则该写法有些漏洞。

WCCPerson *person = [[WCCPerson alloc] initWithName:@"wencun"];
    NSArray *array = @[@1, @2];
    [person setValue:array forKey:@"friends"];
//    person.friends =
    NSLog(@"%@",person.friends.toString);

//输出
2017-08-18 11:46:09.011585+0800 WCCTestProj[11807:270808] array[0] value is 1, array[1] value is 2,

虽然这样并不合法,但用户一旦这样操作,那么将不可避免。
用户也可能直接用类型信息查询功能查出属性所对应的实例变量在内存布局中的偏移量,以此来认为设置这个实例变量的值。这种也不符合规范。

情况二

.h文件

@interface WCCPerson : NSObject
@property (nonatomic, copy) NSString *myName;
@property (nonatomic, copy, readonly)NSArray *friends;

- (instancetype)initWithName:(NSString *)myName;
- (void)addFriends:(NSArray *)objects;
- (void)removeFriends:(NSArray *)objects;
@end

@interface NSArray (WCCPerson)
- (NSString *)toString;
@end

.m文件

@interface WCCPerson (){
    NSMutableArray *mutableFriends;
}
//@property (nonatomic, copy, readwrite)NSArray *friends;
@end

@implementation WCCPerson

- (instancetype)initWithName:(NSString *)myName{
    if (self = [super init]) {
        _myName = [myName copy];
        mutableFriends = [NSMutableArray new];
    }
    return self;
}

- (void)addFriends:(NSArray *)objects{
    [mutableFriends addObject:objects];
}

- (void)removeFriends:(NSArray *)objects{
    [mutableFriends removeObject:objects];
}

- (NSArray *)friends{
    return [mutableFriends copy];
}
@end

这种写法可以避免使用setValue:forKey:设置后,获取到自己设置的值,因为如果不使用对象提供的方法addFriends:,是获取不到用户自己设置的正确的值的,这种情况就迫使用户使用对象提供的方法来设置值。
也可以减少用户对属性的操作,起到封装属性的作用了。

第19条:使用清晰而协调的命名方式

屏幕快照 2017-08-18 15.13.45.png

第20条:为私有方法名加前缀

  1. 给私有方法的名称加上前缀,这样可以很容易地将其同公共方法区分开
  2. 不要单用一个下划线做私有方法的前缀,因为这种做法是预留给苹果公司的。

第21条:理解Object-C错误模型

  1. 只有发生了可使整个应用程序崩溃的严重错误时,才应使用异常。此时无须考虑恢复的问题,而且应用程序此时也应该退出。也就是说不用再编写“异常安全”代码了。
id someResource = nil;
    if (1) {
        @throw [NSException exceptionWithName:NSInvalidArgumentException reason:@"参数异常" userInfo:@{}];
    }
    [someResource release];
  1. 在错误不那么严重的情况下,可以指派“委托方法”(delegate method)来处理错误,也可以把错误信息放在NSError对象里,经由“输出参数”返回给调用者。
  • 在设计API时,NSError的第一种常见的用法是通过委托协议来传递此错误的,有错误发生时,当前对象会把错误信息经由协议中的某个方法传递给委托对象(delegate)。如下,NSURLConnection在委托协议中NSURLConnectionDelegate中定义了如下方法。
- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error;
  • NSError的另外一种常见的用法是:经由方法的“输出参数”返回给调用者,如下:
    .h文件
    - (BOOL)doSomething:(NSError *__autoreleasing *)error;

    .m文件

- (BOOL)doSomething:(NSError *__autoreleasing *)error{
    NSLog(@"我在这里了doSomething");
    if (error) {
        *error = [NSError errorWithDomain:NSURLErrorKey code:0 userInfo:@{@"error":@"你错啦....."}];
        return NO;
    }
    return YES;
}

使用ARC时,编译器会把方法签名中的NSError **转换成NSError *__autoreleasing *,也就是说,指针所指的对象会在方法执行完毕后自动释放,这个对象必须自动释放,因为该方法的调用者,不能保证他自己会释放掉此方法创建的NSError,所以必须加入autorelase。
当error为nil时,如果不加判断会报错。

第22条:理解NSCopying协议

  1. 若想令自己所写的对象具有拷贝功能,则需要实现NSCopying协议。
  2. 如果自定义的对象分为可变版本和不可变版本,那么就要同时实现NSCopying与NSMutableCopying协议。
  3. 复制对象时需要决定采用深拷贝还是浅拷贝,一般情况下应该尽量执行浅拷贝。
  4. 如果你所写的对象需要深拷贝,那么可考虑新增一个专门执行深拷贝的方法。
    文中一段说:深拷贝的意思是:在拷贝对象自身时,将其底层数据也一并复制过去。Foundation框架中的所有collection类在默认情况下都执行浅拷贝,也就是说,只拷贝容器对象本身,而不复制其中的数据。这样做的主要原因在于,容器内的对象未必都能拷贝,而且调用者也未必想在拷贝容器时一并拷贝其中的每个对象。
    NSMutableArray *element = [[NSMutableArray alloc] initWithObjects:@"1", nil];
    NSMutableArray *mutableArray = [[NSMutableArray alloc] initWithObjects:element, nil];
//此处复制过后,确实指针变成新的了,似乎是产生了一个新对象。
    NSMutableArray *copyMutableArray = [mutableArray mutableCopy];
    NSLog(@"element is %p,mutableArray is %p,copyMutableArray is %p",element, mutableArray, copyMutableArray);
    NSLog(@"element is %@,mutableArray is %@,copyMutableArray is %@",element, mutableArray, copyMutableArray);
//此处复制后,三个变量的值都变了
    [element addObject:@"2"];
    NSLog(@"============");
    NSLog(@"element is %p,mutableArray is %p,copyMutableArray is %p",element, mutableArray, copyMutableArray);
    NSLog(@"element is %@,mutableArray is %@,copyMutableArray is %@",element, mutableArray, copyMutableArray);

输出结果

2017-08-21 11:49:39.730755+0800 WCCTestProj[1678:161529] element is 0x600000443f90,mutableArray is 0x6000004443b0,copyMutableArray is 0x600000443ff0
2017-08-21 11:49:39.730991+0800 WCCTestProj[1678:161529] element is (
    1
),mutableArray is (
        (
        1
    )
),copyMutableArray is (
        (
        1
    )
)
2017-08-21 11:49:39.731094+0800 WCCTestProj[1678:161529] ============
2017-08-21 11:49:39.731186+0800 WCCTestProj[1678:161529] element is 0x600000443f90,mutableArray is 0x6000004443b0,copyMutableArray is 0x600000443ff0
2017-08-21 11:49:39.731402+0800 WCCTestProj[1678:161529] element is (
    1,
    2
),mutableArray is (
        (
        1,
        2
    )
),copyMutableArray is (
        (
        1,
        2
    )
)

参考集合collection的copy和mutableCopy是浅拷贝

点击进入 第四章

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

推荐阅读更多精彩内容