【背上Jetpack之OnBackPressedDispatcher】Fragment 返回栈预备篇

这两天在准备写 fragment 返回栈的文章,但是发现必须先介绍一下 OnBackPressedDispatcher ,所以这是一篇介绍 what 的文章,喜欢一手资料的可以移步 官方文档

系列文章

【背上Jetpack】Jetpack 主要组件的依赖及传递关系

【背上Jetpack】AdroidX下使用Activity和Fragment的变化

【背上Jetpack之Fragment】你真的会用Fragment吗?Fragment常见问题以及androidx下Fragment的使用新姿势

【背上Jetpack之Fragment】从源码角度看 Fragment 生命周期 AndroidX Fragment1.2.2源码分析

When

OnBackPressedDispatcherandroidx activity 1.0.0 加入,旨在处理返回逻辑。您不仅可以获得在 Activity 之外处理返回键的便捷方式。 根据您的需要,您可以在任意位置定义 OnBackPressedCallback,使其可复用,或根据应用程序的架构进行任何操作。 您不再需要重写Activity 中的 onBackPressed 方法,也不必提供自己的抽象的来实现需求的代码。

OnBackPressedDispatcher

What

ComponentActivityFragmentActivityAppCompatActivity 的基类,它使您可以通过使用其 OnBackPressedDispatcher(可以通过调用 getOnBackPressedDispatcher() )来控制返回按钮的行为。

ComponentActivity-onBackPressed

OnBackPressedDispatcher 控制如何将返回按钮事件分配给一个或多个OnBackPressedCallback 对象。 OnBackPressedCallback 的构造函数将布尔值用于初始启用状态。 仅当启用了回调(即 isEnabled() 返回true)时,调度程序才会调用回调的handleOnBackPressed() 来处理返回按钮事件。 您可以通过调用 setEnabled() 来更改启用状态。

回调是通过 addCallback 方法添加的。 强烈建议使用采用 LifecycleOwner 的addCallback() 方法。 这样可以确保仅在 LifecycleOwner 为 Lifecycle.State.STARTED 时才添加OnBackPressedCallback。 当关联的 LifecycleOwner 被销毁时,该 activity 会删除已注册的回调,以防止内存泄漏,并使其适用于寿命比该 activity 短的 fragment 或其他生命周期所有者。

下面是一个示例

class MyFragment : Fragment() {

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

        //此 callback 仅当 MyFragment 至少是 Started 状态下调用
        val callback = requireActivity().onBackPressedDispatcher.addCallback(this) {
            //拦截返回事件
        }

        //此 callback 可以在这里或者上面的 lambda 中开启和关闭
    }
    ...
}

您可以通过 addCallback() 提供多个回调。 这样做时,将按照添加回调的相反顺序调用回调,即最后添加的回调是第一个给予处理返回按钮事件的机会的回调。 例如,如果您依次添加了三个分别名为1、2和3的回调,则将分别以3、2和1的顺序调用它们。

回调遵循“责任链”模式。 仅当未启用前一个回调时,才调用链中的每个回调。 这意味着在前面的示例中,仅当未启用回调3时,才会调用回调2。 仅当未启用回调2时,才调用回调1,依此类推。

请注意,通过 addCallback() 添加回调时,直到 LifecycleOwner 进入Lifecycle.State.STARTED 状态,才将回调添加到责任链中。

强烈建议更改 OnBackPressedCallback 的启用状态以进行临时更改(即更改 isEnabled 的值),因为它可以保持上述顺序,如果您在多个不同的嵌套生命周期所有者上注册了回调,这尤其重要。

但是,如果要完全删除 OnBackPressedCallback,则应调用 remove()。 但是,这通常不是必需的,因为在销毁关联的 LifecycleOwner 时会自动删除其回调。

Activity onBackPressed()

如果您使用 onBackPressed() 处理返回按钮事件,建议您改用 OnBackPressedCallback 。 但是,如果您无法进行此更改,则适用以下规则:

  • 当您调用 super.onBackPressed() 时,将通过 addCallback 注册的所有回调。

  • 无论 OnBackPressedCallback 的任何注册实例,始终会调用 onBackPressed

Demo

关于 fragment 返回栈的 demo 已经写好了,感兴趣的小伙伴可以 在这 找到它。

我们下一篇再见。


关于我


我是 Fly_with24

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 141,558评论 1 298
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 60,739评论 1 254
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 93,327评论 0 211
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,752评论 0 174
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,452评论 1 252
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,617评论 1 171
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,286评论 2 267
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,083评论 0 165
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,839评论 6 227
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,413评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,186评论 2 213
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,506评论 1 223
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,171评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,049评论 2 213
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,417评论 3 202
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,588评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 25,942评论 0 163
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,392评论 2 228
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,499评论 2 229

推荐阅读更多精彩内容