iOS"添加方式"对项目代码侵入性较少的实现思路
优采云 发布时间: 2020-08-11 13:18最近公司项目做用户大数据信息采集,需要采集App端在页面切换/交互操作的时侯须要统计页面显示/页面消失风波,要给前端统计系统发送采集logs记录。
但项目中ViewController之前没有做任何承继关系(无子类Controller),所以在几十上百个Controller的项目里,一个一个添加历时不说,也不利于后期维护,那也是不推荐使用的蠢技巧。
1、利用Objective-C 中的对象承继
继承在面向对象开发中是十分常用的。
优点:继承可以实现代码的复用,减少代码冗余。将所有重复的内容合并在一起,可以让代码有效率,简洁,才意味着是一个成功的构架。否则,修改代码时须要更改多处,就很容易出错。
缺点:继承导致类与类之间耦合性很强。
现在项目工程中就会有一个BaseViewController,所有新建的ViewController都承继BaseViewController,通过往BaseViewController中添加一些公共方式/属性可以被她们的泛型所调用;这是统一工程中所有视图控制器式样的一个主要途径。
如果项目中没有ViewController泛型的话,重新创建一个泛型也不难。
这种方式比较考验耐心和悉心,更换了默认的承继关系。会修改好多类,侵入性虽然很大。但考虑到之后的维护成本,在控制器类还不庞大的情况下,建议使用此种方式。不能完成的是原项目早已有承继关系了,但承继关系比较负责。这时候就要愈发当心(除了处理可能多个父类,还要处理没承继的控制器),相当于给她们造了一个祖宗~
2、利用Category和Runtime交换系统方式并添加方式(系统主动调用load)
load函数调用特性如下:
当类被引用进项目的时侯才会执行load函数(在main函数开始执行之前),与这个类是否被用到无关,每个类的load函数只会手动调用一次.由于load函数是系统手动加载的,因此不需要调用父类的load函数,否则父类的load函数会多次执行。
详见Demo: 多个分类重名时,方法的调用次序
#import
+ (void)load {
[super load];
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
// 交换VC页面完全显示方法
__mmc_tracer_swizzleMethod([self class], @selector(viewDidAppear:), @selector(__mmc_tracer_viewDidAppear:));
// 交换VC页面完全消失方法
__mmc_tracer_swizzleMethod([self class], @selector(viewDidDisappear:), @selector(__mmc_tracer_viewDidDisappear:));
});
}
void __mmc_tracer_swizzleMethod(Class class, SEL originalSelector, SEL swizzledSelector){
Method originalMethod = class_getInstanceMethod(class, originalSelector);
Method swizzledMethod = class_getInstanceMethod(class, swizzledSelector);
BOOL didAddMethod =
class_addMethod(class,
originalSelector,
method_getImplementation(swizzledMethod),
method_getTypeEncoding(swizzledMethod));
if (didAddMethod) {
class_replaceMethod(class,
swizzledSelector,
method_getImplementation(originalMethod),
method_getTypeEncoding(originalMethod));
} else {
method_exchangeImplementations(originalMethod, swizzledMethod);
}
}
/** 只忽略了部分常用系统原生contrlloer
* 通过继承父类来实现 相对于hook来说 是较为准确的,因为需要被统计的页面都是继承于这个父类的控制器,而其他的如UINavigationController,系统自带的UIAlertController等则不会误入统计数据当中
*/
+ (BOOL)isIgnoreSystemViewController:(id)instance {
return
[instance isKindOfClass:[UITabBarController class]] ||
[instance isKindOfClass:[UINavigationController class]] ||
[instance isKindOfClass:[UISearchController class]] ||
[instance isKindOfClass:[UIAlertController class]] ||
[instance isKindOfClass:[UISearchController class]] ||
[instance isKindOfClass:[UIActivityViewController class]];
}
- (void)__mmc_tracer_viewDidAppear:(BOOL)animated {
[self __mmc_tracer_viewDidAppear:animated]; //由于方法已经被交换,这里调用的实际上是viewDidAppear:方法
if ([UIViewController isIgnoreSystemViewController:self]) {
//TODO: 实现页面显示的打点采集方法
}
}
- (void)__mmc_tracer_viewDidDisappear:(BOOL)animated {
[self __mmc_tracer_viewDidDisappear:animated]; //由于方法已经被交换,这里调用的实际上是viewDidDisappear:方法
if ([UIViewController isIgnoreSystemViewController:self]) {
//TODO: 实现页面消失的打点采集方法
}
}
3、利用Aspects施行方式hook (被动调用,类似通知*敏*感*词*)
Aspects是AOP(面向切面编程)思想在iOS下OC的实现。Aspects可以用于hook函数,让函数执行一些副操作。为嵌入不同函数中的功能相同的操作,每类功能相同的操作可以抽取出一个切面。
核心原理:当被 hook 的 selector 被执行的时侯,首先按照 selector找到了 objc_msgForward / _objc_msgForward_stret,而这个会触发消息转发,从而步入 forwardInvocation。同时因为forwardInvocation 的指向也被更改了,因此会转到新的 forwardInvocation函数,在里面执行须要嵌入的附加代码,完成以后,再转到原先的 IMP。
常用的两个方式
/** 只忽略了部分常用系统原生contrlloer
* 通过继承父类来实现 相对于hook来说 是较为准确的,因为需要被统计的页面都是继承于这个父类的控制器,而其他的如UINavigationController,系统自带的UIAlertController等则不会误入统计数据当中
*/
- (BOOL)isIgnoreSystemViewController:(id)instance {
return
[instance isKindOfClass:[UITabBarController class]] ||
[instance isKindOfClass:[UINavigationController class]] ||
[instance isKindOfClass:[UISearchController class]] ||
[instance isKindOfClass:[UIAlertController class]] ||
[instance isKindOfClass:[UISearchController class]] ||
[instance isKindOfClass:[UIActivityViewController class]];
}
- (void)hookAllViewControllerAppearAndDisappear {
/// hook 控制器的显示和消失 分别打log
// 显示
[UIViewController aspect_hookSelector:@selector(viewDidAppear:) withOptions:AspectPositionAfter usingBlock:^(id aspectInfo, BOOL animated) {
if (![self isIgnoreSystemViewController:aspectInfo.instance]) {
// 不是忽略VC则采集
[[self class] addBeginLogPageView:NSStringFromClass([aspectInfo.instance class])];
}
} error:NULL];
// 消失
[UIViewController aspect_hookSelector:@selector(viewDidDisappear:) withOptions:AspectPositionAfter usingBlock:^(id aspectInfo, BOOL animated) {
if (![self isIgnoreSystemViewController:aspectInfo.instance]) {
// 不是忽略VC则采集
[[self class] addEndLogPageView:NSStringFromClass([aspectInfo.instance class])];
}
} error:NULL];
}
hook方案有一个用处就是可以避免代码入侵,做到愈加广泛的通用性。通过swizzling我们可以将原method与自己加入的method相结合,即不需要在原有工程中加入代码,又能做到全局覆盖。
三种方案对比:
1、通过承继父类来实现,相对于hook来说,是较为确切的。因为须要被统计的页面都是承继于这个父类的控制器,而其他的如UINavigationController、UIAlertController等则不会误入统计数据当中。
2、上面提及 hook方案是通过hook UIViewController viewDidLoad/viewDidAppear等方式,而这种方式实际上每位Controller 都会调用,那么都会出现不该出现的Controller 也出现在这里(如前面说到的UINavigationController和UIAlertController)。但hook方案一个比较好的特征是无代码入侵,在不更改项目代码的前提下完成工作。
3、两种hook的对比:分类的方式只要分类被load则就开始hook, 时机并不能自己控制,而且也不能自己开关控制是否hook或则中止hook操作。一个由程序员主动调用(Aspects),一个由系统调用(分类)。由于可控性最后还是选择了Aspects来进行hook。
但要做的是通用的大数据采集类,以后公司内部所有App都可能会用到,在不知道是那个App有哪些Controller的情况下,hook似乎成了最好的技巧。当然要注意筛选掉系统的Controller,避免重复采集无用的数据。 如果要做内部封装的话似乎Aspects hook的方法好一点,不然的话你就要曝露出API提供给分类,或者将分类写入封装类内部。这样代码比较长不利于后期维护。还有最重要的一点就是:使用Aspects可以留一个开关给外部,是否须要sdk帮助采集所有界面的出现和消失,或者交给使用者自己采集界面信息。
最后推荐两篇针对Aspects个人认为写得非常棒的文章