最近接入第三方 SDK 时碰到个蛋疼的 bug。
前提:
- 当前项目在基类 VC 中使用属性
hidesNavigationBarWhenPush
来标识是否显示导航栏; - 基类 VC 中,在 willAppear 中使用
[self.navigationController setNavigationBarHidden:self.hidesNavigationBarWhenPush animated:animated];
来控制导航栏的显示和隐藏;
Bug
- 某个 parentVC 中包含两个 childVC,3个 VC 都使用
self. hidesNavigationBarWhenPush = NO
来显示导航栏:
parentVC 代码如下:
- (void)viewDidLoad {
[super viewDidLoad];
self.hidesNavigationBarWhenPush = NO;
self.navigationItem.rightBarButtonItem = self.rigthBarBtnItem;
self.navigationItem.titleView = self.titleView;
[self.titleView setSelectedItemIndex:self.selectedIndex subItemIndex:0];
}
- 跳转到第三方 SDK 的 VC 之后,pop 回 mainVC,导航栏就不显示了;
-
第三方 SDK 的容器 VC 继承自第三方 SDK 的基类VC:
解决
Bug 的解决倒是很简单,在第三方SDK的容器VC中添加:
- (void)viewWillDisappear:(BOOL)animated {
[super viewWillDisappear:animated];
// 内部sdk直接把navigationBar隐藏了,要在pop之后显示
self.navigationController.navigationBar.hidden = NO;
}
原因
其实原因也很简单,就是第三方 SDK 未采用 apple 推荐的方法来控制导航栏的显示和隐藏:
@property(nonatomic,getter=isNavigationBarHidden) BOOL navigationBarHidden;
- (void)setNavigationBarHidden:(BOOL)hidden animated:(BOOL)animated; // Hide or show the navigation bar. If animated, it will transition vertically using UINavigationControllerHideShowBarDuration.
从上面的说明中可以看出,Apple 很清楚地说明了只能通过 navigationBarHidden 或者 setNavigationBarHidden:animated: 来控制 navigationBar 的显示和隐藏,两种方式的区别在于一个能控制动画,一个是无动画效果的;
Apple 的这种逻辑其实也能理解,因为导航栏的显示不仅仅是 navigationBar.hidden 就能决定的,比如 title 的设定、willAppear 方法中的控制、父子控制器中导航栏的逻辑等。虽然最终 Apple 也是通过所以 navigationBar.hidden = YES/NO 来设置的,但是 Apple 屏蔽了 Nav、TabVC、ChildVC 等许多逻辑,如果直接调用 navigationBar.hidden = YES/NO ,则会破坏内部的逻辑顺序,导致系统的导航栏隐藏/显示逻辑失效,出现一些奇怪的 Bug;
而三方 SDK 内部是通过 self.navigationController.navigationBar.hidden = YES
来暴力强制地直接隐藏了导航栏。
三方 SDK 这么做也有其道理,因为 SDK 会被很多公司的项目引用,难免会遇到一些不同的场景,某些场景下,如果甲方项目也没有按照 Apple 的正规流程来设置导航栏的隐藏和显示,那么就会吃屎。估计是这么做也是为了强制隐藏导航栏。
总结:
- 三方SDK通过
navigationBar.hidden = YES;
隐藏了导航栏; - 在三方SDK的容器VC将要消失之前,设置
navigationBar.hidden = NO;
即可;
疑问:
其实这里还有个疑问,虽然设置了 navigationBar.hidden = YES;
,但是当返回到 parentVC 时,willAppear 方法里面肯定是是会调用导航栏显示代码的:
// self.hidesNavigationBarWhenPush = NO;
[self.navigationController setNavigationBarHidden:self.hidesNavigationBarWhenPush animated:animated];
那为什么不能正常显示呢?
接着往下看......
还没完呢
就 bug 而言,其意义在于规范一下 navigationBar 的使用,但是这里有一个奇怪的现象,从前提中可知道,mainVC 中采用 childVC 的方式来组织视图,而如果 mainVC 中去掉以下代码:
- (void)viewDidLoad {
[super viewDidLoad];
// self.hidesNavigationBarWhenPush = NO;
self.navigationItem.rightBarButtonItem = self.rigthBarBtnItem;
self.navigationItem.titleView = self.titleView;
[self.titleView setSelectedItemIndex:self.selectedIndex subItemIndex:0];
}
这样修改后,不需要额外代码,Bug 就没有了;
那么原因是什么呢?其实这个原因和上文的疑问本质原因是一样的,就是:
[self.navigationController setNavigationBarHidden:animated:];
方法内部会判断 Hidden 是否发生了改变,如果未改变,直接 return;
伪代码如下:
- (void)setNavigationBarHidden:(BOOL)hidden animated:(BOOL)animated {
if(self.hidden == hidden) return;
// other code...
}
其实 iOS12 之后就有很多这种代码保护,比如之前碰到 App 的换肤功能,在换肤之后,View 的 backgroundColor 更新不及时。因为我们项目中自定义了 color 对象,使用同一个对象表示不同皮肤下的色值,所以很可能导致了系统出现以下判断:
- (void)setBackgroundColor:(UIColor *)backgroundColor {
if(backgroundColor == self.backgroundColor) return;
// other code...
}
解决办法就一句代码:
view.backgroundColor = nil;
view.backgroundColor = newColor;
其实 Apple 的这种优化代码也很有道理,因为这样可以避免没有必要的重绘,提高性能,再加之这种代码调用频率特别高,所以一句简单的相等判断可以省下很多性能消耗;
所以,Apple 所认为的正常的隐藏/显示导航栏的逻辑就是通过对应的两个方法来操作,然后内部自己会进行一些逻辑判断之后最终设置navigationBar.hidden 的值。
然鹅,当 SDK 的容器 VC 通过非常规手段设置了 navigationBar.hidden = YES;
之后,self.navigationController. navigationBarHidden
的值并没有发生变化,即值仍为 NO,所以当 SDK 的容器 VC 在 pop 之后,parentVC 调用到setNavigationBarHidden
方法时,判断 self.navigationController. navigationBarHidden
的值并未发生改变,最终直接 return;
而之所以去掉 parentVC 中的那段代码(self.hidesNavigationBarWhenPush = NO;
) 能够解决这个 Bug,就是因为
- 基类 VC 中默认 hidesNavigationBarWhenPush = YES,所以 parentVC.navigationController.navigationBarHidden = YES;
- SDKVC 中 self.navigationController.navigationBarHidden 为默认值,即为 NO;
- 当 SDKVC 被 pop 时,parentVC 通过基类调用了 viewWillAppear 方法。因为 navigationController.navigationBarHidden 的值不一致,所以没有直接 return,走完系统内部逻辑之后,重新设置了 navigationBar.hidden = YES;
- 上一步之后,其实仍然应该不显示导航栏,但就是因为 parentVC 是通过 childVC 的形式组织 VC,所以此时 childVC 的 willAppear 方法被调用;
- childVC 中的 self.navigationController.navigationBarHidden = NO,这个值又发生了改变,所以没有直接 return,最终设置为 navigationBar.hidden = NO; 显示了导航栏;
这个过程还真的是一波三折啊,很蛋疼啊......脑壳痛😨😨......希望我解释清楚了......
进而,还有一种解决办法,在SDK的容器VC中:
- (void)viewWillAppear:(BOOL)animated {
// 调用super,内部直接设置了navigationBar.hidden = YES;
[super viewWillAppear:animated];
/**
* apple明确指出只能使用self.navigationController.navigationBarHidden或者setNavigationBarHidden:animated:来设置导航栏隐藏/显示;
* 三方SDK内部直接设置的self.navigationController.navigationBar.hidden = YES未按照apple的正规流程来设置,这就导致pop之后,虽然导航栏隐藏/显示状态发生了变化,但self.navigationController.navigationBarHidden的值未发生变化;
* 系统内部应该是会对比self.navigationController.navigationBarHidden 值是否一致,如果不一致才去设置 navigationBar.hidden = self.navigationController.navigationBarHiddenl;这样可以避免频繁设置hidden引起的性能问题;
* 直接在disappear方法中设置navigationBar.hidden = NO可能存在潜在风险;
* 所以,解决这个Bug的最好方式应该是让流程正规化;
*/
[self.navigationController setNavigationBarHidden:YES animated:YES];
// toher code...
xxxxx
}
总结
关键点:
-
[self.navigationController setNavigationBarHidden:animated:];
方法中会对navigationBarHidden
的值进行对比,如果一样,就直接return,如果不一样,就设置self.navigationBar.hidden = self.navigationController. navigationBarHidden;
- parentVC 的 willAppear、viewDidAppear 调用顺序先于 childVC,如果是在 VC 中设置导航栏显示/隐藏,就会出现 childVC 主导导航栏的效果;
最关键的:
self.navigationController.navigationBarHidden 是唯一的、正规的渠道来控制导航栏的隐藏和显示;
有了这个意识,在 viewDidLoad,还是 willAppear 等方法中来设置这个值,就看不同 App 自己的业务逻辑了。