Android Jetpack之Fragment里监听返回键的最佳写法

个人原创，转载请注明出处：https://www.jianshu.com/p/aec2cde0a5f0

Jetpack组件Navigation为Fragment添加了自动的返回栈管理，非常便于处理多个Fragment的相互跳转。但Fragment默认没有onBackPressed()方法，在按下返回键时无法处理除Fragment出栈以外的其他操作。下面给出几种Fragment里监听返回键代码，顺便探讨下该事件的最佳写法。

1. 给onBackPressedDispatcher添加回调

requireActivity().onBackPressedDispatcher
                .addCallback(viewLifecycleOwner, object: OnBackPressedCallback(true) {
                    override fun handleOnBackPressed() {
                        //Handle back event from any fragment 
                    }
                })

这个方法的最大弊病是不能在里面调用Activity的onBackPressed()（会产生循环），当Fragment不需要处理返回操作时不能向上传递到Activity，必须在Fragment里处理包括Activity在内的所有返回键操作，这对于Fragment的编写者来说很不友好，于是很快被我放弃了。我们希望Activity和Fragment各自的逻辑代码能分离开来。

2. 给rootView设置一个OnKeyListener来监听key事件

mRootView.setFocusable(true);
mRootView.setFocusableInTouchMode(true);
mRootView.setOnKeyListener { v, keyCode, event ->
    if (keyCode == KeyEvent.KEYCODE_BACK) {
        if (condition) {
            ...
        }else {
            activity.onBackPressed()
        }
        true
    }
    false
}

这段代码基本上能满足大部分要求，Activity和Fragment分别处理各自的返回操作，但任然有两个小问题。一是要在Fragment里获取到RootView，二是如果Activity和Fragment都需要对返回键做出反应，那么必须是优先触发Fragment的返回操作，而Activity不知道返回操作什么时候会被Fragment拦截！（当然也可以在Fragment里增加对Activity里元素的监听，但那样就违背了二者操作逻辑相互分离的初衷）

3. 给Fragment编写各自的onBackPressed()方法并在Activity的onBackPressed()里调用

乍一看，这样每次都要在Activity的onBackPressed()里判断当前是哪一个Fragment，并且还要判断该Fragment是否需要处理返回事件，这不是给Activity添麻烦么？其实不然，通过将给BaseFragment基类（如果没有就写一个）添加onBackPressed()方法这些都可以交给各Fragment自己完成。来看BaseFragment：

abstract class BaseFragment : Fragment() {

    ...

    protected val activity by lazy { getActivity() as MainActivity } 

    override fun onActivityCreated(savedInstanceState: Bundle?) {
        super.onActivityCreated(savedInstanceState)
        ...
        activity.currentFragment = this //currentFragment是Activity里定义的变量，用来持有当前Fragment
    }

    /**fragment拦截返回键返回true，不拦截返回false*/
    abstract fun onBackPressed(): Boolean
}

子类Fragment：

class ChildFragment : BaseFragment() {
    
    ...

    protected val activity by lazy { getActivity() as MainActivity } 

    override fun onBackPressed(): Boolean {
        if (condition) {
            ...
            return true //返回true表示消耗掉返回事件，Activity不再处理
        }else {
            return false //返回false不处理返回事件，交给Activity处理
        }            
    }
}

Activity：

class MainActivity : AppCompatActivity() {

    lateinit var  currentFragment : BaseFragment

    ...

    override fun onBackPressed() {
        when { 
            currentFragment.onBackPressed() -> {} /*Fragment处理了返回操作返回true，不再执行其他代码
                                                  Fragment不处理返回false，此时Activity里的其他代码发挥作用*/
            condition -> { ... }                            
            else -> super.onBackPressed()
        }
    }
}

这里用到了Java的动态绑定，通过在BaseFragment里获取到当前Fragment的实例以及子Fragment重写BaseFragment的onBackpressed()方法，使得Activity能自动调用当前Fragment的onBackpressed()方法。这种写法我认为是最优的，实现了Activity与Fragment返回逻辑代码的完全分离，Activity不需要知道Fragment具体干了什么，只需要知道结果（是否消耗掉事件），并且能通过调整condition的顺序来调整Activity与Fragment返回操作的优先级。唯一的缺点可能就是多了点代码量。

如果你有更好的写法，欢迎留言指出！