iOS 详解swizzle 在数组、字典、字符串中的应用

简单说下写这篇简书的目的吧，swizzle 对iOS开发者并不陌生，网上也有很多资料。但是我浏览一些文章，多数都是写的不全。为什么不全，一是swizzle 在实现方法交换时不够严谨，二是，对数组、字典添加安全防护时也不全面，里面还是有很多细节的。

先上代码：

示例代码地址 提取码：3iy6

一、swizzle 的简单介绍

swizzle又叫黑魔法，它可以在运行时实现两个方法（对象方法或者类方法）的交换。

@implementation Person
- (void)run
{
    NSLog(@"Person -- run");
}
@end
@implementation Student
+ (void)load
{
    [Swizzle swizzleInstanceMethodWithClass:[self class] originlaSelector:@selector(run) swizzleSelector:@selector(goodRun)];
}
- (void)goodRun
{
    NSLog(@"Student --- goodRun");
//    [self goodRun];
}
@end

    Student *student = [Student new];
    [student run];

运行结果

我们可以看到，子类（student）调用父类的方法（run）时，内部调的是子类的方法（goodRun）。

二、swizzle的实现

// 交换某个类的对象方法
+ (void)swizzleInstanceMethodWithClass:(Class)cls originlaSelector:(SEL)originalSelector swizzleSelector:(SEL)swizzleSelector
{
    Method originalMethod = class_getInstanceMethod(cls, originalSelector);
    Method swizzleMethod = class_getInstanceMethod(cls, swizzleSelector);
    
    BOOL isAddMethod = class_addMethod(cls,originalSelector,method_getImplementation(swizzleMethod),method_getTypeEncoding(swizzleMethod));
    if (isAddMethod) {
        class_replaceMethod(cls,swizzleSelector,method_getImplementation(originalMethod),method_getTypeEncoding(originalMethod));
    } else {
        method_exchangeImplementations(originalMethod, swizzleMethod);
    }
}
// 交换某个类的类方法
+ (void)swizzleClassMethodWithClass:(Class)cls originlaSelector:(SEL)originalSelector swizzleSelector:(SEL)swizzleSelector
{
    Class metaClass = object_getClass(cls);
    Method originalMethod = class_getClassMethod(metaClass, originalSelector);
    Method swizzledMethod = class_getClassMethod(metaClass, swizzleSelector);
    
    BOOL isAddMethod = class_addMethod(metaClass,originalSelector,method_getImplementation(swizzledMethod),method_getTypeEncoding(swizzledMethod));
    
    if (isAddMethod) {
        class_replaceMethod(metaClass,swizzleSelector,method_getImplementation(originalMethod),method_getTypeEncoding(originalMethod));
    } else {
        method_exchangeImplementations(originalMethod, swizzledMethod);
    }
    
}

注意点：网上有些资料是不先调用class_addMethod函数的，而是直接调用method_exchangeImplementations就完了

• 现在我们就来讲解下为什么要先调用class_addMethod函数

先结合场景我们看下不这么做的后果是什么：
首先我们先回顾上面简介swizzle写的代码，可以看到在Student类中我先把[slef goodRun]方法注释了，如果不注释[slef goodRun]方法，并且不先执行执行class_addMethod 和里面的判断的话调用[[Person new] run] 是会奔溃的。 这是奔溃的信息

奔溃信息
那么，为什么就会奔溃呢？也就是class_addMethod和判断里面代码的作用是什么了。我们先把步骤解析一下：
1.Person 中的run 方法实现变成 Student中goodRun方法实现，而Student中的goodRun方法除了自己需要添加的功能外还调用Person 中的run方法（这是保证父类的方法功能不影响）。
2.[[Person new] run]方法执行可以解析为两步：一是goodRun方法中自己添加的功能 ，二是Person类中的run方法。问题就是处在第二步，Person类中的run方法已经变成goodRun了，就等于，父类调用了子类的goodRun方法，大家都知道这是不允许的，所以会报方法找不到的错误。
3.[[Student new] run] 方法则是子类调用父类的方法，而父类的run方法实现变成Student 中goodRun方法的实现，同样解析成两步是：一是goodRun中自己添加的功能，二是父类中run方法的功能。子类调用父类的方法这是没问题的。所以[[Student new] run]是不会奔溃的。
这就是奔溃原因的所在。而在开发中实现方法的交换，都是会先加自己需要的功能，最后再调源方法的。比如：我想给数组添加对象时过滤掉nil的对象，以防奔溃，那么你就可以在替换的方法中添加判断，最后一步需要再调用源方法addObject,这样才能保证数组添加对象功能的正常和过滤nil的对象。

class_addMethod：给某个类添加一个方法，添加成功返回YES,否者返回NO
class_replaceMethod：将某个类中的方法替换

那么，怎么来解决这种奔溃问题呢
问题就出现在父类的实例调用自己方法时，调用了子类的方法，所以，解决办法就出来了，我们让父类调用自己的方法时还是调用的自己的方法，而子类调用时，调用的是子类自己重写父类的方法和新增的方法功能。简单来说就是[[Person new] run]是调Person自己的run方法，[[Student new] run] 是调用Student重写父类的run 方法和自己新加的goodRun 方法。

class_addMethod函数和里面判断步骤详解：

• 先调用class_addMethod函数，给Student 类中新增一个名字叫run的方法而实现是用Student新增的goodRun方法的实现，这就等于Student重写了父类的方法，并且这个方法还有我们自己新增的功能
• 再调用class_replaceMethod方法，将我们新增的goodRun方法的实现替换成父类Person中的run方法实现。
  这个时候，Person 类中的run方法还是自己的run方法，而Student中的新增了一个带有父类Person的run方法功能和自己新增的功能，新增的goodRun方法实现是父类Person的run方法实现。
  [[Person new] run]调用是调用自己的run方法，所以没有问题
  [[Student new] run] 方法解析成具体的步骤为：一：调用Studnet 中新增的run方法，二：新增的原来goodRun方法的功能 三：父类中run方法的实现。
  这样就达到了我们既新增了功能，又保证原方法的功能。

用一份伪代码来描述这个过程就很清晰明了了

未新增方法和替换前.jpeg
调用class_addMethod后.jpeg
调用class_replaceMethod函数后.jpeg

三、swizzle在数组等容器类中的应用

对这些容器类做防护时，我们就需要明确对应的类型都是有哪些，还有需要做防护的API都有哪些，只对单个API或者类型不全时，还是没有起到防护的作用，也就失去了这功能的意义了。

1.NSArray:

• 先了解NSArray在不同形式下的类型：
  • alloc后所得到的类为__NSPlaceholderArray
  • 当init为一个空数组后，变成了__NSArray0
  • 如果有且仅有一个元素，那么为__NSSingleObjectArrayI
  • 如果数组大于一个元素，那么为__NSArrayI
• 需要防护的API有哪些：
  • arrayWithObjects:count:
  • objectAtIndex:
  • objectsAtIndexes:
  • arrayWithObjects:count:

2.NSMutableArray:

• 类型：__NSArrayM
• 需要防护的API:
  • objectAtIndex:
  • addObject:
  • removeObjectAtIndex:
  • removeObjectsAtIndexes:
  • removeObjectsInRange:
  • replaceObjectAtIndex:withObject:
  • replaceObjectsAtIndexes:withObjects:
  • replaceObjectsInRange:withObjectsFromArray:
  • insertObject:atIndex:
  • insertObjects:atIndexes:

3.NSDictionary:

• 需要防护的类型：
  • __NSPlaceholderDictionary
  • NSDictionary
• 需要防护的API：
  • dictionaryWithObject:forKey:
  • dictionaryWithObjects:forKeys:

4.NSMutableDictionary:

• 需要防护的类型：
  • __NSDictionaryM
• 需要防护的API：
  • setObject:forKey:
  • setValue:forKey:
  • removeObjectForKey:

5.NSString:

• 需要防护的类型：
  • __NSCFConstantString
• 需要防护的API：
  • characterAtIndex:
  • substringToIndex:
  • substringFromIndex:
  • substringWithRange:
  • stringByReplacingCharactersInRange:withString:
  • stringByAppendingString:

6.NSMutableString:

• 需要防护的类型：
  • ____NSCFString
• 需要防护的API：
  • replaceCharactersInRange:withString:
  • insertString:atIndex:
  • deleteCharactersInRange:

如何得到这些容器类型呢，只要我们多试几种创建和初始化的形式，然后让程序奔溃，从奔溃的信息里面就可以看到对应的类型是什么了。

补充：

对于有些API，比如：NSDictionary的objectForKey:传入的key为nil时不会奔溃，那么我们就不需要防护了。还有一些像 NSMutableDictionary继承至NSDictionary 所以，初始化的那些方法不需要写了，同时removeObjectForKeys: 这种在数组种就做了防护，所以也不需要了。这些API不一定写全了，但在日常开发中基本是够用了，其他不常见的API添不添加也就显的不重要了。

最后在说点其他的东西。
很多人写的swizzle实现是写在load方法中的，至于到底要不要写在load方法中，我觉得还是依据个人项目的需要把。

• 首先，load方法是在程序加载到内存的时候调用，也就是程序启动前系统自动调用，而且只会调用一次。但是，大量的load方法是会影响程序的启动时间，虽然load方法只会调用一次，但却可以手动调用。所以，又出现了在load方法中使用GCD的dispatch_once保证只会交换一次了。
• 个人觉得，功能就应该具备开启和关闭的能力，既然我可以开启防护，那么就应该具备关闭防护的能力。那么在load方法中写，就不合适了
• 既然要具备开启和关闭的能力，那么就需要做好过滤重复开启的操作

结束

除了数组、字典、字符串，还有其他的都可以做防护，比如：NSNotification移除一个不存在的监听者、KVC的设值了一个不存在的key或者keyPath、KVO监听了一个不存在的keyPath，或者移除了一个不存在的keyPath、消息发送中找不到方法的错误等等。如果你将这些都加上防护，那么一定会减少很多奔溃的出现。