iOS - Runtime 学习

一、前言

  在维护一个项目时碰见一个问题,调用了一个方法后不起作用,这种问题一般有两个解决思路,一个是看方法有没有起作用,另一个是看是不是其他的方法打断了这个方法,比如设置 UIButton 的隐藏,但在另一个地方,又把它设置成显示了。这种问题在工程里通过调试代码一般都很好解决。
  但是当它发生在我调用了一个 SDK 方法不起作用时,按照上文的思路,一查看是否是 SDK 方法的问题,这个除了向 SDK 提供人员反应没有其他更好的解决方法了,二是查看是否其他地方也调用了这个方法,使用了不同的参数导致本次的调用失效了。如果这个方法调用的少,可以全局搜索,然后注释掉方法,但是如果之前项目不是你开发的,你只是后期切入进来,同时代码结构一时半会还不能很好把握到,总之想快速利落的排除问题,这时你可以考虑用 Runtime 的特性,把 SDK 里的方法用自己写的替换掉。
  先老调重弹一遍,什么是 Runtime?   

二、概念

  Objective-C是动态语言,它将很多静态语言在编译和链接时做的事放到了运行时,这个运行时系统就是 Runtime。
Runtime 其实就是一个库,它基本上是用 C 和汇编写的一套 API,这个库使C语言有了面向对象的能力。
静态语言:在编译的时候会决定调用哪个函数。
动态语言(OC):在运行的时候根据函数的名称找到对应的函数来调用。

  然后还有一些需要了解的基本概念:

  • isa:OC 中,类和类的实例在本质上没有区别,都是对象,任何对象都有isa 指针,它指向类或元类。
  • SEL:SEL(又叫选择器)是方法的 selector 的指针。方法的 selector 表示运行时方法的名字。OC在编译时,会依据每一个方法的名字、参数,生成一个唯一的整型标识(Int类型的地址),这个标识就是 SEL。
  • IMP:IMP 是一个函数指针,指向方法最终实现的首地址。SEL 就是为了查找方法的最终实现IMP。
  • Method:用于表示类定义中的方法,它的结构体中包含一个 SEL 和 IMP,相当于在 SEL 和 IMP 之间作了一个映射。
  • 消息机制:任何方法的调用本质就是发送一个消息。编译器会将消息表达式[receiver message]转化为一个消息函数 objc_msgSend(receiver, selector)。
  • Runtime 的使用:获取属性列表,获取成员变量列表,获得方法列表,获取协议列表,方法交换(黑魔法),动态的添加方法,调用私有方法,为分类添加属性。

三、应用场景

  • 关联对象(Objective-C Associated Objects)给分类增加属性
  • 方法交换 / 黑魔法(Method Swizzling)
  • 实现 NSCoding 的自动归档和自动解档
  • 实现字典和模型的自动转换(MJExtension)

  这里介绍前两种。   

1、关联对象(Objective-C Associated Objects)给分类增加属性

我们都是知道分类是不能自定义属性和变量的。下面通过关联对象实现给分类添加属性。

关联对象 Runtime提 供了下面几个接口:

Objective-C
1
2
3
4
5
6
7
8
9
10
11
12
// 关联对象
void objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)
// 获取关联的对象
id objc_getAssociatedObject(id object, const void *key)
// 移除关联的对象
void objc_removeAssociatedObjects(id object)

// 参数解释
// id object:被关联的对象
// const void *key:关联的 key,要求唯一
// id value:关联的对象
// objc_AssociationPolicy policy:内存管理的策略

例子:

Objective-C
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
///-----------------------
/// NSObject+BRModel.h
///-----------------------
#import <Foundation/Foundation.h>

@interface NSObject (BRModel)
/** 1.获取类的属性列表数组 */
+ (NSArray *)br_objectProperties;

/** 2.字典转模型:给定一个字典,返回 self 类对应的模型对象 */
+ (instancetype)br_objectWithDictionary:(NSDictionary *)dict;

@end

///-----------------------
/// NSObject+BRModel.m
///-----------------------
#import "NSObject+BRModel.h"
#import <objc/runtime.h>

const char *kPropertyListKey = "kPropertyListKey";

@implementation NSObject (BRModel)

/// 所有字典转模型框架的核心算法(这里只是实现简单的字典转模型。扩展:要考虑字典的嵌套)
/// 在字典转模型框架中,如果字典嵌套层次结构非常深,框架由于利用递归实现转换,内存消耗大,执行性能不好!
/// YYModel 因为功能简单(在功能上做了取舍,满足大多数情况下使用),所以速度快!

// 1.动态(通过 Runtime 形式)获取类的属性列表
+ (NSArray *)br_objectProperties {
/// 1.利用“关联对象”获取属性的值,如果有,直接返回!(这里获取对象类似于懒加载,只不过分类里面不能创建属性,用“关联对象”来替代)
/// 这里使用“关联对象”其目的是提高效率(懒加载思想)!
/**
* 获取关联对象(相当于属性的 getter 方法)
* 参数1:对象
* 参数2:动态添加属性的 key(相当于属性名)
* 返回值:动态添加的“属性值”
*/
NSArray *pList = objc_getAssociatedObject(self, kPropertyListKey);
if (pList != nil) {
return pList;
}

/**
* 调用运行时方法,获取类的属性列表
* class_copyPropertyList(): 获取类的 属性 列表方法
* class_copyIvarList(): 获取类的 成员变量 列表方法
* class_copyMethodList(): 获取类的 方法 列表方法
* class_copyProtocolList(): 获取类的 协议 列表方法
* 参数1:要获取的类
* 参数2:类属性的个数指针(&属性个数)
* 返回值:所有属性的数组
*/
unsigned int count = 0;
// 获取属性数组(这里 objc_property_t 接收的是数组,需要带 *)
objc_property_t *properties = class_copyPropertyList([self class], &count);
NSMutableArray *propertyNameArr = [[NSMutableArray alloc]init];
// 遍历属性数组
for (unsigned int i = 0; i < count; i++) {
// 1> 获取属性(C 语言中的结构体指针,通常不需要带 *)
objc_property_t property = properties[i];
// 2> 从 property 中获取属性的名称(即C语言字符串)
const char *cName = property_getName(property);
// 将C语言字符串转成 OC 字符串
NSString *name = [NSString stringWithCString:cName encoding:NSUTF8StringEncoding];
// 3> 添加 OC 属性名到数组
[propertyNameArr addObject:name];
}
// 释放数组(C 语言中用到了包含 create/copy/...的方法,都需要释放内存)
free(properties);

/**
* 2.利用“关联对象”保存属性的值
* 参数1:self 对象
* 参数2:动态添加属性的 key(相当于属性名)
* 参数3:动态添加属性的值
* 参数4:对象的引用关系(类似于属性中的 nonatomic,assign/copy/retain)
*/
objc_setAssociatedObject(self, kPropertyListKey, [propertyNameArr copy], OBJC_ASSOCIATION_RETAIN_NONATOMIC);

return [propertyNameArr copy];
}

// 2.字典转模型:给定一个字典,返回 self 类对应的模型对象
+ (instancetype)br_objectWithDictionary:(NSDictionary *)dict {
id object = [[self alloc]init];
// 获取当前对象的属性列表
// 优化:使用关联对象 pList 的值保存起来,不用每次都去获取
NSArray *pList = [self br_objectProperties];
// 1> 遍历属性数组
[pList enumerateObjectsUsingBlock:^(id _Nonnull pName, NSUInteger idx, BOOL * _Nonnull stop) {
id pValue = [dict objectForKey:pName];
// 使用 KVC 给对象属性赋值
[object setValue:pValue forKey:pName];
}];
/*
// 2> 遍历字典
[dict enumerateKeysAndObjectsUsingBlock:^(id _Nonnull key, id _Nonnull value, BOOL * _Nonnull stop) {
if ([pList containsObject:key]) {
// 使用KVC给对象属性赋值
[object setValue:value forKey:key];
}
}];
*/
return object;
}

@end

2、方法交换(黑魔法)

下面就是 runtime 的重头戏了,被称作黑魔法的方法交换 Swizzling。交换方法是在 method_exchangeImplementations 里发生的。

使用 Swizzling 的过程中要注意两个问题:

Swizzling 要在 +load 方法中执行

运行时会自动调用每个类的两个方法,+load 与 +initialize。

+load 会在 main 函数之前调用,并且一定会调用。

+initialize 是在第一次调用类方法或实例方法之前被调用,有可能一直不被调用。

一般使用 Swizzling 是为了影响全局,所以为了方法交换一定成功,Swizzling 要放在 +load 中执行。

Swizzling 要在 dispatch_once 中执行

Swzzling 是为了影响全局,所以只让它执行一次就可以了,所以要放在 dispatch_once 中。

例子:

Objective-C
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
///-----------------------
/// UIImageView+BRAdd.h
///-----------------------
#import <UIKit/UIKit.h>

@interface UIImageView (BRAdd)
- (void)br_setImage:(UIImage *)image;
@end

///-----------------------
/// UIImageView+BRAdd.m
///-----------------------
#import "UIImageView+BRAdd.h"
#import <objc/runtime.h>

@implementation UIImageView (BRAdd)
/**
* load 方法 会在类第一次加载的时候(类被加载到运行时的时候)被调用
* 调用的时间比较靠前,适合在这个方法里做方法交换
*/
+ (void)load {
// 方法交换应该被保证,在程序中只会执行一次
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 1.获取 UIImageView 类的实例方法 setImage:
Method originalMethod = class_getInstanceMethod([self class], @selector(setImage:));
// 2.获取 UIImageView 类的实例方法 br_setImage: (这个方法本身定义在分类中,所以能获取到)
Method swizzledMethod = class_getInstanceMethod([self class], @selector(br_setImage:));
// 3.交换方法 setImage: 和 br_setImage:
method_exchangeImplementations(originalMethod, swizzledMethod);
});
}

// 当在其它位置调用 setImage: 方法时,就会自动调用 br_setImage: 方法
- (void)br_setImage:(UIImage *)image {
NSLog(@"%s", __FUNCTION__);

// 在这里我们可以添加自己想添加的内容...
// 调整图片大小:生成一张和 imageView 一样大的图片
UIImage *newImage = [self newImage:image size:self.bounds.size];

// 调用系统默认的 setImage:方法
/**
* 注意:交换了方法(互换身份),这时候调用自己,看起来像是死循环,但是其实自己的实现已经被替换了
* 调用系统的 setImage:方法时,会执行 br_setImage:方法
* 调用 br_setImage:方法时,会执行系统的 setImage:方法(要注意区分!)
*/
[self br_setImage:newImage];
}

// 重新生成指定大小的图片
- (UIImage *)newImage:(UIImage *)image size:(CGSize)size {
UIGraphicsBeginImageContextWithOptions(size, YES, 0);
// 重新绘制图片
[image drawInRect:CGRectMake(0, 0, size.width, size.height)];
// 取得结果
UIImage *newImage = UIGraphicsGetImageFromCurrentImageContext();
// 关闭上下文
UIGraphicsEndImageContext();
return newImage;
}
@end


// 扩展:方法交换还有不少应用场景,比如记录页面被点开的次数:只要在 UIViewController 的分类的 +load 中交换 viewDidAppear 方法,在交换的方法中添加记录代码就可以了。

------本文结束 感谢阅读------

本文地址:http://kaaaaai.cn/articles/iOS-runtime-study.html
本文基于 知识共享署名-相同方式共享 4.0 国际许可协议发布
转载请注明出处,谢谢!

众筹项目:拯救世界!
0%