runtime+category黑科技（动态添加属性、动态获取属性列表、方法交换）

下所有内容均为个人观点，转载请注明出处<简书--小蜗牛吱呀之悠悠 >，谢谢！

最近工作中出现较多的数组越界、插入空对象、字典插入空键值对方面的问题，由于涉及范围广，如果一处一处寻找解决，非常耗费人力，于是使用runtime并结合category，通过方法替换来规避解决。使用过程中遇到不少问题，也许读者您也存在同样的问题，为方便查阅，故写下这篇博客，若有不恰当之处敬请留言指导，不胜感激！本文主要介绍runtime的用法，将会从下面三方面详细介绍：动态绑定属性、动态获取属性列表、动态交换方法

注意：此文涉及category及runtime用法，如果对这两模块未接触过，请自行百度有所熟悉后再阅读此文，以便您能更好的理解用法。

一、category、运行时简述

1、众所周知，category可以为各种类扩充能力集；有时，简单的静态运行方法和变量无法满足实际的需要，于是，你将会使用到runtime，同时结合category的特性，解决一些繁琐的、耗费人力的工作。
2、runtime（运行时）是OC语言的三大特性之一，指变量、方法、对象等的类型需要在运行时才会确定，由此衍生出很多面试题（感兴趣的同学请自行翻阅）。

二、runtime+category之动态绑定属性

1、大家应该都了解，category是不允许使用声明式属性的，原因也比较简单。声明式属性通常是由系统替开发者完成setter/getter方法的生成，同时绑定实例变量。表面上是比较好的解释了为什么category不能添加声明式属性。请注意此处用词“声明式属性”。然后真实原因是什么呢？真实原因是，类的属性是在编译期就已经确定了，编译器会在编译时，将属性对应的实力变量添加到属性列表中。category是运行时的一种体现，否则也法与runtime结合使用，因此，category需要在运行状态才会确定变量。然而，在运行状态，类的属性列表处于封闭状态，无法改变内部格局，所以，category是无法添加属性的。
2、既然category无法添加属性，那么为何又说动态绑定呢？其实所谓的动态绑定属性，是一种假属性，是你自己完成setter/getter方法，同时完成实力变量的绑定操作。具体代码参考如下：

//1、和普通属性添加一样
@property (nonatomic, assign) BOOL subEnabled;

//2、动态关联属性
static const void *subEnableKey = &subEnableKey;

//手动生成setter/getter方法
- (void)setSubEnabled:(BOOL)subEnable {
    objc_setAssociatedObject(self, subEnableKey, @(subEnable), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
}
- (BOOL)subEnabled {
    return [objc_getAssociatedObject(self, subEnableKey) boolValue];
}

动态绑定属性的操作比较简单，教程也比较多，如果有不理解的，可以再翻阅更加详细的文章，基本格式都如文中所述，可以说是固定格式。如果仅仅是添加一个属性，实际使用意义并不是很大，但是，如果这个属性是系统类所带的，并且这个属性不完全满足你的要求，而且这个属性被项目中大规模的使用，牵一发动全身的情况下，该怎么办呢？答案是：动态绑定属性+动态方法替换。详细的请看下文。

三、runtime+category之动态获取属性列表

为什么要获取属性列表呢，类具体有哪些属性我们不是可以清楚的看到吗？在了解动态获取属性列表之前，请初步了解一下KVC键值对模式。其实，本质上，我们对属性赋值或者是取出属性的值，都是通过setter/getter方法实现的，这一点大家都清楚；但深究下去，setter/getter方法却又是通过KVC的形式去操作实例变量的。那么了解到这里你会发现，很多时候我们需要用到属性对应的key值，比如：数据解析、数据持久化等。而这些方式却都是通过KVC的形式实现的，所以，即便我们清楚的知道了每一个属性是什么，但如果一个一个的通过KVC的形式添加，工作量之大可以想象，这时候就需要用runtime来为我们提高效率了。
言归正传，直接上代码：

//获取属性列表   
/*    
 参数1：要获取的属性列表所在的class类    
 参数2：属性的数量
 */
unsigned int outCount = 0;
    Ivar *varList = class_copyIvarList(self.class, &outCount);
    //通过for循环，遍历每个属性
    for (int i = 0; i<outCount; i++) {
        //Ivar是结构体，包含属性名等
        Ivar  tmpIvar = varList[i];
        //从Ivar结构体中获取属性名字符串
        const char *name = ivar_getName(tmpIvar);
        //获取属性的名称的字符串   c字符串->oc字符串
        NSString *propertyName = [NSString stringWithUTF8String:name];
        //通过KVC模式，获取对应的值
        id obj = [self valueForKey:propertyName];
#warning 用完以后必须释放
        free(varList);
    }

代码注释应该比较清楚，这里不多做赘述。下面请看一下归档解档的具体应用：

//归档操作
- (void)encodeWithCoder:(NSCoder*)aCoder{
    
    //获取属性列表
    unsigned int outCount = 0;
    Ivar *varList = class_copyIvarList(self.class, &outCount);
    //通过for循环，对每个属性进行设置
    for (int i = 0; i<outCount; i++) {
        //Ivar是结构体，包含属性名等
        Ivar  tmpIvar = varList[i];
        //从Ivar结构体中获取属性名字符串
        const char *name = ivar_getName(tmpIvar);
        //获取属性的名称的字符串   c字符串->oc字符串
        NSString *propertyName = [NSString stringWithUTF8String:name];
        //通过KVC模式，获取对应的值
        id obj = [self valueForKey:propertyName];
        [aCoder encodeObject:obj forKey:propertyName];
    }
    free(varList);
}

//解档操作
- (instancetype)initWithCoder:(NSCoder*)aDecoder{
    if (self = [super init]) {
        unsigned int outCount = 0;
        //1.拿属性列表
        Ivar *varList = class_copyIvarList(self.class, &outCount);
        //2.for循环每个属性，获取名字
        for (int i = 0; i<outCount; i++) {
            Ivar tmpIvar = varList[i];
            const char *name = ivar_getName(tmpIvar);
            NSString *propertyName = [NSString stringWithUTF8String:name];
            //3.通过名字用decodeobj获取对应值
            id obj = [aDecoder decodeObjectForKey:propertyName];
            //4.通过setValue forKey进行赋值操作
            [self setValue:obj forKey:propertyName];
        }
        free(varList);
    }
    return self;
}

归解档操作往往在数据本地持久化（保存硬盘、NSUserDefault中的自定义对象保存等）应用较为广泛，如果不适用runtime，则工作量巨大，并且代码非常不优雅，会有大量的垃圾代码。

四、runtime+category之动态交换方法

  runtime结合category可以实现方法体的动态交换，以满足一些特殊需要，例如上文中提到动态绑定属性+动态方法替换

1、某一种应用场景是这样的：一个已经上线的项目，收集到的崩溃日志中，大量体现了数组越界、插入空对象、字典插入空对象等数据不合法的操作导致的崩溃。此时，就需要对数组、字典的操作增加越界保护、非空保护等措施来避免崩溃。然而，项目中使用到数组字典的地方非常的多，并且逻辑应用也比较复杂，完全依靠人工修改，是不可能完成的，并且很容易出错。那么该怎么办呢？
2、要解决上述问题，我们可以采取重写系统方法来完成，但是这种做法风险巨大，一不小心就不给上架。那么就还有另一个更好的措施，既能解决问题，又不影响上架，而且代码很优雅------动态替换系统方法
3、在学习动态替换系统方法之前，我们先梳理一下思路：我们想要对数据做保护，仅仅是希望在操作系统的方法之前，增加一些我们认为合理的判断，只需要保证在执行系统方法之前我们的判断被执行即可。那么，我们就沿着这个思路往下走。
4、要使得所有的数组字典都生效，唯一的快速高效的办法就是借助category。category中需要用到的两个方法我们先一起来学习一下：

+ (void)load;
+ (void)initialize;

这两个方法有什么区别呢？

  • (void)initialize 当类第一次被调用的时候就会调用该方法
  • (void)load 当程序启动的时候就会调用该方法,换句话说,只要程序一启动就会调用load方法,整个程序运行中只会调用一次
    这两个方法的选择非常的关键，选择的不合适将会导致程序运行不起来。我举两个实际的例子，如下：
    例一： 
+ (void)initialize {
    static dispatch_once_t once;
    //替换方法，校验url中是否含有http
    dispatch_once(&once, ^{
        [self swizzleMethods:[UIImageView class] originalSelector:@selector(sd_setImageWithURL:placeholderImage:options:progress:completed:) swizzledSelector:@selector(dd_setImageWithURL:placeholderImage:options:progress:completed:)];
    });
}

sd_setImageWithURL:placeholderImage:options:progress:completed:方法是SDWebImage框架中设置图片的方法。为了降低带宽消耗和安全性考虑，从某个版本开始，部分URL的前缀地址放在APP测拼接，上述方法的作用就是校验是否已经拼接完成。
因为SDWebImge的方法也是一个category中的方法，所以此处使用的是initialize，只要该方法被调用了，就会先去校验。
例二：

+ (void)load {
    static dispatch_once_t once;
    //非空保护
    dispatch_once(&once, ^{
        [self swizzleMethods:NSClassFromString(@"__NSPlaceholderDictionary") originalSelector:@selector(initWithObjects:forKeys:count:) swizzledSelector:@selector(__NSPlaceholderDictionary_initWithObject:forKeys:count:)];
        Class targetClass = NSClassFromString(@"__NSDictionaryI");
        [self swizzleClassMethods:targetClass originalSelector:@selector(dictionaryWithObject:forKey:) swizzledSelector:@selector(__NSDictionaryI_dictionaryWithObject:forKey:)];
        [self swizzleClassMethods:targetClass originalSelector:@selector(dictionaryWithObjects:forKeys:) swizzledSelector:@selector(__NSDictionaryI_dictionaryWithObjects:forKeys:)];
    });
}

由于NSDictionary是系统类，在difinishLaunch方法执行之前就会有部分系统操作会调用到，所以此处使用load方法最为合适。
5、了解完前提内容后，我们来一起看一下如何使用runtime去动态交换方法。

@interface NSObject (Utils)
/*
 *  实例方法交换
 *  带"-"号的方法应该使用这个
 *  originalSelector    原始方法选择器
 *  swizzledSelector    新方法选择器
 */
+ (void)swizzleMethods:(Class)class originalSelector:(SEL)origSel swizzledSelector:(SEL)swizSel;
/*
 *  类方法交换
 *  带"+"号的方法应该使用这个
 *  originalSelector    原始方法选择器
 *  swizzledSelector    新方法选择器
 */
+ (void)swizzleClassMethods:(Class)class originalSelector:(SEL)origSel swizzledSelector:(SEL)swizSel;
@end

@implementation NSObject (Utils)
+ (void)swizzleMethods:(Class)class originalSelector:(SEL)origSel swizzledSelector:(SEL)swizSel {
    Method origMethod = class_getInstanceMethod(class, origSel);
    Method swizMethod = class_getInstanceMethod(class, swizSel);
    BOOL didAddMethod = class_addMethod(class, origSel, method_getImplementation(swizMethod), method_getTypeEncoding(swizMethod));
    if (didAddMethod) {
        class_replaceMethod(class, swizSel, method_getImplementation(origMethod), method_getTypeEncoding(origMethod));
    } else {
        method_exchangeImplementations(origMethod, swizMethod);
    }
}
+ (void)swizzleClassMethods:(Class)class originalSelector:(SEL)origSel swizzledSelector:(SEL)swizSel {
    @autoreleasepool {
        Method origMethod = class_getClassMethod(class, origSel);
        Method swizMethod = class_getClassMethod(class, swizSel);
        method_exchangeImplementations(origMethod, swizMethod);
    }
}
@end

上述方法中，第一个方法用于交换实例方法(带“-”号的方法)，第二个方法用于交换类方法（带“+”号的方法），至于这两个方法的区别，这里不做赘述，有疑问的同学请百度一下。

  • class_getInstanceMethod 获取实例方法的方法体
  • class_getClassMethod 获取类方法的方法体
  • class_addMethod 添加方法，如果方法为实现，则添加成功，返回YES
  • class_replaceMethod 方法替换,覆盖原有方法
  • method_exchangeImplementations 方法体交换
    上述方法的大致意思：获取替换前后方法的方法体，然后互相交换
    注意：互相交换以后，函数名称不变，函数的具体实现互相交换了
    6、替换后的方法体实现
/*__NSPlaceholderDictionary*/
- (instancetype)__NSPlaceholderDictionary_initWithObject:(id *)objects forKeys:(id<NSCopying> *)keys count:(NSUInteger)count {
    for (int i = 0; i < count; i++) {
        if (!objects[i] || !keys[i]) {
            NSArray *syms = [NSThread  callStackSymbols];
            NSAssert(NO, @"字典的key和对象不能为nil，调用者：%@",NSStringFromSelector(_cmd),[syms objectAtIndex:1]);
            return nil;
        }
    }
    return [self __NSPlaceholderDictionary_initWithObject:objects forKeys:keys count:count];
}

此处需要特殊说明一下，替换方法的时候，应该使用NSDictionary的族类，不是直接使用NSDictionary
NSArray:

  • [NSArray alloc] 的族类为__NSPlaceholderArray
  • [[NSArray alloc] init]和@[]的族类为__NSArray0
  • 数组中有一个对象时的族类为__NSSingleObjectArrayI
  • 数组中有多个对象时的族类为__NSArrayI

NSMutableNSArray:

  • 所有的族类为__NSArrayM

NSDictionary:

  • [NSDictionary alloc] 的族类为__NSPlaceholderDictionary
  • 其余情况的族类为__NSDictionaryI

NSMutableNSDictionary:

  • 所有的族类为__NSDictionaryM
特别需要注意：
  • 由于NSMutableNSArray和NSMutableNSDictionary分别是NSArray和NSDictionary的子类，所以一部分方法是直接继承父类的，在替换方法时一定要注意区分，避免造成崩溃
  • 每一种派生类对应的替换方法都需要唯一，并且重新实现一遍，否则会导致方法交换错乱如下
[self swizzleMethods:NSClassFromString(@"__NSArray0") originalSelector:@selector(objectAtIndex:) swizzledSelector:@selector(__NSArray0_objectAtIndex:)];
[self swizzleMethods:NSClassFromString(@"__NSArrayI") originalSelector:@selector(objectAtIndex:) swizzledSelector:@selector(__NSArrayI_objectAtIndex:)];
[self swizzleMethods:NSClassFromString(@"__NSSingleObjectArrayI") originalSelector:@selector(objectAtIndex:) swizzledSelector:@selector(__NSSingleObjectArrayI_objectAtIndex:)];

7、替换后的方法实现距离如下：

/*__NSArray0*/
- (id)__NSArray0_objectAtIndex:(NSUInteger)index {
    if (index >= self.count) {
        NSArray *syms = [NSThread  callStackSymbols];
        NSAssert(NO, @"数组越界了，调用者：%@",NSStringFromSelector(_cmd),[syms objectAtIndex:1]);
        return nil;
    }
    return [self __NSArray0_objectAtIndex:index];
}

想必有不少同学对这两句不理解：

  • [self __NSArray0_objectAtIndex:index]
  • [syms objectAtIndex:1]
    会有疑问，同样是一个方法体中，这里为何用法完全相反？[self __NSArray0_objectAtIndex:index]这样使用难道不会造成死循环吗？答案是否定的。
    要理解这里，我们需要从方法被调用时来看。假设，数组内容如下：
/*__NSArray0*/
NSArray *array = @[@"这是一个数组"];
[array objectAtIndex:0];

当objectAtIndex被调用时，它的方法体其实已经被替换成了我们增加过越界保护的内容了，而__NSArray0_objectAtIndex的方法体才是系统自带的方法体内容，此处比较绕，请大家仔细想明白。当执行到[syms objectAtIndex:1]时，其实也是需要数组越界保护的，所以此处应该调用替换后的方法体，对应的方法名则是原始方法名。执行至[self __NSArray0_objectAtIndex:index]处时，它的方法体已经是系统提供的真正的objectAtIndex的方法体，所以此处并不会造成死循环。

动态绑定属性+动态方法替换

其实只要理解了上述内容，此种用法就很简单了，原理就是将getter或者setter方法的方法体替换为我们自己定义的方法体，这样就实现了对属性的功能扩充

本文至此已经全部结束，希望能够对您有所帮助，后续将尽量补充数组、字典的category文件。感谢您的阅读！
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,240评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,328评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,182评论 0赞 353
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,121评论 1赞 292
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,135评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,093评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,013评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,854评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,295评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2赞 332
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,398评论 5赞 343
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,989评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2赞 352