Objective-C 黑魔法 -- 单例新思路

开发中, 单例模式经常会用到, 代码几乎都是一致的.

+(instancetype)shared {
    static SomeClass* sharedInstance;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        sharedInstance = [SomeClass new];
    });
    return sharedInstance;
}

聪明的同学可能会加入到snippet 中, 快速的构建一个单例.
不过有没有什么更好的方式呢?
当然有. 用黑魔法.
先看看最终效果

singleton(SomeClass, shared)
@interface SomeClass: NSObject
+(instancetype)shared;
@end
@implementation SomeClass
-(NSString *)name {
    return @"some class -- name";
}
@end;
int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSLog([[SomeClass shared] name]);
    }
    return 0;
}

不需要写单列的实现, 只需要写一个单例的函数的声明, 甚至这个函数声明也不需要, 不过没有的话, 调用起来不方便, 例如

singleton(SomeAnotherClass, shared)
@interface SomeAnotherClass: NSObject
@end
@implementation SomeAnotherClass
-(NSString *)name {
    return @"some other class -- name";
}
@end;
int main(int argc, const char * argv[]) {
    @autoreleasepool {
        NSLog([[SomeAnotherClass performSelector:NSSelectorFromString(@"shared")] name]);
    }
    return 0;
}

你可能已经注意到了, 有一个奇怪的东西singleton(SomeClass, shared).
对的, 和你猜想的一样, 这个宏, 对的, 是一个宏, 第一个参数是类名, 第二个参数是单例的方法.
具体实现是这样的

#define __toString(x) #x
#define singleton(class, method) __attribute__((objc_runtime_name(__toString(SGSINGLETON_##class##_##method))))

看不懂没关系, 这相当于在类上面写了这样一个东西

__attribute__((objc_runtime_name("SGSINGLETON_SomeClass_shared")))
@interface SomeClass: NSObject
...

作用很简单, 运行的时候, 会将类名改为 SGSINGLETON_SomeClass_shared
, 你可以参考这篇文章看看具体细节
http://blog.sunnyxx.com/2016/05/14/clang-attributes/.
在这里的作用是给类加上一个标记, 然后我们在运行时扫描所有加载的类, 找到这个标记的类后, 加上一个方法, 这个方法就是我们单例的实现. 是不是很简单.
接下来看看具体的步骤

__attribute__((constructor)) void addSingleton(){
    // 获取所有的类
    int classCount = objc_getClassList(NULL, 0);
    Class *classList = new Class[classCount];
    objc_getClassList(classList, classCount);
    Class singtonClassList[256];
    int singtonClassListIndex = 0;
    for(int i =0; i< classCount; i++) {
        NSString *className = NSStringFromClass(classList[i]);
        // 找到标记过的类
        if([className hasPrefix:@"SGSINGLETON_"]) {
            singtonClassList[singtonClassListIndex++] = classList[i];
        }
    }
    for(int i = 0; i< singtonClassListIndex; i++) {
        Class cls = singtonClassList[i];
        NSString *clsName = NSStringFromClass(cls);
        // 获取元类
        Class metaClass = objc_getMetaClass(clsName.UTF8String);
        // 获取方法名
        NSString *sharedMethodName = [clsName componentsSeparatedByString:@"_"].lastObject;
        SEL sel = NSSelectorFromString(sharedMethodName);
        // 添加方法
        BOOL result = class_addMethod(metaClass, sel, IMP(makeSharedInstance), "@@:");
        if(!result) {
            NSLog(@"f**k");
        }
    }
    delete [] classList;
}

接下来是单例的实现方法, 这个就更加简单了.

id makeSharedInstance(id obj, SEL sel) {
    Class cls = obj;
    // 保存所有单例的字典
    static NSMutableDictionary *instanceMap;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instanceMap = [NSMutableDictionary new];
    });
    NSString *className = NSStringFromClass(obj);
    // 多线程锁
    static NSLock *lock = [NSLock new];
    [lock lock];
    // 获取单例
    id instance = [instanceMap objectForKey:className];
    if(! instance) {
        // 没有初始化则进行初始化
        instance = [[cls alloc] init];
        instanceMap[className] = instance;
        NSLog(@"make instance for %@", className);
    }
    [lock unlock];
    // 返回对应单例
    return instance;
}

创意来自 Sunny 的博客文章--Clang Attributes 黑魔法小记, 觉得很有意思, 勉强实现了一下, 代码写的很垃圾, 欢迎各位大侠留言改进.