OC协议的默认实现

Swift 中,定义协议 protocol 时,可以使用 extension 给它的某些方法提供默认实现:

protocol Printable {
    func print()
    func print1()
}
extension Printable {
    func print() {
        print("default print")
    }
}

有了上面的代码,当创建一个遵从 Printable 协议的类或者是结构体时,就能获得 print() 方法。可以在需要的时候重新定义这个方法,如果不重新定义,就会使用这个默认方法。

遗憾的是 Objective-C 并没有提供这样的便利。当我们想为一个协议提供默认实现时,通常会提供一个基类,基类遵从协议并且提供默认实现。如果不想使用默认实现,需继承基类,在子类中重写方法。有没有办法可以像 Swift 那样,在协议声明的地方而不需要继承链,就能简便的提供默认实现呢?

为协议提供默认实现,可以理解为所有遵从协议的类都拥有提前定义的协议方法。Objective-C 强大的运行时可以获得程序中所有的类,可以获得类遵从的协议,还可以为每一个类添加方法。我们可以用一个临时类来实现协议的方法,在所有的类自己的方法全部加载完后,为遵从协议的类添加临时类的默认方法。之所以要在类自己的方法加载完成后,是为了防止类自己的实现被覆盖,当方法已经存在时,class_addMethod 会添加失败,这正是我们希望的。

__attribute__((constructor)) 特性修饰的函数,会在 runtime 加载完所有类之后,main 函数执行之前运行。通过这样一个函数,将满足条件的类加上提供的默认实现。

现在需要一个临时类,来为协议实现默认方法。假设有协议:

@protocol Printable
@optional
- (NSString *)desc;
@end

为协议提供临时类,来提供默认实现:

@interface PrintableTemporaryClass : NSObject 
@end 
@implementation PrintableTemporaryClass
- (NSString *)desc {
            return @"Default desc";
}
@end

上面代码中,print 方法前的部分对所有协议来说都是类似的的,可以定义个宏来简化代码:

#define extensionProtocol(NAME) \
interface NAME ## TemporaryClass : NSObject  \
@end \
@implementation NAME ## TemporaryClass \

此时,临时类的写法会变成下面这样:

@extensionProtocol(Printable)
- (NSString *)desc {
            return @"Default desc";
}
@end

然后通过遍历所有的类,进而遍历类所有的协议,并查找运行时中是否有协议对应的临时类(通过名字关联),如果有,遍历该临时类和元类的所有方法进行添加。关键的 __attribute__((constructor)) 函数如下:

__attribute__((constructor)) static void _append_default_implement_method_to_class() {
    unsigned classCount;
    Class *classes = objc_copyClassList(&classCount);
    //第一层遍历所有的类
    for (int i = 0; i < classCount; i ++) {
        Class class = classes[i];
        Class metaClass = object_getClass(class);
    
        unsigned protocolCount;
        Protocol * __unsafe_unretained *protocols = class_copyProtocolList(class, &protocolCount);
        //第二层遍历类中所有的协议
        for (int j = 0; j < protocolCount; j ++) {
            Protocol *protocol = protocols[j];
            NSString *tempClassName = [NSString stringWithFormat:@"%sTemporaryClass", protocol_getName(protocol)];
            Class tempClass = objc_getClass(tempClassName.UTF8String);
            if (!tempClass) continue;
        
            unsigned methodCount;
            Method *methods = class_copyMethodList(tempClass, &methodCount);
            //第三层遍历临时类的所有方法并添加
            for (int k = 0; k < methodCount; k ++) {
                Method method = methods[k];
                class_addMethod(class, method_getName(method), method_getImplementation(method), method_getTypeEncoding(method));
            }
            free(methods);
        
            Class metaTempClass = object_getClass(tempClass);
            unsigned metaMethodCount;
            Method *metaMethods = class_copyMethodList(metaTempClass, &metaMethodCount);
            //第三层遍历临时类元类的所有方法并添加
            for (int k = 0; k < metaMethodCount; k ++) {
                Method method = metaMethods[k];
                class_addMethod(metaClass, method_getName(method), method_getImplementation(method), method_getTypeEncoding(method));
            }
            free(metaMethods);
        }
        free(protocols);
    }
    free(classes);
}

这样,任何一个遵从 Printable 协议的类,即使没有实现 desc 方法,也具有了 desc 的默认实现。

以上包含了所有为 Objective-C 提供协议默认实现功能的完整代码,核心是 __attribute__((constructor)) 修饰的函数,利用运行时来为类和元类添加方法,还定义了一个简单的宏方便代码书写。如果有别的意见,欢迎与我交流。

Github 地址: https://github.com/Jeffery91/ExtensionProtocol

你可能感兴趣的:(OC协议的默认实现)