Runtime窥探（四）| 应用举例

前言

前半生和后半生的分界线在哪里？此时此刻

远航

1.归档解档

在我们项目中会把一些信息保存到硬盘中（沙盒目录中），也就是我们常说的数据持久化，常见的方式有plist文件、NSKeyedArchiver、SQLite 3、CoreData等等。

我们都知道要做归档解档需要遵循NSCoding协议，并且实现- (void)encodeWithCoder:(NSCoder *)aCoder;和- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder;两个代理方法.

先看下面例子，新建一个Person类，来实现归档解档。

#import 

@interface Person : NSObject
@property (nonatomic, strong) NSString *name;
@property (nonatomic, assign) NSInteger age;
@property (nonatomic, assign) float height;

@end

正常做法：

//归档
- (void)encodeWithCoder:(NSCoder *)aCoder;{
    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeInteger:self.age forKey:@"age"];
    [aCoder encodeFloat:self.height forKey:@"height"];
}

//解档
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder{
    if (self = [super init]) {
       _name = [aDecoder decodeObjectForKey:@"name"];
       _age = [aDecoder decodeIntegerForKey:@"age"];
       _height = [aDecoder decodeFloatForKey:@"_height"];
    }
    return self;
}

实现上面就可以调用进行文件的保存和提取了。

疑问：

1.如果是别的类怎么办？难道每一个类都要写一遍吗
2.如果这个类有N个对象怎么办？难道每一个代理方法中都要粘贴拷贝重复的代码嘛，写大一堆自己都不想看的代码

有没有能够解决上面的问题，让我们的代码简单复用？
当然了，不然我也不会写啊，上面第一个问题可以添加一个NSObject的分类来解决。解档归档其实就是key和value，只有能拿到这两个值就可以实现了，怎么拿到呢？runtime就可以拿到我们的成员变量和属性列表，而kvc就能拿到我们的值，所有我们就通过Runtime和KVC就可以实现简单的解档归档。

改进做法：

新建NSObject分类

#import "NSObject+encode.h"
#import 

@implementation NSObject (encode)

//归档
- (void)encodeObjectWithCoder:(NSCoder *)aCoder{
    unsigned int count = 0;
    Ivar *ivars = class_copyIvarList([self class], &count);
    
    for (int i = 0; i < count; i++) {
        Ivar ivar = ivars[i];
        const char *name = ivar_getName(ivar);
        NSString *key = [NSString stringWithUTF8String:name];
        //kvc取出属性值，归档
        [aCoder encodeObject:[self valueForKey:key] forKey:key];
    }
    free(ivars);
}

//解档
- (void)decodeObjectCoder:(NSCoder *)aDecoder{
    unsigned int count = 0;
    Ivar *ivars = class_copyIvarList([self class], &count);
    for (int i = 0; i < count; i++) {
        Ivar ivar = ivars[i];
        const char *name = ivar_getName(ivar);
        NSString *key = [NSString stringWithUTF8String:name];
        //kvc取出属性值，解档
        id value = [aDecoder decodeObjectForKey:key];
        //设置到成员变量身上
        [self setValue:value forKey:key];
    }
    free(ivars);
}

@end

这样我们的Person类或者其他类就可以直接调用了

#pragma mark -解档归档

- (void)encodeWithCoder:(NSCoder *)aCoder;{
    [self encodeObjectWithCoder:aCoder];
}
- (nullable instancetype)initWithCoder:(NSCoder *)aDecoder{
    if (self = [super init]) {
        [self decodeObjectCoder:aDecoder];
    }
    return self;
}

2.关联值

我们项目中，经常会点击一个图片或者一段文字实现一个跳转或者触发一个事件，同时有可能点击需要传递参数，但是UIImageView或者UILabel等到没有自带的点击事件，也没有这种参数属性。我们怎么方便的实现这种功能方便开发和复用？
所有的组件基本上都继承于UIView，所以我们给UIView添加一个分类来实现，但是给UIView添加一个点击手势的属性和参数属性，我们知道不能给分类添加属性（为什么不能添加属性或者成员变量这里不做解释）所以使用Runtime的关联值来实现给分类添加属性。

核心方法：

OBJC_EXPORT void
objc_setAssociatedObject(id _Nonnull object, const void * _Nonnull key,
                         id _Nullable value, objc_AssociationPolicy policy);
OBJC_EXPORT id _Nullable
objc_getAssociatedObject(id _Nonnull object, const void * _Nonnull key);

UIView的分类

UIView+JYEvent.h文件


/*
 * 给不能响应touch事件的View添加点击或者长按事件(如UIView,UIImageView,UILabel...)
 */

#import 

typedef void (^ActionBlock)(NSDictionary *param);

@interface UIView (JYEvent)

//如果需要传参，请给param赋值
@property(nonatomic, copy) NSDictionary *param;

//添加tap手势
- (void)addTapActionWithBlock:(ActionBlock)tapBlock;
//移除所有tap手势
- (void)removeAllTapGesture;


@end

UIView+JYEvent.m文件

#import "UIView+JYEvent.h"
#import 

@interface UIView ()
@property (nonatomic, copy) ActionBlock tapBlock;
@property(nonatomic, strong, readonly) UITapGestureRecognizer *tapGestureRecognizer;

@property (nonatomic, copy) ActionBlock longPressBlock;
@property(nonatomic, strong, readonly) UILongPressGestureRecognizer *longPressGestureRecognizer;

@end


@implementation UIView (JYEvent)

//setter方法
- (void)setParam:(NSDictionary *)param{
    objc_setAssociatedObject(self, _cmd, param, OBJC_ASSOCIATION_COPY_NONATOMIC);
}
//getter方法
- (NSDictionary *)param{
    return objc_getAssociatedObject(self, @selector(setParam:));
}

#pragma mark - ---------------tap手势---------------
//setter方法
- (void)setTapBlock:(ActionBlock)tapBlock{
    objc_setAssociatedObject(self, _cmd, tapBlock, OBJC_ASSOCIATION_COPY_NONATOMIC);
}
//getter方法
- (ActionBlock)tapBlock{
    return objc_getAssociatedObject(self, @selector(setTapBlock:));
}


- (UITapGestureRecognizer *)tapGestureRecognizer{
    UITapGestureRecognizer *tapGestureRecognizer = objc_getAssociatedObject(self, _cmd);
    if (!tapGestureRecognizer) {
        tapGestureRecognizer = [[UITapGestureRecognizer alloc] initWithTarget:self action:@selector(handleTapGesture:)];
        objc_setAssociatedObject(self, _cmd, tapGestureRecognizer, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
    }
    return tapGestureRecognizer;
}


- (void)handleTapGesture:(UIGestureRecognizer *)ges{
    if (self.tapBlock) {
        self.tapBlock(self.param);
    }
}

//开启event点击事件
- (void)enableTapEvent{
    self.userInteractionEnabled = YES;
    [self addGestureRecognizer:self.tapGestureRecognizer];
}

- (void)addTapActionWithBlock:(ActionBlock)tapBlock{
    self.tapBlock = tapBlock;
    [self enableTapEvent];
}

//移除所有tap手势
- (void)removeAllTapGesture{
    [[self gestureRecognizers] enumerateObjectsUsingBlock:^(id obj, NSUInteger idx, BOOL *stop) {
        if ([obj isKindOfClass:[UIGestureRecognizer class]]) {
            UIGestureRecognizer *recognizer = (UIGestureRecognizer *) obj;
            [self removeGestureRecognizer:recognizer];
        }
    }];
}

@end

这样我们就可以很方便的使用了：

//调用
//给imageView添加点击事件
imageView.param = @{@"param":@"这是参数"};
[imageView addTapActionWithBlock:^(NSDictionary *param) {
    NSLog(@"你点击了imageView,param = %@",param);
    //自定义处理事件
}];

3.方法交换

通过runtime的method_exchangeImplementations(Method m1, Method m2)方法可以交换我们的方法，
这就传说中的runtime黑魔法。

我们可以使用方法交换来做很多事情，只要合理使用能达到很好的效果。

实际应用：项目中我们有很多控制器，当我们开发调试的时候进入一个控制器，我们要修改这个控制器，但是我们不知道这个控制器的名称叫什么，得花费很多时间来查找。

正常做法：我们可以有一个BaseController.后面的VC都集成Base，在ViewWillAppear里打印出控制器的名称。但是这种做法耦合性比较高。我们现在用Runtime来实现这种面向切面的编程。

新建VC的分类：UIViewController+JYVCName.h


#import "UIViewController+JYVCName.h"
#import 

@implementation UIViewController (JYVCName)

+ (void)load{
#ifdef DEBUG
    Class class = [self class];
    SEL originalSelector = @selector(viewWillAppear:);
    SEL swizzledSelector = @selector(infoViewWillAppear:);
    
    //交换方法应该被保证，在程序中只会执行一次
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        //两个方法的method
        Method originMethod = class_getInstanceMethod(className, originalSelector);
        Method exchangeMethod = class_getInstanceMethod(className, swizzledSelector);
        
        //首先动态添加方法，实现被替换的方法，返回值表示添加成功还是失败
        BOOL isAdd = class_addMethod(className, originalSelector, method_getImplementation(exchangeMethod), method_getTypeEncoding(exchangeMethod));
        
        if (isAdd) {
            //如果成功，说明类中不存在替换的方法的实现，如果调用直接就会crash，
            //不存在，就把我们被替换的方法的实现来替换到这个不存在的原方法的实现
            class_replaceMethod(className, swizzledSelector, method_getImplementation(originMethod), method_getTypeEncoding(exchangeMethod));
        }else{
            //不成功，说明替换方法是实现的，交换两个方法的实现
            method_exchangeImplementations(originMethod, exchangeMethod);
        }
    });
#endif
}

- (void)infoViewWillAppear:(BOOL)animated {
    
    NSString *className = NSStringFromClass([self class]);
    NSLog(@"当前VCName = %@ ",className);

    [self infoViewWillAppear:animated];
}

@end

这个我们系统的方法viewWillAppear就会被替换成infoViewWillAppear,当我们VC调用viewWillAppear实际上是走的infoViewWillAppear，先打印出VC的信息。然后在调用infoViewWillAppear方法，这个方法被替换成系统的viewWillAppear方法，所有并不会死循环。
为什么要在+ (void)load方法中实现交换？load是只要类所在文件被引用就会被调用，调用时机比较早，当我们启动App时，如果这个类被使用了，那么load方法会被优先调用，方法只会被调用一次。所有我们在这个方法中交换我们的方法。

后面我们不用关心随心使用了，就可以简单的实现我们的功能，代码入侵？不存在的。

上面只是简单的介绍了常用的用法，还有很多使用，就不一一列举了。Runtime在我们平时开发中作用是很大的，优秀的开源库很多都使用runtime的知识点：如MJExtension的模型开源库；Aspect优秀的面向切面编程的开源库；系统的KVO机制等等，后面博客再一一讲解Runtime在这些库中的应用吧。

Runtime窥探 （四）| 应用举例

前言