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

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,修复提交代码
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,186评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,858评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,620评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,888评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,009评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,149评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,204评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,956评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,385评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,698评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,863评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,544评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,185评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,899评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,141评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,684评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,750评论 2 351

推荐阅读更多精彩内容