编写高质量代码的52个有效方法（三）—接口与API设计

image

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

对于做企业应用开发或游戏SDK的开发者来说，静态库、动态库的制作和使用，客户或渠道的SDK的接入和使用是平时工作的一部分。这时、如果能够做到类名及方法名不重复，就可以避免太多的麻烦。冲突的符号文件：

duplicate symbol XXXClass in:
    dir/xxx.o
duplicate symbol XXXClass in:
    dir2/xxx.o

错误原因在于，应用程序中的两份代理都各自实现了名为XXXClass的类，这导致XXClass所对应的类符号和元类符号个定义了两次。解决方法就是：1.倘若可以修改类名是最好不过的了；2.倘若是使用了静态库，则编译静态库时，则需要在Build Phases -> Compile Sources 中去掉改类的.m文件，不将其编译进静态库。

要点：

1. 选择与你的公司、应用程序或二者皆有关联之名称作为类名的前缀，并在所有代码中均使用这一前缀。需要注意的是：Apple宣称其保留使用所有“两字母前缀”的权利，所以你自己选用的前缀应该是三个字母或以上的。
2. 若自己所开发的程序库中用到了第三方库，则应为其中的名称加上前缀。

16.提供全能初始化方法

要点:

1. 在类中提供一个全能初始化方法，并于文档中指明。其他初始化方法均应调用此方法。
2. 若全能初始化方法与超类不同，则需覆写超类中的对应方法。
3. 如果超类中的初始化方法不适用于子类，那么应该覆写这个超类方法，并在其中抛出异常。

实现description方法

关于将对象转成NSDictionary的分类实现:

#import "NSObject+AGExtension.h"
#import <objc/runtime.h>
#import <objc/message.h>

@implementation NSObject (AGExtension)
- (void)ag_enumeratePropertiesUsingBlock:(void (^)(objc_property_t property, BOOL *stop))block {
    Class cls = self.class;
    BOOL stop = NO;
    
    while (!stop && ![cls isEqual:NSObject.class]) {
        unsigned count = 0;
        objc_property_t *properties = class_copyPropertyList(cls, &count);
        
        cls = cls.superclass;
        if (properties == NULL) continue;
        for (unsigned i = 0; i < count; i++) {
            block(properties[i], &stop);
            if (stop) break;
        }
        free(properties);
    }
}
- (NSDictionary*)ag_toDictionary{
    NSMutableDictionary *propertiesInfo = [NSMutableDictionary dictionary];
    [self ag_enumeratePropertiesUsingBlock:^(objc_property_t property, BOOL *stop) {
        NSString *key = @(property_getName(property));
        id value = [self valueForKey:key];
        if (value) {
            propertiesInfo[key] = value;
        }else{
            propertiesInfo[key] = [NSNull null];
        }
    }];
    return propertiesInfo;
}
@end

使用：

#import "NSObject+AGExtension.h"

- (NSString*)description{
   return [[self ag_toDictionary] description];
}

要点：

1. 实现description方法返回一个有意义的字符串，用以描述该实例。我们可以利用运行时先将对象转成NSDictionary对象，再调用NSDictionary的description方法打印出对象的信息。当然，我们直接重写description，打印自定义的信息和格式也是非常好的。
2. 若想在调试时打印出更详尽的对象描述信息，则应实现debugDescription方法。

18.尽量使用不可变对象

对于设置了readonly修饰词的属性，依然可以通过“键值编码”(Key-Value Coding,KVC)技术设置这些属性值，使用“setValue:forKey:”方法来修改。

要点:

1. 尽量创建不可变的对象
2. 若某属性仅可于对象内部修改，则在“class-continuation分类”中将其readonly属性扩展为readwrite属性
3. 不要把不可变的collection作为属性公开，而应提供相关方法，以此修改对象中的可变collection

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

虽然说开发中的命名遵循变量的命名规则就不会有问题，但是、为了能让他人看的明白我们还需要遵循一定的命名规范。一般而言、遵循苹果的命名习惯就好，包括类名、方法名以及协议名。

要点：

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

20.为私有方法加前缀

要点：

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

21.理解Objective-C的错误模型

Java开发中，调用许多方法时编译器都会提示添加异常处理，尤其在读取IO流时异常用到的特别多；而OC开发过程中，我们遇到的更多是错误NSError,异常（@htrow）则较少。

异常通常只用于处理严重错误(fatal eror,致命错误)，那么对其他错误怎么办呢？在出现“不那么严重的错误”(nonfatal error,非致命错误)时，Objective-C语言所用的编程方式为：令方法返回nil/0,或是使用NSError,以表明其中有错误发生。

- (instancetype)init
{
    if (self = [super init]){
        //Initialize instance
    }
}


//网络请求中返回的NSError等等

NSError的用法更加灵活，因为经由此对象，我们可以把导致错误的原因回报给开发者。NSError对象里封装了三条信息：

1. Error domain(错误范围，其类型为字符串)
2. Error code (错误码，其类型为整数)
3. User info (用户信息，其类型为字典)

要点：

1. 只有发生了可使整个应用程序崩溃的严重错误时，才应使用异常；
2. 在错误不那么严重的情况下，可以指派“委托方法”（delegate method）来处理错误，也可以把错误信息放在NSError对象里，经由“输出参数”返回给开发者。

22.理解NSCopying协议

要点：

1. 若想令自己所写的对象具有拷贝功能，则需要实现NSCopying协议
2. 如果自定义的对象分为可变版本与不可变版本，那么就要同时实现NSCopying与NSMutableCopying协议
3. 复制对象时需决定采用浅拷贝还是深拷贝，一般情况下应该尽量执行浅拷贝
4. 如果你所写的对象需要深拷贝，那么可考虑新增一个专门执行深拷贝的方法。

PDF格式的资料来自iOS开发交流群、感觉作者的贡献，对于知识的系统归纳总结很有帮助。
编写高质量代码的52个有效方法
编写高质量代码的52个有效方法（一）—熟悉OC
编写高质量代码的52个有效方法（二）—对象、消息、运行期
编写高质量代码的52个有效方法（三）—接口与API设计
编写高质量代码的52个有效方法（四）—协议与分类
编写高质量代码的52个有效方法（五）—内存管理
编写高质量代码的52个有效方法（六）—块与大中枢派发
编写高质量代码的52个有效方法（七）---系统框架