美文网首页
iOS学习(四十二)拦截导航返回按钮事件(多方案)

iOS学习(四十二)拦截导航返回按钮事件(多方案)

作者: 圆脸黑猫警长 | 来源:发表于2022-04-27 16:52 被阅读0次
    Best Practice.jpg

    使用系统导航栏时,有时期望点击返回按钮时根据业务需求进行事件,而不是直接返回。
    比如用户正在写评论,点击返回提示返回后评论消失等。

    一、情景分析

    1.当使用自定义返回按钮

    返回按钮是自定义时,代码可以直接控制到需要进行的事件,此种方式最简单直接。

    2.当使用系统自带返回按钮

    使用系统的返回按钮时,可以通过利用navigationBar的几个代理进行拦截:

    @protocol UINavigationBarDelegate <UIBarPositioningDelegate>
    
    @optional
    
    - (BOOL)navigationBar:(UINavigationBar *)navigationBar shouldPushItem:(UINavigationItem *)item; // called to push. return NO not to.
    - (void)navigationBar:(UINavigationBar *)navigationBar didPushItem:(UINavigationItem *)item;    // called at end of animation of push or immediately if not animated
    - (BOOL)navigationBar:(UINavigationBar *)navigationBar shouldPopItem:(UINavigationItem *)item;  // same as push methods
    - (void)navigationBar:(UINavigationBar *)navigationBar didPopItem:(UINavigationItem *)item;
    
    @end
    
    注意:

    由于UINavigationController管理着UINavigationBar,是其代理,所以我们需要在不改变其代理的情况下进行拦截(改变代理会导致UINavigationController不能正确的管理UINavigationBar)。通过在shouldPopItem方法中添加判断方法去拦截返回事件。

    这样,根据以上分析得出一下拦截系统返回事件的两种思路方案:

    方案一:通过添加UINavigationController子类覆写方法
    方案二:通过添加UINavigationController分类覆写方法
    方案三:通过添加UINavigationController分类交换方法实现

    但是,实践后发现如果是通过子类覆写方法shouldPopItem后,这个我们最需要方法没有被调用,其他的三个被调用了。具体原因未知,猜测可能这里会和滑动手势有关联处理之类的(没有依据),所以系统检测只会掉UINavigationController本身的实现。(具体参考下文第三点)

    当我们能拦截到后,仍需想办法将该方法的判断交出,由外界UIViewController去决定。

    综合考虑,使用如下最佳实现方案:

    二、一种最佳实践:使用中间方法

    基于以上分析,得出的基本思路是,不拦截原有的系统实现,改为基类添加一个方法,返回的方式都通过调用该方法,而非使用navigation的跳转方法。

    第一步:准备一个基类ViewController

    比如创建一个基类叫BaseViewController,继承UIViewController

    .h添加方法如下:

    #import <UIKit/UIKit.h>
    
    NS_ASSUME_NONNULL_BEGIN
    
    @protocol BaseVCNaviPop <NSObject>
    
    @optional
    
    - (BOOL)shouldPopVC;
    
    @end
    
    @interface BaseViewController : UIViewController<BaseVCNaviPop>
    
    - (void)popViewController;
    
    @end
    
    NS_ASSUME_NONNULL_END
    

    .m添加方法如下:

    #import "BaseViewController.h"
    
    @interface BaseViewController ()
    
    @end
    
    @implementation BaseViewController
    
    - (void)popViewController
    {
        if ([self respondsToSelector:@selector(shouldPopVC)]) {
            
            if ([self shouldPopVC]) {
                [self.navigationController popViewControllerAnimated:YES];
            }
            
        } else {
            [self.navigationController popViewControllerAnimated:YES];
        }
    }
    
    @end
    
    第二步:实现协议方法

    在需要拦截的ViewController中实现shouldPopVC方法,在该方法中进行逻辑判断,返回值表示是否可以跳转返回。

    此方案的优点:

    1. 由于不清楚系统返回方法的具体实现,这样不会影响系统方法实现,即使以后系统升级也不影响。
    2. 不需要拦截的VC也无需添加这样的方法,当旧项目使用自定义返回按钮时,返回方法往往已经有类似的方法暴露在VC中用于调用,这样通过协议接入对旧代码侵入小,也没有风险(一般项目都会有一个类似这样的BaseVC)。

    三、其他方案1:拦截shouldPopItem方法

    通过“情景分析2”中所表述的情况,可以使用“方案3”,通过method swizzling去hook到shouldPopItem方法,替换为自己的实践。判断交出的方式也是通过添加协议,由外界UIViewController去决定。

    这里帖一下别人写好的代码 防丢失(UIViewController+BackButtonHandler源码地址):

    UIViewController+BackButtonHandler.h
    #import <UIKit/UIKit.h>
    
    @protocol BackButtonHandlerProtocol <NSObject>
    @optional
    // Override this method in UIViewController derived class to handle 'Back' button click
    -(BOOL)navigationShouldPopOnBackButton;
    @end
    
    @interface UIViewController (BackButtonHandler) <BackButtonHandlerProtocol>
    
    @end
    
    
    UIViewController+BackButtonHandler.m
    #import "UIViewController+BackButtonHandler.h"
    #import <objc/runtime.h>
    
    @implementation UIViewController (BackButtonHandler)
    
    @end
    
    @implementation UINavigationController (ShouldPopOnBackButton)
    
    + (void)load {
        Method originalMethod = class_getInstanceMethod([self class], @selector(navigationBar:shouldPopItem:));
        Method overloadingMethod = class_getInstanceMethod([self class], @selector(overloaded_navigationBar:shouldPopItem:));
        method_setImplementation(originalMethod, method_getImplementation(overloadingMethod));
    }
    
    - (BOOL)overloaded_navigationBar:(UINavigationBar *)navigationBar shouldPopItem:(UINavigationItem *)item {
    
        if([self.viewControllers count] < [navigationBar.items count]) {
            return YES;
        }
    
        BOOL shouldPop = YES;
        UIViewController* vc = [self topViewController];
        if([vc respondsToSelector:@selector(navigationShouldPopOnBackButton)]) {
            shouldPop = [vc navigationShouldPopOnBackButton];
        }
    
        if(shouldPop) {
            dispatch_async(dispatch_get_main_queue(), ^{
                [self popViewControllerAnimated:YES];
            });
        } else {
            // Workaround for iOS7.1. Thanks to @boliva - http://stackoverflow.com/posts/comments/34452906
            for(UIView *subview in [navigationBar subviews]) {
                if(0. < subview.alpha && subview.alpha < 1.) {
                    [UIView animateWithDuration:.25 animations:^{
                        subview.alpha = 1.;
                    }];
                }
            }
        }
    
        return NO;
    }
    
    @end
    
    

    给UIViewController添加一个分类(用于提供协议方法),分类中添加一个UINavigationController的分类实践。通过method swizzling去交换shouldPopItem的具体实践,从而起到拦截的效果。

    这样的写法不推荐使用,
    首先hook这样的系统方法有风险,该方法就出现过这样的问题issue,看修改记录就是由于系统不再回调shouldPopItem而改为method swizzling
    其次,这样的写法比较隐蔽,在VC中又有Nav的分类。
    最后,仔细看该方法的实现,自己想想如果是自己是否能写出这些呢?

    四、其他方案2:拦截按钮事件

    QMUI库中的实现方案如下:

    UINavigationController+QMUI.m 中
    OverrideImplementation(NSClassFromString([NSString qmui_stringByConcat:@"_", @"UINavigationBar", @"ContentView", nil]), NSSelectorFromString(@"__backButtonAction:"), ^id(__unsafe_unretained Class originClass, SEL originCMD, IMP (^originalIMPProvider)(void)) {
        return ^(UIView *selfObject, id firstArgv) {
            
            if ([selfObject.superview isKindOfClass:UINavigationBar.class]) {
                UINavigationBar *bar = (UINavigationBar *)selfObject.superview;
                if ([bar.delegate isKindOfClass:UINavigationController.class]) {
                    UINavigationController *navController = (UINavigationController *)bar.delegate;
                    BOOL canPopViewController = [navController canPopViewController:navController.topViewController byPopGesture:NO];
                    if (!canPopViewController) return;
                }
            }
            
            // call super
            void (*originSelectorIMP)(id, SEL, id);
            originSelectorIMP = (void (*)(id, SEL, id))originalIMPProvider();
            originSelectorIMP(selfObject, originCMD, firstArgv);
        };
    });
    
    可以看出,作者拦截的是按钮的点击事件(处理完成后调用父类以免异常,其他方案1中如果这样处理则更好)。查看提交记录发现,该库原本也是拦截shouldPopItem方法,后来修改成拦截点击事件。

    之前版本拦截shouldPopItem的提交记录Github地址

    OverrideImplementation([UINavigationController class], @selector(navigationBar:shouldPopItem:), ^id(__unsafe_unretained Class originClass, SEL originCMD, IMP (^originalIMPProvider)(void)) {
                return ^BOOL(UINavigationController *selfObject, UINavigationBar *navigationBar, UINavigationItem *item) {
    
                    // call super
                    BOOL (^callSuperBlock)(UINavigationController *, UINavigationBar *, UINavigationItem *) = ^BOOL(UINavigationController *aSelfObject, UINavigationBar *aNavigationBar, UINavigationItem *aItem) {
                        BOOL (*originSelectorIMP)(id, SEL, UINavigationBar *, UINavigationItem *);
                        originSelectorIMP = (BOOL (*)(id, SEL, UINavigationBar *, UINavigationItem *))originalIMPProvider();
                        BOOL result = originSelectorIMP(aSelfObject, originCMD, aNavigationBar, aItem);
                        return result;
                    };
    
                    // avoid superclass
                    if (![selfObject isKindOfClass:originClass]) return callSuperBlock(selfObject, navigationBar, item);
    
                    // 如果nav的vc栈中有两个vc,第一个是root,第二个是second。这时second页面如果点击系统的返回按钮,topViewController获取的栈顶vc是second,而如果是直接代码写的pop操作,则获取的栈顶vc是root。也就是说只要代码写了pop操作,则系统会直接将顶层vc也就是second出栈,然后才回调的,所以这时我们获取到的顶层vc就是root了。然而不管哪种方式,参数中的item都是second的item。
                    BOOL isPopedByCoding = item != [selfObject topViewController].navigationItem;
    
                    // !isPopedByCoding 要放在前面,这样当 !isPopedByCoding 不满足的时候就不会去询问 canPopViewController 了,可以避免额外调用 canPopViewController 里面的逻辑
                    BOOL canPopViewController = !isPopedByCoding && [selfObject canPopViewController:selfObject.tmp_topViewController ?: [selfObject topViewController]];
    
                    if (canPopViewController || isPopedByCoding) {
                        selfObject.tmp_topViewController = nil;
                        BOOL result = callSuperBlock(selfObject, navigationBar, item);
                        return result;
                    } else {
                        selfObject.tmp_topViewController = nil;
                        [selfObject resetSubviewsInNavBar:navigationBar];
                    }
    
                    return NO;
                };
            });
    
    参考:
    1. QMUI,腾讯开源UI框架
    2. QMUI的拦截失败issue,修复提交代码

    相关文章

      网友评论

          本文标题:iOS学习(四十二)拦截导航返回按钮事件(多方案)

          本文链接:https://www.haomeiwen.com/subject/cogzdrtx.html