Runtime 的常规操作
上次简单介绍了 Runtime
的原理,接下来介绍下 Runtime
常用的操作。
1. Method Swizzling 方法交换
首先来介绍一下被称为「黑魔法」的 Method Swizzling 。 Method Swizzling 使我们有办法在程序运行的时候,去修改一个方法的实现。包括原生类(比如 UIKit
中的类)的方法。首先来看下通常的写法:
Method originalMethod = class_getInstanceMethod(class, (originalSelector));
Method swizzledMethod = class_getInstanceMethod(class, (swizzledSelector));
if (!class_addMethod((class),
(originalSelector),
method_getImplementation(swizzledMethod),
method_getTypeEncoding(swizzledMethod))) {
method_exchangeImplementations(originalMethod, swizzledMethod);
} else {
class_replaceMethod((class),
(swizzledSelector),
method_getImplementation(originalMethod),
method_getTypeEncoding(originalMethod));
}
简单描述一下:先获取 originalMethod
和 swizzledMethod
。将 originalMethod
加到想要交换方法的类中(注意此时的 IMP
是 swizzledMethod
的 IMP
),如果加入成功,就用 originalMethod
的 IMP
替换掉 swizzledMethod
的 IMP
;如果加入失败,则直接交换 originalMethod
和 swizzledMethod
的 IMP
。
那么问题来了,为什么不直接用 method_exchangeImplementations
来交换就好?
因为可能会影响父类中的方法。比如我们在一个子类中,去交换一个父类中的方法,而这个方法在子类中没有实现,这个时候父类的方法就指向了子类的实现,当这个方法被调用的时候就会出问题。所以先采取添加方法的方式,如果添加失败,证明子类已经实现了这个方法,直接用 method_exchangeImplementations
来交换;如果添加成功,则说明没有实现这个方法,采取先添加后替换的方式。这样就能保证不影响父类了。
如果每次交换都写这么多就太麻烦了,我们可以定义成一个宏,使用起来更方便。
#define SwizzleMethod(class, originalSelector, swizzledSelector) { \
Method originalMethod = class_getInstanceMethod(class, (originalSelector)); \
Method swizzledMethod = class_getInstanceMethod(class, (swizzledSelector)); \
if (!class_addMethod((class), \
(originalSelector), \
method_getImplementation(swizzledMethod), \
method_getTypeEncoding(swizzledMethod))) { \
method_exchangeImplementations(originalMethod, swizzledMethod); \
} else { \
class_replaceMethod((class), \
(swizzledSelector), \
method_getImplementation(originalMethod), \
method_getTypeEncoding(originalMethod)); \
} \
}
在 +load
中调用:
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SwizzleMethod([self class], @selector(viewWillAppear:), @selector(AA_viewWillAppear:));
});
}
注意:我们要保证方法只会被交换一次。因为
+load
方法原则上只会被调用一次,所以一般将 Method Swizzling 放在+load
方法中执行。但+load
方法也可能被其他类手动调用,这时候就有可能会被交换多次,所以这里用dispatch_once_t
来保证只执行一次。
那么上面的交换操作是否万无一失了呢?还远远不够。
通常情况下上面的交换不会出什么问题,但考虑下面一种场景。(注: ViewController
继承自 UIViewController
)
修改 UIViewController
中的 viewWillAppear:
:
// UIViewController (Swizzling)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SwizzleMethod([self class], @selector(viewWillAppear:), @selector(AA_viewWillAppear:));
});
}
- (void)AA_viewWillAppear:(BOOL)animated {
NSLog(@"UIViewController");
[self AA_viewWillAppear:animated];
}
修改 ViewController
中的 viewWillAppear:
(注: ViewController
没有重写该方法):
// ViewController (Swizzling)
+ (void)load {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
SwizzleMethod([self class], @selector(viewWillAppear:), @selector(BB_viewWillAppear:));
});
}
- (void)BB_viewWillAppear:(BOOL)animated {
NSLog(@"ViewController");
[self BB_viewWillAppear:animated];
}
这里父类和子类同时对 viewWillAppear:
方法进行交换,每次交换都加入一句输出语句。则当 ViewController
调用 viewWillAppear:
时,我们期望输出下面结果:
ViewController
UIViewController
大部分情况的确是这样,但也有可能只输出:
ViewController
因为我们是在 +load
中做交换操作,而子类的 +load
却有可能先于父类执行。这样造成的结果是,子类先拷贝父类的 viewWillAppear:
,并进行交换,然后父类再进行交换。但这个时候父类的交换结果并不会影响子类,也无法将 NSLog(@"UIViewController")
写入子类的 viewWillAppear:
方法中,所以不会输出。
这里解决这个问题的思路是:在子类的 swizzledMethod
中,动态地去查找父类替换后方法的实现。每次调用都会去父类重新查找,而不是拷贝写死在子类的新方法中。这样子类 viewWillAppear:
方法的执行结果就和 +load
的加载顺序无关了。
至于怎么实现动态查找,这里推荐 RSSwizzle ,这个库不仅解决了上面提到的问题,还保证了 Method Swizzling 的线程安全,是一种更安全优雅的解决方案。简单使用举例:
RSSwizzleInstanceMethod([self class],
@selector(viewWillAppear:),
RSSWReturnType(void),
RSSWArguments(BOOL animated),
RSSWReplacement({
NSLog(@"ViewController");
RSSWCallOriginal(animated);
}), RSSwizzleModeAlways, NULL);
2. 获取所有属性和方法
Runtime
中提供了一系列API
来获取Class
的成员变量( Ivar )
、属性( Property )
、方法( Method )
、协议( Protocol )
等。直接看代码:
// 测试 打印属性列表
- (void)testPrintPropertyList {
unsigned int count;
objc_property_t *propertyList = class_copyPropertyList([self class], &count);
for (unsigned int i=0; i<count; i++) {
const char *propertyName = property_getName(propertyList[i]);
NSLog(@"property----="">%@", [NSString stringWithUTF8String:propertyName]);
}
free(propertyList);
}
// 测试 打印方法列表
- (void)testPrintMethodList {
unsigned int count;
Method *methodList = class_copyMethodList([self class], &count);
for (unsigned int i=0; i<count; i++) {
Method method = methodList[i];
NSLog(@"method----="">%@", NSStringFromSelector(method_getName(method)));
}
free(methodList);
}
// 测试 打印成员变量列表
- (void)testPrintIvarList {
unsigned int count;
Ivar *ivarList = class_copyIvarList([self class], &count);
for (unsigned int i=0; i<count; i++) {
Ivar myIvar = ivarList[i];
const char *ivarName = ivar_getName(myIvar);
NSLog(@"ivar----="">%@", [NSString stringWithUTF8String:ivarName]);
}
free(ivarList);
}
// 测试 打印协议列表
- (void)testPrintProtocolList {
unsigned int count;
__unsafe_unretained Protocol **protocolList = class_copyProtocolList([self class], &count);
for (unsigned int i=0; i<count; i++) {
Protocol *myProtocal = protocolList[i];
const char *protocolName = protocol_getName(myProtocal);
NSLog(@"protocol----="">%@", [NSString stringWithUTF8String:protocolName]);
}
free(protocolList);
}
因为这里用到的是 C 语言风格的变量,所以要注意用 free 来释放。至于获取这些属性方法有什么用,在下面的「应用场景」中会提到。