合理使用oc的runtime特性,可以为我们的应用开发和解决业务需求提供极大的便利。这篇文章权当学习AOP源码的学习笔记分享出来。
aop 编程值aspect第三方库的使用解析
.h 文件声明
AspectOptions
AspectOptions声明了切面编程对原方法的处理方式。默认为AspectPositionAfter,在原始方法之后调用。AspectPositionInstead 替代原始方法
AspectPositionBefore 在原方法之前调用
AspectOptionAutomaticRemoval,在第一次hook之后,会自动移除hook
定义的两个协议
AspectToken:允许注销hook,协议中只有一个remove方法,返回yes则注销hook成功,返回no则注销失败
AspectInfo:是aop切面block的第一个参数。主要包含了hook的信息。主要由instance,originalInvocation,arguments组成。分别是当前hook的实例,hook方法的原始invocation以及所有方法的参数。
切面编程的两个方法
- (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
- (id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error;
第一个方法是为类添加一个block,第二个方法是为实例添加一个block。两个方法都无法为静态方法添加hook。
几个错误码
AspectErrorCode:表明返回的错误类型;
AspectErrorSelectorBlacklisted, /// Selectors like release, retain, autorelease are blacklisted.
AspectErrorDoesNotRespondToSelector, /// Selector could not be found.
AspectErrorSelectorDeallocPosition, /// When hooking dealloc, only AspectPositionBefore is allowed.
AspectErrorSelectorAlreadyHookedInClassHierarchy, /// Statically hooking the same method in subclasses is not allowed.
AspectErrorFailedToAllocateClassPair, /// The runtime failed creating a class pair.
AspectErrorMissingBlockSignature, /// The block misses compile time signature info and can't be called.
AspectErrorIncompatibleBlockSignature, /// The block signature does not match the method or is too large.
AspectErrorRemoveObjectAlreadyDeallocated = 100 /// (for removing) The object hooked is already deallocated.
.m文件方法解析
_AspectBlock:结构体
AspectIdentifier:追踪单个的aspect
包含有追踪的selector、block、blockSignautre方法签名、options切面选项、
AspectsContainer:一个对象或者类的所有切面
包含有三个数组分别用于存放hook前,hook替代的方法、及hook后方法
AspectTracker:所hook类的相关信息
包含类名、所有的方法名
aspects hook调用栈
以实例对象的调用为例:
-
(id<AspectToken>)aspect_hookSelector:(SEL)selector
withOptions:(AspectOptions)options
usingBlock:(id)block
error:(NSError **)error{}方法为共有API,调用的是
static id aspect_add(id self, SEL selector, AspectOptions options, id block, NSError **error)。
第一个参数传本对象、第二个参数传当前hook的selector、第三个传block、第四个hook选项。
aspect_add方法主要将参数传入做下一步的处理。
处理流程:
断言确保传入的参数不为空;创建一个AspectIdentifier对象用于保存hook的信息。
static void aspect_performLocked(dispatch_block_t block) {
static OSSpinLock aspect_lock = OS_SPINLOCK_INIT;
OSSpinLockLock(&aspect_lock);
block();
OSSpinLockUnlock(&aspect_lock);
}
aspect_performLocked加了线程安全锁,用于保证线程安全的情况下执行block。保证当前线程只有一个在hook。
在aspect_performLocked中,先是创建AspectsContainer对象,接着将传入的参数组装成AspectIdentifier对象。如果对象不为空,则AspectsContainer添加该对象,最后执行aspect_prepareClassAndHookSelector()方法进行hook。
aspect_isSelectorAllowedAndTrack()
该方法判断当前函数能否被hook,不能被hook的函数有retain、release、autorelease、forwardInvocation,以及delloc之后调用,并将track过的方法加入到tracker中。
先创建不能被hook的名单,接着检查传入的方法是否是处于名单中的方法若是则返回No.如果hook的是delloc方法,则检查是在delloc前还是delloc后,delloc后调用是错误的。
继续判断当前hook的是不是类对象,如果是类对象则先判断是否在子类中hook过,如果hook过子类相同的方法则返回NO;没有hook过则在当前类的父类中方法查找判断。
首先拿到以当前类为key,从字典中拿到tracker,接着判断tracker中是否含有要hook的方法如果有再判断是否是当前类,是则返回yes,no则之前已经hook过。
该方法用于记录hook的信息。创建一个tracker对象,将hook过的方法加入到tracker字典中,这个字典是一个全局的单例。
aspect_prepareClassAndHookSelector();
为切面编程的核心方法。
1、获取当前要hook的类
2、拿到目标方法的Method
3、拿到目标方法的实现imp地址
4、判断目标imp是否是消息转发的方法,若不是进行相应的替换
1、拿到目标方法的typeEncoding
2、为selector添加自定义前缀
3、判断当前类实例是否响应添加前缀的selector如果不响应则新增方法
4、替换方法的实现为自身的方法。
aspect_aliasForSelector()
该方法主要是为selector添加上自定义的前缀 @"aspects_"
aspect_getMsgForwardIMP()
获取消息转发的函数实现,用于替换原有的selector的方法实现;
_objc_msgForward
是一个函数指针,与IMP类似用于消息转发。当一个对象发送消息并没有实现的时候,_objc_msgForward
会尝试做消息转发。
该方法主要的目的是在于返回的是_objc_msgForward
,还是_objc_msgForward_stret
。先判断非arm64的情况下,接着判断返回值的大小来决定是否使用_objc_msgForward_stret
。关于返回值的详细说明可以参考官方文档。关于为什么要在非arm64位的情况下判断可以参考这篇文章。
清除hook 方法
与添加hook相对应的就是清除hook方法aspect_remove;
aspect_remove
可以发现首先是一个锁aspect_performLocked,防止多线程同时修改。具体步奏如下:
1、获取AspectsContainer对象
2、根据aspect,AspectIdentifier寻找对应的实例删除
3、调用aspect_cleanupHookedClassAndSelector撤销runtime时做的改变
4、将aspect对象重置
aspect_cleanupHookedClassAndSelector()
该方法是整个撤销过程的核心,主要是将runtime时hook的imp复原,且将tracker等置空。
综述
以上是自己最近研究学习AOP源码的一些认识,受限于个人水平,如有不正确的地方,还请批评指正。后续会继续更新本篇学习笔记。