Objective-C Method Swizzling

Method Swizzling 原理
Method Swizzling 是 Objective-C runtime 的一个体现，他可以动态的添加及替换类的方法。首先，我们来看下 Objective-C Method 的数据结构：

typedef struct method_t *Method;
struct method_t {
    SEL name;
    const char *types;
    IMP imp;

    struct SortBySELAddress :
        public std::binary_function<const method_t&,
                                    const method_t&, bool>
    {
        bool operator() (const method_t& lhs,
                         const method_t& rhs)
        { return lhs.name < rhs.name; }
    };
};

其实，他就是 struct method_t 类型的一个指针，在此结构体中定义了三个成员变量及一个函数方法：

• name：表示方法的名称，唯一的标识，方法名只能唯一；
• types：标识方法的参数和返回值类型；
• imp：一个函数指针，指向是方法的实现；
• SortBySELAddress: 从方法名就可以看出，根据方法名的地址的一个排序函数。

Method Swizzling 有什么用
Method Swizzling 可以对 Objective-C 的函数方法进行hook，近而达到埋点，添加方法功能等特性。

Method Sizzling 实践

1. 添加

@implementation UIView (DTUIView)

+ (void)load{
   
   // 实现init 与 dt_addSubview方法的交换
   static dispatch_once_t onceToken;
   dispatch_once(&onceToken, ^{
       SEL org_Selector = @selector(addSubview:);
       SEL dt_Selector  = @selector(dt_addSubview:);

       Method org_method = class_getInstanceMethod([self class], org_Selector);
       Method dt_method  = class_getInstanceMethod([self class], dt_Selector);

       BOOL isAdd = class_addMethod(self, org_Selector, method_getImplementation(dt_method), method_getTypeEncoding(dt_method));
       if (isAdd) {
           class_replaceMethod(self, dt_Selector, method_getImplementation(org_method), method_getTypeEncoding(org_method));
       }else{
           method_exchangeImplementations(org_method, dt_method);
       }
   }); 
}

- (void)dt_addSubview:(UIView *)view{
   [self dt_addSubview:view];
   // do some thing
}

• 通过 Category 的 +(void)load 方法中添加代码，且 load 方法是按照父类--子类--分类的调用顺序调用的，且 laod 方法不会被子类的方法所覆盖掉；
• 主要 swizzling 代码卸载 dispatch_once_t 方法中，防止被多次调用，保证线程安全；
• 先用 class_addMethod 尝试在类方法中添加要操作的方法，然后判断是否类中添加时候成功（类中原先有无操作方法）。添加成功（无操作方法），然后交换函数的实现 imp ；如果添加失败（有该操作方法），直接交换方法实现即可。
• 注意一点在 dt_init 实现里面调用的还是 dt_init，因为 dt_init 实现已被替换，实质被实现的是 init

2.删除
既然我们使用它来 swizzling 方法，那么我们在 swizzling 完后某一时间我们不需要了，要回到原来的实现，这时候我们该怎么做呢？平常可以加个开关来决定是否操作，但是随着代码的累加，业务的增多。这将会变得很乱，管理很难。所以我们必须想到一个好的办法来解决。办法就是通过 runtime 的一个函数 class_copyMethodList ，来遍历出他所有的 Method，我们之前说过一个 Method 就是一个结构体指针，所以内部参数 Imp 和 Method 一一对应的, 我们只需在 swizzling 的时候保存下 Imp，就可以遍历 Method swizzling 回来。

    // 在 swizzling 的过程中记录 swizzling  的 Imp
    static IMP org_imp = NULL;
    static IMP dt_imp = NULL;
    org_imp = method_getImplementation(org_method);
    dt_imp = method_getImplementation(dt_method);
    
    + (void)restore{
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        if (!org_imp || !dt_imp) return;
        
        Method org_method = NULL;
        Method dt_method = NULL;
        unsigned int outCount = 0;
        Method *methodList = class_copyMethodList(self, &outCount);
        for (unsigned int idx = 0; idx < outCount; idx ++) {
            Method method = methodList[idx];
            IMP imp = method_getImplementation(method);
            if (imp == org_imp) {
                org_method = method;
            }
            else if (imp == dt_imp) {
                dt_method = method;
            }
        }
        if (org_method && dt_method) {
            method_exchangeImplementations(org_method, dt_method);
        }
        else if (org_method) {
            method_setImplementation(org_method, org_imp);
        }
        else if (dt_method) {
            method_setImplementation(dt_method, dt_imp);
        }
        //清除
        org_imp = NULL;
        dt_imp = NULL;
    });
}

以上代码就是恢复原来的实现的代码：

1.) restore 改方法需手动调用才可以恢复；
2.）同样使用 dispatch_once_t 方法，确保执行一次。

Method Sizzling 类簇使用

开发中常用的 NSString、NSArray、NSDictionary 其实都是类簇（一组隐藏在公共接口下的私有类），所以对类簇进行 swizzling 时要注意 class 为类簇管理下的那个私有类。例如在开发中常遇到 NSDictionary 用字面量创建时，当 key 或者 value 为 nil 时，程序会 crash。这里我们 swizzling 他的初始化方法将 key 或者 value 为 nil 的情况全部替换为 NSNull 的一个实例，这样不但使程序更加健壮，并且方便了我们开发调试。

@implementation NSDictionary (DTNSDictionary)

+ (void)load{

    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        Class class = [NSClassFromString(@"__NSPlaceholderDictionary") class];
        SEL org_Selector = @selector(initWithObjects:forKeys:count:);
        SEL dt_Selector  = @selector(dt_initWithObjects:forKeys:count:);

        Method org_method = class_getInstanceMethod(class, org_Selector);
        Method dt_method  = class_getInstanceMethod(class, dt_Selector);

        BOOL isAdd = class_addMethod(class, org_Selector, method_getImplementation(dt_method), method_getTypeEncoding(dt_method));
        if (isAdd) {
            class_replaceMethod(class, dt_Selector, method_getImplementation(org_method), method_getTypeEncoding(org_method));
        }else{
            method_exchangeImplementations(org_method, dt_method);
        }

    });

}

- (instancetype)dt_initWithObjects:(const id [])objects forKeys:(const id<NSCopying> [])keys count:(NSUInteger)cnt {
    id newObjects[cnt];
    id newKeys[cnt];
    NSUInteger j = 0;
    for (NSUInteger i = 0; i < cnt; i++) {
        id key = keys[i];
        id obj = objects[i];
        if (!obj) {
            obj = [NSNull null];
        }
        if (!key) {
            key = [NSNull null];
        }

        newKeys[j] = key;
        newObjects[j] = obj;
        j++;
    }
    return [self dt_initWithObjects:newObjects forKeys:newKeys count:j];
}

@end

以上代码 swizzling 的是 NSDictionary 管理下的的一个私有类 __NSPlaceholderDictionary ，而方法为initWithObjects:forKeys:count:，

结语
虽然 swizzling 解决了我们一些难以解决的棘手问题，让我们开发走上了一些捷径，但是我们要严谨的对待使用，做到有设计的使用。毕竟在一些黑魔法被滥用后造成的糟糕的结果是无法估量的。