转载

为所欲为之API兼容-Runtime消息转发

随着每年iOS系统与硬件的更新迭代，部分性能更优异或者可读性更高的API将有可能对原有API进行废弃与更替。与此同时我们也需要对现有APP中的老旧API进行版本兼容，当然进行版本兼容的方法也有很多种，下面笔者会列举常用的几种

Objective-C

//根据能否响应方法进行判断
if ([object respondsToSelector:@selector(selectorName)]) {
        
        //using new API
    }else {
        
        //using deprecated API
    }

//根据操作系统版本进行判断
#define isOperatingSystemAtLeastVersion(majorVersion, minorVersion, patchVersion) [[NSProcessInfo processInfo] isOperatingSystemAtLeastVersion:(NSOperatingSystemVersion){majorVersion, minorVersion, patchVersion}]
if (isOperatingSystemAtLeastVersion(11, 0, 0)) {
        
        //using new API
    }else {
        
        //using deprecated API
    }

//根据当前版本SDK是否存在所需类进行判断
if (NSClassFromString(@"ClassName")) {
        
        //using new API
    }else {
        
        //using deprecated API
    }

.....略略略

Swift

//根据操作系统版本及操作系统平台进行判断
if #available(iOS 11, *) {
        
        //using new API
    }else {
        
        //using deprecated API
    }

本来就存在了那么多对于系统版本判断的方法为什么我们还要另辟蹊径呢？

为所欲为之API兼容-Runtime消息转发

question.jpg

但是，如果你要为APP中大量调用了同一API做版本兼容时，上面的代码就会分散到了程序的各个地方，这不仅对本身业务代码造成了大量的入侵，变更时还费时费力。小编是个有代码洁癖并且又比较懒的人，那么有没有一种类似使用了Runtime技术来自动归解档的方法呢(一劳永逸??)？

有！并且还真给想法多路子野的小编还想到了！

接下来小编会一步步指引着读者思路来介绍此方法的实现：

根源

由于不同系统版本会更新迭代部分API(废弃，更替),如果我们不进行相对应的版本检查极有可能造成程序Crash问题:

废弃: 高版本操作系统虽然仍可以继续使用，但是不保证以后系统更新时是否会删除该API，未来可能导致程序Crash(存在调用已删除API风险)
更替: 高版本操作系统已经删除该API转而采用全新性能更优异或者可读性更高的API，如果用户操作系统升级到最新版本则会导致程序Crash(存在调用已删除API风险)

Note: 这里我们发现存在的风险都是由于版本更新可能造成的unrecognized selector sent to instance

动机

为了产生一种类似AOP方式的全局统一调用判断解决方案，我们将不同版本系统调用API的判断时机推迟至运行时，这样不仅能降低与业务代码的耦合也便于日后的统一维护。

解决方案

既然我们知道了问题的原因，那我们就可以从根源上去寻求解决的办法。既然它unrecognized selector，那我们就手动的为它在unrecognized selector前重新导向到新的selector或者selector of newObject(因为被调用Class可能是某个版本系统特有的)，这里就可以利用我们强大的消息转发机制了

消息调用、动态方法解析、消息转发

1.消息调用

讲到消息转发之前我觉得还是有必要为可能不了解Runtime机制的同学科普下这一部分，毕竟消息调用和动态方法解析是在消息转发机制触发之前的。

[receiver message];

在Objective-C编程中通常都是以上面那种形式进行相关API调用，但是所谓的API实现并不会在编译时就与具体实现进行绑定而是在运行时进行动态的查找，不然也不会叫Runtime，可能就叫Buildtime了

编译器在编译时会将上述代码转换成另一种C函数调用：

objc_msgSend(receiver, selector) //无参型

objc_msgSend(receiver, selector, arg1, arg2, ...) //有参型

该方法的实现就是所谓的动态查找

每个类实例都是一个objc_object结构，而其中只包含一个指向其类对象结构objc_class的isa指针

struct objc_object {
    Class _Nonnull isa  OBJC_ISA_AVAILABILITY;
};

struct objc_class {
    Class _Nonnull isa  OBJC_ISA_AVAILABILITY;
#if !__OBJC2__
    Class _Nullable super_class                              OBJC2_UNAVAILABLE;
    const char * _Nonnull name                               OBJC2_UNAVAILABLE;
    long version                                             OBJC2_UNAVAILABLE;
    long info                                                OBJC2_UNAVAILABLE;
    long instance_size                                       OBJC2_UNAVAILABLE;
    struct objc_ivar_list * _Nullable ivars                  OBJC2_UNAVAILABLE;
    struct objc_method_list * _Nullable * _Nullable methodLists                    OBJC2_UNAVAILABLE;
    struct objc_cache * _Nonnull cache                       OBJC2_UNAVAILABLE;
    struct objc_protocol_list * _Nullable protocols          OBJC2_UNAVAILABLE;
#endif
} OBJC2_UNAVAILABLE;

当触发了objc_msgSend方法时，它首先会根据isa所指向的类结构中进行方法查找(objc_method_list),如果该类中无法查找到所对应的方法，则会沿类结构中的超类指针super_class继续向上索引，直至NSObject类。一旦索引到对应方法则会向该方法传递receiver对应的数据结构

同时，为了优化索引速度，系统会缓存每次成功索引的方法名和实现地址到类结构中的objc_cache。后续的方法索引将优先索引缓存中的方法列表。

为所欲为之API兼容-Runtime消息转发

These elements of class and object structure.png

2.动态方法解析

如果上述方法索引未能成功，则会转入动态方法解析，该过程允许我们使用class_addMethod函数动态提供相对应的方法实现

+ (BOOL)resolveInstanceMethod:(SEL)sel; //如果调用的是实例方法则会调起该方法

+ (BOOL)resolveClassMethod:(SEL)sel; //如果调用的是类方法则会调起该方法

Sample Code:
void dynamicMethodIMP(id self, SEL _cmd) {
    // implementation ....
}
@implementation MyClass
+ (BOOL)resolveInstanceMethod:(SEL)aSEL
{
    if (aSEL == @selector(resolveThisMethodDynamically)) {
          class_addMethod([self class], aSEL, (IMP) dynamicMethodIMP, "v@:");
          return YES;
    }
    return [super resolveInstanceMethod:aSEL];
}
@end

3.消息转发

当上述实现仍未能向调用方法提供具体实现时即+ (BOOL)resolveInstanceMethod:(SEL)sel;或+ (BOOL)resolveClassMethod:(SEL)sel;返回值为NO。此时将转入消息转发流程。

- (void)forwardInvocation:(NSInvocation *)anInvocation;

该方法为我们提供了消息转发的最后机会，我们可以利用该方法将原有消息转发至另外一个对象处理或者忽略。其中参数anInvocation是基于面向对象对原有方法调用的一层封装，包含了方法名、调用参数、方法签名等。

Sample Code:
- (void)forwardInvocation:(NSInvocation *)anInvocation
{
    if ([someOtherObject respondsToSelector:
            [anInvocation selector]])
        [anInvocation invokeWithTarget:someOtherObject];
    else
        [super forwardInvocation:anInvocation];
}

运作流程如下:

为所欲为之API兼容-Runtime消息转发

Forwarding.png

比如我们对Warrior对象调用negotiate方法，但是由于消息调用与动态方法解析都无法对其提供具体实现，于是流程走到了- (void)forwardInvocation:(NSInvocation *)anInvocation即消息转发流程。此时我们可以通过重写- (void)forwardInvocation:(NSInvocation *)anInvocation方法来转发原有negotiate方法，来实现方法响应或避免造成unrecognized selector sent to instance所导致的程序Crash(默认NSObject类的- (void)forwardInvocation:(NSInvocation *)anInvocation的实现即为doesNotRecognizeSelector:)

说了那么多终于简单简绍完了从消息调用到最终消息转发的流程了，不知道小伙伴们此时有没有什么关于API兼容的想法或者头绪呢？

拿一个最近适配的iOS11的作为例子吧:

为所欲为之API兼容-Runtime消息转发

automaticallyAdjustsScrollViewInsets.png

该UIViewController属性已在iOS11后废弃，取而代之的是

UIScrollView的contentInsetAdjustmentBehavior属性

为所欲为之API兼容-Runtime消息转发

contentInsetAdjustmentBehavior.png

如果按以前的方式我们的版本兼容可能是这样的:

if (isOperatingSystemAtLeastVersion(11, 0, 0)) {
        
        scrollView.contentInsetAdjustmentBehavior = UIScrollViewContentInsetAdjustmentNever;
    }else {
        
        viewController.automaticallyAdjustsScrollViewInsets = NO;
    }

但是如果我们在iOS11 Base SDK直接采取最新的API并且配合Runtime的消息转发机制就能实现一行代码在不同版本操作系统下采取不同的消息调用方式

// 获取栈顶UIViewController分类
@implementation NSObject (WCQTopmostViewController)
- (UIViewController *)wcq_topmostViewController {
    
    UIViewController *resultVC;
    resultVC = [self wcq_topViewController:[[UIApplication sharedApplication].keyWindow rootViewController]];
    while (resultVC.presentedViewController) {
        resultVC = [self wcq_topViewController:resultVC.presentedViewController];
    }
    return resultVC;
}
- (UIViewController *)wcq_topViewController:(UIViewController *)vc {
    if ([vc isKindOfClass:[UINavigationController class]]) {
        return [self wcq_topViewController:[(UINavigationController *)vc topViewController]];
    } else if ([vc isKindOfClass:[UITabBarController class]]) {
        return [self wcq_topViewController:[(UITabBarController *)vc selectedViewController]];
    } else {
        return vc;
    }
}

ViewController.m
@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    UITableView *tableView = [[UITableView alloc] initWithFrame:CGRectMake(0, 64, 375, 600) style:UITableViewStylePlain];
    tableView.delegate = self;
    tableView.dataSource = self;
    tableView.backgroundColor = [UIColor orangeColor];
    tableView.contentInsetAdjustmentBehavior = UIScrollViewContentInsetAdjustmentNever;
    [tableView registerClass:[UITableViewCell class] forCellReuseIdentifier:@"UITableViewCell"];
    [self.view addSubview:tableView];
}

为UIScrollView添加一个消息转发的Category(WCQForwarding)

UIScrollView+WCQForwarding.m
@implementation UIScrollView (WCQForwarding)
- (NSMethodSignature *)methodSignatureForSelector:(SEL)aSelector { // 1
    
    NSMethodSignature *signature = nil;
    
    if (aSelector == @selector(setContentInsetAdjustmentBehavior:)) {
        
        signature = [UIViewController instanceMethodSignatureForSelector:@selector(setAutomaticallyAdjustsScrollViewInsets:)]; 
    }else {
        
        signature = [super methodSignatureForSelector:aSelector];
    }
    
    return signature;
}
- (void)forwardInvocation:(NSInvocation *)anInvocation { // 2
    
    BOOL automaticallyAdjustsScrollViewInsets  = NO;
    UIViewController *topmostViewController = [self wcq_topmostViewController];
    
    NSInvocation *viewControllerInvocation = [NSInvocation invocationWithMethodSignature:anInvocation.methodSignature]; // 3
    [viewControllerInvocation setTarget:topmostViewController];
    [viewControllerInvocation setSelector:@selector(setAutomaticallyAdjustsScrollViewInsets:)];
    [viewControllerInvocation setArgument:&automaticallyAdjustsScrollViewInsets atIndex:2]; // 4
    [viewControllerInvocation invokeWithTarget:topmostViewController]; // 5
}

当我们在高版本操作系统调用新API时，由于没有具体对应API实现，我们将其原有的消息转发至当前栈顶UIViewController去调用低版本API

整体流程:

为即将转发的消息返回一个对应的方法签名(该签名后面用于对转发消息对象(NSInvocation *)anInvocation进行编码用)
开始消息转发((NSInvocation *)anInvocation封装了原有消息的调用，包括了方法名，方法参数等)
由于转发调用的API与原始调用的API不同，这里我们新建一个用于消息调用的NSInvocation对象viewControllerInvocatio并配置好对应的target与selector
配置所需参数:由于每个方法实际是默认自带两个参数的:self和_cmd，所以我们要配置其他参数时是从第三个参数开始配置
消息转发

验证

在基于同一行代码实现情况下我们来分别看下iOS10及iOS11操作系统模拟器的表现

@implementation ViewController
- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    UITableView *tableView = [[UITableView alloc] initWithFrame:CGRectMake(0, 64, 375, 600) style:UITableViewStylePlain];
    tableView.delegate = self;
    tableView.dataSource = self;
    tableView.backgroundColor = [UIColor orangeColor];
    tableView.contentInsetAdjustmentBehavior = UIScrollViewContentInsetAdjustmentNever;
    [tableView registerClass:[UITableViewCell class] forCellReuseIdentifier:@"UITableViewCell"];
    [self.view addSubview:tableView];
}

为所欲为之API兼容-Runtime消息转发