使用onBackPressedDispatcher处理Fragment的返回操作

SPA应用是很早就被提出来的一个理念,对应Android应用来上,旨在用单Activity+n个Fragment作为整个app的页面结构.
相应的SPA框架也出现了很多,笔者用过的有YoKey大神的Fragmentation,提供了许多多友好的api,来完成SPA应用,但是前不久,Fragmentation的GitHub主页已经贴出: 不再更新.
好在谷歌推出了JetPack组件,其中的Navigation,也能实现SPA应用的页面结构,但是我们都知道,fragment是没有提供与Activity的onBackPressed()类似的API的,所以就产生了很多的奇思妙想,来解决:如何处理Fragment里的返回操作.
比如
JetPack+单Activity的一些思路(https://www.jianshu.com/p/1560de5422ca)

插播小广告:这篇博客讲的项目有很多厉害的地方:比如单页面应用的实现,登录页/注册页的动画翻转切换等等,非常值得学习

这篇博客就提供了一种解决思路:
在RootActivity里,持有当前显示的Fragment的引用,并在BaseFragment里定义抽象方法onBackpressed()Boolean,在RootActivity里处理onBackPress(),先判断当前Fragment的onBackPressed()是否消费了返回事件

abstract class BaseFragment : Fragment() {

  /**
   * 提供AppCompatActivity实例
   */
  protected lateinit var mActivity: RootActivity

  override fun onAttach(context: Context) {
    super.onAttach(context)
    if (context is RootActivity) {
        mActivity = context
    }
  }
  ... ...
  /**
   * 是否拦截返回键 默认不拦截
   */
  open fun onBackPressed() = false

  override fun onActivityCreated(savedInstanceState: Bundle?) {
    super.onActivityCreated(savedInstanceState)
    mActivity.currentFragment = this
  }

}

class RootActivity : AppCompatActivity() {

  lateinit var currentFragment:BaseFragment

  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_root)
    //如果已登录 跳转到首页
    if (!getSharedPreferences(
            Config.COOKIE_FILE,
            Context.MODE_PRIVATE
        ).getStringSet(Config.COOKIE_KEY, null).isNullOrEmpty()
    ) {
        Navigation.findNavController(this, R.id.activityRootFragment)
            .navigate(R.id.action_login_to_home)
    }
  }

  /**
   * 实体返回键的处理
   */
  override fun onBackPressed() {
    when{
        currentFragment.onBackPressed() -> {}
        else -> super.onBackPressed()
    }
  }
}

这固然是一种方便而优雅的解决办法,但是,笔者前几天在读这篇文字的时候发现,又有一种新的解决办法,这是谷歌开发者发表在知乎专栏内的一篇文字:Fragment 的过去、现在和将来

个种讲解了Google对fragment的诸多开发规划.
关于fragment的一些kotlin扩展方法,在'androidx.fragment:fragment-ktx:1.2.4'这个扩展包里面,提供了若干操作fragment的扩展方法,比如下面这种添加fragment的方法:

        supportFragmentManager.commit {
              add(R.id.container, XXXFragmetn())
        }

但是我们关注的重点不在这里,而是文章中,对Fragment中处理返回事件的讲解,这就正式引出: OnBackPressDispatcher

OnBackPressDispatcher是ComponentActivity里的API,ComponentActivity在androidx.activity包下面,你可能会产生疑问:为什么谷歌官方没有给Fragment添加这个API,反倒是放到了Activity里,对此,官方的解释为:任何组件都可以通过依赖 Activity 来处理回退事件。

接下来我们来实现下面的一个功能:
主Activity里面,加载一个Fragment,在按下返回键尝试退出应用时,弹窗提示,确认弹窗,执行退出操作,我们先上代码:

Activity

class FragXActivity : AppCompatActivity(R.layout.activity_frag_x) {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
    }

    override fun onBackPressed() {
        super.onBackPressed()
        log("FragXActivity onBackPressed invoke")
    }
}

xml:activity_frag_x

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".FragXActivity ">

    <androidx.fragment.app.FragmentContainerView
        android:id="@+id/frag_container"
        android:name="com.xxxxxx.fragment20200623.MyFragment"
        android:layout_width="0dp"
        android:layout_height="0dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

Fragment

class MyFragment : Fragment() {

    val dispatcher by lazy {
        requireActivity().onBackPressedDispatcher
    }

    var callback: OnBackPressedCallback = object : OnBackPressedCallback(true) {
        override fun handleOnBackPressed() {
            log("MyFragment OnBackPressCallback handleOnBackPressed invoke")
            showDialog()
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        dispatcher.addCallback(this, callback)
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
    ): View = inflater.inflate(R.layout.frag_my, container, false)


    fun showDialog() {
        AlertDialog.Builder(requireContext())
            .setTitle("提示")
            .setMessage("确认退出吗?")
            .setNegativeButton("取消", object : DialogInterface.OnClickListener {
                override fun onClick(dialog: DialogInterface?, which: Int) {
                    log("取消了 退出弹窗")
                }
            })
            .setPositiveButton("确定", object : DialogInterface.OnClickListener {
                override fun onClick(dialog: DialogInterface?, which: Int) {
                    log("确定退出")
                    dialog?.dismiss()
                    onConfirmExitDialog()
                }
            })
            .show()
    }

    fun onConfirmExitDialog() {
        /*
        注意: 这里必须先把callback置为disable,否则会造成:死循环调用
        因为:
        dispatch.onBackPrssed()里面,会遍历所有的 OnBackPressedCallback
        发现有enable的callback会先把退出事件,传递给callback执行
        if (callback.isEnabled()) {
                callback.handleOnBackPressed();
                return;
            }
        */
        callback.isEnabled = false
        dispatcher.onBackPressed()
    }

}

xml:frag_my

<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="MyFragment"
        android:textColor="@color/colorAccent"
        android:textSize="30sp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

下面来分块解释一下:

Activity中,没什么好说的,就是在onBackPress里打印量一条日志,方便观察.
Activity的xml里,要简单插播一下:FragmentContainerView,继承自FrameLayout,允许我们通过其name属性来attach一个Fragment,但是注意,id属性是必须赋值的,否则会报错,过多的我们不赘述,毕竟与本篇内容关系不大
Fragment,这是重点要说明的地方:
首先,通过requireActivity().onBackPressedDispatcher拿到了fragment所依附的Activity的OnBackPressedDispatcher,

这里插播一下,requireActivity是一系列方法其中之一,包括:

fragment_requireXXX系列方法.png

requireHost() requireContext requireActivity() requireArguments() requireParentFragment() requireView()这些方法,可以帮助我们断言所需的变量不为null,从而避免kotlin的非空判断,但是,如果确实为null的话,则会直接抛出异常.上面的方法,都是androidx.fragment.Fragment里的方法,
而require(boolean) require(boolean,lambda) requireNotNull(t) requireNotNull(t,lambda) 这四个方法,则是Kotlin在org.jetbrains.kotlin;lotlin-stdlib-common:1.2.72@jar里所提供的扩展方法

然后我们通过dispatcher.addCallback(this, callback)把我们声明在Fragment的OnBackPressCallback实例,与OnBackPressDispatcher关联起来,其中,第一个参数this,是作为LifecycleOwner传入的,其目的是保证OnBackPressCallback被回调时,其所在的Fragment(其实是LifecycleOwner)生命周期处于活跃状态,如果不是,则不必把这个callback加入Callback池内, 当然这里传入的LifeCycleOwner还有在纷发"返回事件"时,起到了作用,这里我不多赘言,可以自己点进源码查看一看便知
具体见下面源码:

    public void addCallback(@NonNull LifecycleOwner owner,
            @NonNull OnBackPressedCallback onBackPressedCallback) {
        Lifecycle lifecycle = owner.getLifecycle();
        if (lifecycle.getCurrentState() == Lifecycle.State.DESTROYED) {
            return;
        }

        onBackPressedCallback.addCancellable(
                new LifecycleOnBackPressedCancellable(lifecycle, onBackPressedCallback));
    }

随后,我们在OnBackPressCallback的回调里,弹出一个AlerDialog,并在AlertDialog的确认按钮回调中,先把我们的OnBackPressCallback的Enable状态置为false(注意:这里如果不置为false,会造成死循环调用),而后,通过dispatcher.onBackPressed() 把"返回事件",交还给Activty.
至此就是实现了在Fragment里拦截返回事件

*xml:frag_my 这个没有什么好说的,就一个TextView而已

整个事件的处理流程,和View的Touch的Touch事件和OnTouchListener类似.

最终,项目运行效果如下:

screenShot.gif

下面来简单的看一下源码

ComponentActivity的onBackPressed方法:


    /**
     * Called when the activity has detected the user's press of the back
     * key. The {@link #getOnBackPressedDispatcher() OnBackPressedDispatcher} will be given a
     * chance to handle the back button before the default behavior of
     * {@link android.app.Activity#onBackPressed()} is invoked.
     *
     * @see #getOnBackPressedDispatcher()
     */
    @Override
    @MainThread
    public void onBackPressed() {
        mOnBackPressedDispatcher.onBackPressed();
    }

当activity接收到:用户按下了返回键时,回调此方法,方法内会先把返回事件,交给OnBackPressedDispatcher处理,而后才会轮到 {@link android.app.Activity#onBackPressed()}处理

OnBackPressedDispatcher的onBackPressed()方法

    /**
     * Trigger a call to the currently added {@link OnBackPressedCallback callbacks} in reverse
     * order in which they were added. Only if the most recently added callback is not
     * {@link OnBackPressedCallback#isEnabled() enabled}
     * will any previously added callback be called.
     * <p>
     * It is strongly recommended to call {@link #hasEnabledCallbacks()} prior to calling
     * this method to determine if there are any enabled callbacks that will be triggered
     * by this method as calling this method.
     */
    @MainThread
    public void onBackPressed() {
        Iterator<OnBackPressedCallback> iterator =
                mOnBackPressedCallbacks.descendingIterator();
        while (iterator.hasNext()) {
            OnBackPressedCallback callback = iterator.next();
            if (callback.isEnabled()) {
                callback.handleOnBackPressed();
                return;
            }
        }
        if (mFallbackOnBackPressed != null) {
            mFallbackOnBackPressed.run();
        }
    }

安卓 OnBackPressedCallback 被加入Callback池的倒叙,依次回调它们,只有最后加入Callback池的OnBackPressedCallback 的isEnable为false时,之前加入的Callback才会被回调,也就是说:只有最后被加入的且状态为Enable的OnBackPressedCallback 会被纷发退出事件,前面被加入的即使是Enable状态,也不会被纷发
这部分代码

            if (callback.isEnabled()) {
                callback.handleOnBackPressed();
                return;
            }

也解释了我们为什么要先把我们自己的OnBackPressedCallback的Enable状态置为false,再调用dispatcher.onBackPressed(),因为如果不置为false,就会我们自己的OnBackPressedCallback会无限次的被回调

Runnable mFallbackOnBackPressed 的run()方法:

这要到ComponentActivity里面来寻找

    private final OnBackPressedDispatcher mOnBackPressedDispatcher =
            new OnBackPressedDispatcher(new Runnable() {
                @Override
                public void run() {
                    ComponentActivity.super.onBackPressed();
                }
            });

可以看到:run()方法里调用的是:ComponentActivity.super.onBackPressed();,这个onBackPressed()方法,就是最原始的android.app.Activity里面的onBackPress()方法,我们就不多分析了.

好了,以上就是对于OnBackPressedDispatcher的一些简单介绍...