本文将介绍oc中的方法拦截器的实现思路,如何拦截一个方法,并在执行方法前进行一些前置业务逻辑后决定是否继续执行方法。
缘由:最近公司需要将组件进行授权管理(类似第三方SDK的授权),之前编写过很多内部使用的SDK,现在需要将这些SDK通过授权管理起来,我的想法是编写一个统一授权管理的模块,需要被管理的SDK引用这个授权管理模块即可,要求是对原SDK尽量少做代码改动。
在百度搜了一圈都没有想要的答案,所以决定自己提需求自己实现。
需求:
1.对需要被拦截监听的方法无代码侵入。
2.成功拦截需要被监听的方法,并在方法执行前做前置逻辑判断,最后决定是否执行被拦截的方法。
实现思路:
这么刁钻的需求肯定用runtime了,思路就是将被监听的方法的实例利用方法交换替换成自定义的方法,在自定义方法中执行我们自己的逻辑判断,最后决定是否需要继续原方法调用。(是不是很简单?上才艺!)
这里只讲实例方法的拦截,因为任何类都可能需要注册自己需要被监听的方法,所以创建一个NSObject的分类
NSObject+SRModuleAuthorization.h:
@interface NSObject (SRModuleAuthorization)
- (void)registerNeedMonitorSEL:(SEL)sel;
@end
头文件只对外暴露一个注册需要被监听方法的API。
下面来看实现NSObject+SRModuleAuthorization.m:
//注册需要被拦截的方法
- (void)registerNeedMonitorSEL:(SEL)sel {
//获取方法的名称,根据该名称设置自定义的方法名称
NSString *methodName = NSStringFromSelector(sel);
NSString *newMethodName = [NSString stringWithFormat:@"sr_auth_%@", methodName];
//获取自定义方法的实例
SEL newSel = NSSelectorFromString(newMethodName);
Method newMethod = class_getInstanceMethod([self class], newSel);
//判断是否已经添加了自定义的方法,如果为空就添加自定义方法
if (!newMethod) {
//获取被拦截方法的结构体对象
Method method = class_getInstanceMethod(self.class, sel);
//获取被拦截方法的方法签名字符串
const char *functionType = method_getTypeEncoding(method);
NSString *functionTypeStr = [NSString stringWithUTF8String:functionType];
//判断方法签名的字符串中,:8是否是最后两个字符,
//如果是则代表无参数方法,否则是有参方法,
//针对这两种方法添加不同的自定义拦截方法。
NSRange range = [functionTypeStr rangeOfString:@":8"];
Method intercetionMethod;
if (range.location + range.length < functionTypeStr.length) {//有参的添加有参拦截方法
intercetionMethod = class_getInstanceMethod(self.class, @selector(interception:));
} else {//添加无参拦截方法
intercetionMethod = class_getInstanceMethod(self.class, @selector(interception));
}
//获取自定义拦截方法的实例,
//并将自定义方法的selector与实例关联,动态地添加进当前类型。
IMP imp = method_getImplementation(intercetionMethod);
class_addMethod([self class], newSel, imp, functionType);
//最后重新获取自定义方法的方法结构体,
//并与被监听方法进行实例交换,交换后,
//被监听的方法被调用时,就会执行我们自定义的方法实例,即interception
Method method2 = class_getInstanceMethod(self.class, newSel);
method_exchangeImplementations(method, method2);
}
}
下面是interception方法的实现,flag就理解为一个开关就行,interception的主要功能是决定是否需要执行被拦截的方法。
//无参拦截方法
- (void)interception {
if (flag) {
NSString *methodName = NSStringFromSelector(_cmd);
NSString *newMethodName = [NSString stringWithFormat:@"dl_auth_%@", methodName];
SEL newSel = NSSelectorFromString(newMethodName);
NSMethodSignature *signature = [[self class] instanceMethodSignatureForSelector:newSel];
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
invocation.target = self;
invocation.selector = newSel;
[invocation invoke];
} else {
//执行自定义代码
}
}
有参拦截方法的参数是一个可变参数列表,我们通过遍历并设置invocation对象的参数已达到传参的目的。
注意:这里有个问题,被监听的方法中如果参数类型不是对象类型的话会报错,所以本文的方法拦截只适用于方法签名中参数都是对象类型的方法。(目前还没有找到能够解决的办法,如果你读到这里有更好的解决方案,希望你能告诉我)。
//有参拦截方法
- (void)interception:(id)param, ... {
if (flag) {
NSString *methodName = NSStringFromSelector(_cmd);
NSString *newMethodName = [NSString stringWithFormat:@"dl_auth_%@", methodName];
SEL newSel = NSSelectorFromString(newMethodName);
NSMethodSignature *signature = [[self class] instanceMethodSignatureForSelector:newSel];
NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
invocation.target = self;
invocation.selector = newSel;
NSInteger argCount = signature.numberOfArguments;
va_list args;
va_start(args, param);
NSMutableArray *params = [NSMutableArray array];
if (argCount > 2) {
[params addObject:param];
}
for (int i = 3; i < argCount; i++) {
param = va_arg(args, id);
[params addObject:param];
}
va_end(args);
for (int i = 0; i < params.count; i++) {
id obj = params[i];
[invocation setArgument:&obj atIndex:i + 2];
}
[invocation invoke];
} else {
//执行自定义代码
}
}
以上就是我的统一授权组件的实现代码,使用的时候就很方便了,只需要在要被监听的类的初始化方法中,调用self的registerNeedMonitorSEL方法就行了,需要监听那个方法就监听哪个。
示例
[self registerNeedMonitorSEL:@selector(test)];
你也可以编写一个监听所有方法的方法:
注意:如果方法签名中有非对象的入参则会报错。
- (void)registerNeedMonitorAllMethod {
unsigned int count;
Method *methodList = class_copyMethodList([self class], &count);
for (int i = 0; i < count; i++) {
Method method = methodList[i];
SEL selector = method_getName(method);
[self registerNeedMonitorSEL:selector];
}
}
//调用时一句代码搞定
[self registerNeedMonitorAllMethod];