需求场景描述
在目前的比较常见的一种场景是,在 App 的首页如果点击 back 键会 toast 提示用户再点击一次是退出 App。
例如如下代码所示:
# 首页Homectivity.java
@Override
public void onBackPressed() {
if ((System.currentTimeMillis() - exitTime) > 2000) {
ShowUtils.toast(R.string.exit_tost);//提示再按一次back退出App
exitTime = System.currentTimeMillis();
}
}
这种场景常规情况是没有什么问题的,但是如果你 App 首页 Activity 嵌套了一个 Fragment ,这个 fragment 需要根据场景
来决定是否需要处理返回键这个操作,如果需要处理的话就不将这个返回的事件交给 首页Activity
的onBackPressed
方法,如果不需要处理则将这个返回的事件交给 首页Activity
的onBackPressed
方法。
解决方案
方案1:
fragment
本身并没有提供处理 activity onBackPressed
的监听,google了一下基本都是自己实现一个监听器来处理的。
方案2:官方支持OnBackPressedDispatcher
其实 Android 是有支持在 fragment
中去处理 activity onBackPressed
的处理,那就是androidx.activity.OnBackPressedDispatcher
这个类。
打开这个类,它已经有对使用方式有做了一个案例了,我们对着抄就好了。
下面把操作步骤写一些:
-
编写
OnBackPressedCallback
监听器,这个回调主要是处理用户的返回键操作的注意:这里
OnBackPressedCallback
的构造需要传一个参数enabled
,标识fragment
是否要处理这个返回键事件
,我们可以动态设置这个值来决定fragment
是否要处理用户的返回键事件。# fragment.kt //谷歌推荐的fragment监听activity返回的事件 private val mBackPressedCallback: OnBackPressedCallback by lazy { object : OnBackPressedCallback(false) {//enabled 标记位 override fun handleOnBackPressed() { Log.d(TAG,"handleOnBackPressed invoke") } } }
-
添加这个监听器
# fragment.kt fragment.requireActivity().onBackPressedDispatcher.addCallback(fragment, // LifecycleOwner mBackPressedCallback)
-
动态的调整是否要处理这个返回键事件
mBackPressedCallback.isEnabled = false/true
-
在需要的地方移除这个事件
一般情况下可以在生命周期结束的时候移除这个事件
mBackPressedCallback.remove()
OnBackPressedDispatcher 的实现原理
分析问题,首先得找到切入口,那就是 ComponentActivity#onBackPressed方法
# ComponentActivity.java
public void onBackPressed() {
mOnBackPressedDispatcher.onBackPressed();
}
可以看到 mOnBackPressedDispatcher 是在 ComponentActivity 中处理的。那接下来的分享都是围绕在 ComponentActivity 这个类中的。
mOnBackPressedDispatcher.onBackPressed()
在注释1 OnBackPressedDispatcher#onBackPressed方法首先去处理
OnBackPressedCallback
事件,如果集合mOnBackPressedCallbacks
中没有数据,那么注释2执行mFallbackOnBackPressed.run()
# OnBackPressedDispatcher.java
public void onBackPressed() {
Iterator iterator =
mOnBackPressedCallbacks.descendingIterator();
while (iterator.hasNext()) {
OnBackPressedCallback callback = iterator.next();
if (callback.isEnabled()) {//注释3
callback.handleOnBackPressed();//注释1
return;
}
}
if (mFallbackOnBackPressed != null) {
mFallbackOnBackPressed.run();//注释2
}
}
添加OnBackPressedCallback事件
这个操作就是上面添加监听器mBackPressedCallback的操作:
fragment.requireActivity().onBackPressedDispatcher.addCallback(fragment, // LifecycleOwner
mBackPressedCallback)
所以说,如果往 onBackPressedDispatcher
添加了监听器,那么在 onBackPressed 中就会分发给这个监听器mBackPressedCallback处理。注意这里还有注释3有一个判断,表示是否要处理这个返回键事件的标记位。
兜底处理mFallbackOnBackPressed
我们想一下,如果没有任何 BackPressedCallback
需要处理的话,那么这个事件是必须要回流到 父Activity#onBackPressed() 的,不然就无法处理关闭 activity 的功能了,所以这个 FallbackOnBackPressed
就是做这件事的。
FallbackOnBackPressed 的实现做了什么?
这个 FallbackOnBackPressed
是传递到 OnBackPressedDispatcher
的构造中的。
# OnBackPressedDispatcher.java
public OnBackPressedDispatcher(@Nullable Runnable fallbackOnBackPressed) {
mFallbackOnBackPressed = fallbackOnBackPressed;
}
从注释2来看说这个兜底的处理就是去 ComponentActivity.super.onBackPressed()
这样就可以将事件分发给父 Activity 去处理。
# OnBackPressedDispatcher.java
private final OnBackPressedDispatcher mOnBackPressedDispatcher =
new OnBackPressedDispatcher(new Runnable() {//注释1:这里传入的就是 FallbackOnBackPressed
@Override
public void run() {
//注释2
ComponentActivity.super.onBackPressed();
}
});
到这里,整个OnBackPressedDispatcher
的操作思路就清晰很多了,如果不处理就交给父Activity去处理(注释2)。
那我们怎么HomeActivity判断是否要处理onBackPressed呢?
# 主页 HomeActivity.java
@Override
public void onBackPressed() {
//是否要处理onBackPressed
if(getOnBackPressedDispatcher().hasEnabledCallbacks()) {
super.onBackPressed();
}else{
//双击弹toast退出app的处理
ExitAppUtils.exitApp(this)
}
}
因为如果给OnBackPressedDispatcher
添加了监听器,那么数据的处理的结果肯定就不会交给当前HomeActivity的onBackPressed()了,那么这里原本的双击弹toast提示退出App的逻辑就无法触发了。
所以这里只要判断 hasEnabledCallbacks
才去处理这super.onBackPressed()
,否则事件还是交给当前的 HomeActivity 去处理。
记录于 2021年4月1日愚人节