image

• 原標(biāo)題: Android Fragments: Fragment Result
• 原文地址: https://proandroiddev.com/android-fragments-fragment-result......
• 原文作者: Husayn Hakeem

就在 2020/05/07 號(hào) Now in Android #17 更新了，發(fā)布 Android 的新特性，其中就包括 Fragment 間通信的新方式回还，大家可以點(diǎn)擊這里前往囤攀，看看都有那些更新

通過(guò)這篇文章你將學(xué)習(xí)到以下內(nèi)容品洛，將在譯者思考部分會(huì)給出相應(yīng)的答案

• 新 Fragment 間通信的方式的使用裁赠？
• 新 Fragment 間通信的源碼分析问窃？
• 匯總 Fragment 之間的通信的方式峰髓？

譯文

Frrgament 間傳遞數(shù)據(jù)可以通過(guò)多種方式傻寂，包括使用 target Fragment APIs (Fragment.setTargetFragment() 和 Fragment.getTargetFragment())，ViewModel 或者 使用 Fragments’ 父容器 Activity携兵，target Fragment APIs 已經(jīng)過(guò)時(shí)了疾掰，現(xiàn)在鼓勵(lì)使用新的 Fragment result APIs 完成 Frrgament 之間傳遞數(shù)據(jù)，其中傳遞數(shù)據(jù)由 FragmentManager 處理徐紧，并且在 Fragments 設(shè)置發(fā)送數(shù)據(jù)和接受數(shù)據(jù)

在 Frrgament 之間傳遞數(shù)據(jù)

使用新的 Fragment APIs 在 兩個(gè) Frrgament 之間的傳遞静檬，沒(méi)有任何引用，可以使用它們公共的 FragmentManager并级，它充當(dāng) Frrgament 之間傳遞數(shù)據(jù)的中心存儲(chǔ)拂檩。

接受數(shù)據(jù)

如果想在 Fragment 中接受數(shù)據(jù)，可以在 FragmentManager 中注冊(cè)一個(gè) FragmentResultListener嘲碧，參數(shù) requestKey 可以過(guò)濾掉 FragmentManager 發(fā)送的數(shù)據(jù)

FragmentManager.setFragmentResultListener(
    requestKey,
    lifecycleOwner,
    FragmentResultListener { requestKey: String, result: Bundle ->
        // Handle result
    })

參數(shù) lifecycleOwner 可以觀察生命周期稻励，當(dāng) Fragment 的生命周期處于 STARTED 時(shí)接受數(shù)據(jù)。如果監(jiān)聽(tīng) Fragment 的生命周期愈涩，您可以在接收到新數(shù)據(jù)時(shí)安全地更新 UI望抽，因?yàn)?view 的創(chuàng)建(onViewCreated() 方法在 onStart() 之前被調(diào)用)。

image

當(dāng)生命周期處于 LifecycleOwner STARTED 的狀態(tài)之前钠署，如果有多個(gè)數(shù)據(jù)傳遞糠聪，只會(huì)接收到最新的值

image

當(dāng)生命周期處于 LifecycleOwner DESTROYED 時(shí)，它將自動(dòng)移除 listener谐鼎，如果想手動(dòng)移除 listener，需要調(diào)用 FragmentManager.setFragmentResultListener() 方法趣惠，傳遞空的 FragmentResultListener

image

在 FragmentManager 中注冊(cè) listener狸棍，依賴(lài)于 Fragment 發(fā)送返回的數(shù)據(jù)

• 如果在 FragmentA 中接受 FragmentB 發(fā)送的數(shù)據(jù)，F(xiàn)ragmentA 和 FragmentB 處于相同的層級(jí)味悄，通過(guò) parent FragmentManager 進(jìn)行通信草戈，F(xiàn)ragmentA 必須使用 parent FragmentManager 注冊(cè) listener

parentFragmentManager.setFragmentResultListener(...)

• 如果在 FragmentA 中接受 FragmentB 發(fā)送的數(shù)據(jù)，F(xiàn)ragmentA 是 FragmentB 的父容器侍瑟， 他們通過(guò) child FragmentManager 進(jìn)行通信

childFragmentManager.setFragmentResultListener(...)

listener 必須設(shè)置的Fragment 相同的 FragmentManager

發(fā)送數(shù)據(jù)

如果 FragmentB 發(fā)送數(shù)據(jù)給 FragmentA唐片，需要在 FragmentA 中注冊(cè) listener丙猬，通過(guò) parent FragmentManager 發(fā)送數(shù)據(jù)

parentFragmentManager.setFragmentResult(
    requestKey, // Same request key FragmentA used to register its listener
    bundleOf(key to value) // The data to be passed to FragmentA
)

測(cè)試 Fragment Results

測(cè)試 Fragment 是否成功接收或發(fā)送數(shù)據(jù)，可以使用 FragmentScenario API

接受數(shù)據(jù)

如果在 FragmentA 中注冊(cè) FragmentResultListener 接受數(shù)據(jù)费韭，你可以模擬 parent FragmentManager 發(fā)送數(shù)據(jù)茧球，如果在 FragmentA 中正確注冊(cè)了 listener，可以用來(lái)驗(yàn)證 FragmentA 是否能收到數(shù)據(jù)星持，例如抢埋，如果在 FragmentA 中接受數(shù)據(jù)并更新 UI, 可以使用 Espresso APIs 來(lái)驗(yàn)證是否期望的數(shù)據(jù)

@Test
fun shouldReceiveData() {
    val scenario = FragmentScenario.launchInContainer(FragmentA::class.java)

    // Pass data using the parent fragment manager
    scenario.onFragment { fragment ->
        val data = bundleOf(KEY_DATA to "value")
        fragment.parentFragmentManager.setFragmentResult("aKey", data)
    }

    // Verify data is received, for example, by verifying it's been displayed on the UI
   onView(withId(R.id.textView)).check(matches(withText("value"))) 
}

發(fā)送數(shù)據(jù)

可以在 FragmentB 的 parent FragmentManager 上注冊(cè)一個(gè) FragmentResultListener 來(lái)測(cè)試 FragmentB 是否成功發(fā)送數(shù)據(jù)，當(dāng)發(fā)送數(shù)據(jù)結(jié)束時(shí)督暂，可以來(lái)驗(yàn)證這個(gè) listener 是否能收到數(shù)據(jù)

@Test
fun shouldSendData() {
    val scenario = FragmentScenario.launchInContainer(FragmentB::class.java)

    // Register result listener
    var receivedData = ""
    scenario.onFragment { fragment ->
        fragment.parentFragmentManager.setFragmentResultListener(
            KEY,
            fragment,
            FragmentResultListener { key, result ->
                receivedData = result.getString(KEY_DATA)
            })
    }

    // Send data
    onView(withId(R.id.send_data)).perform(click())

    // Verify data was successfully sent
    assertThat(receivedData).isEqualTo("value")
}

示例項(xiàng)目

下面的示例項(xiàng)目揪垄，展示了如何使用 Fragment 新的 API

android-playground: https://github.com/husaynhakeem/android-playground...

總結(jié)

雖然使用了 Fragment result APIs，替換了過(guò)時(shí)的 Fragment target APIs逻翁，但是新的 APIs 在Bundle 作為數(shù)據(jù)傳傳遞方面有一些限制饥努，只能傳遞簡(jiǎn)單數(shù)據(jù)類(lèi)型、Serializable 和 Parcelable 數(shù)據(jù)八回，F(xiàn)ragment result APIs 允許程序從崩潰中恢復(fù)數(shù)據(jù)肪凛，而且不會(huì)持有對(duì)方的引用，避免當(dāng) Fragment 處于不可預(yù)知狀態(tài)的時(shí)辽社，可能發(fā)生未知的問(wèn)題

譯者的思考

這是譯者的一些思考伟墙，總結(jié)一下 Fragment 1.3.0-alpha04 新增加的 Fragment 間通信的 API

數(shù)據(jù)接受

FragmentManager.setFragmentResultListener(
    requestKey,
    lifecycleOwner,
    FragmentResultListener { requestKey: String, result: Bundle ->
        // Handle result
    })

數(shù)據(jù)發(fā)送

parentFragmentManager.setFragmentResult(
    requestKey, // Same request key FragmentA used to register its listener
    bundleOf(key to value) // The data to be passed to FragmentA
)

那么 Fragment 間通信的新 API 給我們帶來(lái)哪些好處呢：

• 在 Fragment 之間傳遞數(shù)據(jù)，不會(huì)持有對(duì)方的引用
• 當(dāng)生命周期處于 ON_START 時(shí)開(kāi)始處理數(shù)據(jù)滴铅，避免當(dāng) Fragment 處于不可預(yù)知狀態(tài)的時(shí)戳葵，可能發(fā)生未知的問(wèn)題
• 當(dāng)生命周期處于 ON_DESTROY 時(shí)，移除監(jiān)聽(tīng)

我們一起來(lái)從源碼的角度分析一下 Google 是如何做的

源碼分析

按照慣例從調(diào)用的方法來(lái)分析汉匙，數(shù)據(jù)接受時(shí)拱烁，調(diào)用了 FragmentManager 的 setFragmentResultListener 方法
androidx.fragment/fragment/1.3.0-alpha04......androidx/fragment/app/FragmentManager.java

private final ConcurrentHashMap<String, LifecycleAwareResultListener> mResultListeners =
        new ConcurrentHashMap<>();

@Override
public final void setFragmentResultListener(@NonNull final String requestKey,
                                            @NonNull final LifecycleOwner lifecycleOwner,
                                            @Nullable final FragmentResultListener listener) {
    // mResultListeners 是 ConcurrentHashMap 的實(shí)例，用來(lái)儲(chǔ)存注冊(cè)的 listener
    // 如果傳遞的參數(shù) listener 為空時(shí)噩翠，移除 requestKey 對(duì)應(yīng)的 listener
    if (listener == null) {
        mResultListeners.remove(requestKey);
        return;
    }

    // Lifecycle是一個(gè)生命周期感知組件戏自，一般用來(lái)響應(yīng)Activity、Fragment等組件的生命周期變化
    final Lifecycle lifecycle = lifecycleOwner.getLifecycle();
    // 當(dāng)生命周期處于 DESTROYED 時(shí)伤锚，直接返回
    // 避免當(dāng) Fragment 處于不可預(yù)知狀態(tài)的時(shí)擅笔，可能發(fā)生未知的問(wèn)題
    if (lifecycle.getCurrentState() == Lifecycle.State.DESTROYED) {
        return;
    }

    // 開(kāi)始監(jiān)聽(tīng)生命周期
    LifecycleEventObserver observer = new LifecycleEventObserver() {
        @Override
        public void onStateChanged(@NonNull LifecycleOwner source,
                                   @NonNull Lifecycle.Event event) {
            // 當(dāng)生命周期處于 ON_START 時(shí)開(kāi)始處理數(shù)據(jù)
            if (event == Lifecycle.Event.ON_START) {
                // 開(kāi)始檢查受到的數(shù)據(jù)
                Bundle storedResult = mResults.get(requestKey);
                if (storedResult != null) {
                    // 如果結(jié)果不為空，調(diào)用回調(diào)方法
                    listener.onFragmentResult(requestKey, storedResult);
                    // 清除數(shù)據(jù)
                    setFragmentResult(requestKey, null);
                }
            }

            // 當(dāng)生命周期處于 ON_DESTROY 時(shí)屯援，移除監(jiān)聽(tīng)
            if (event == Lifecycle.Event.ON_DESTROY) {
                lifecycle.removeObserver(this);
                mResultListeners.remove(requestKey);
            }
        }
    };
    lifecycle.addObserver(observer);
    mResultListeners.put(requestKey, new FragmentManager.LifecycleAwareResultListener(lifecycle, listener));
}

• Lifecycle是一個(gè)生命周期感知組件猛们，一般用來(lái)響應(yīng)Activity、Fragment等組件的生命周期變化
• 獲取 Lifecycle 去監(jiān)聽(tīng) Fragment 的生命周期的變化
• 當(dāng)生命周期處于 ON_START 時(shí)開(kāi)始處理數(shù)據(jù)狞洋，避免當(dāng) Fragment 處于不可預(yù)知狀態(tài)的時(shí)弯淘，可能發(fā)生未知的問(wèn)題
• 當(dāng)生命周期處于 ON_DESTROY 時(shí)，移除監(jiān)聽(tīng)

接下來(lái)一起來(lái)看一下數(shù)據(jù)發(fā)送的方法吉懊，調(diào)用了 FragmentManager 的 setFragmentResult 方法
androidx.fragment/fragment/1.3.0-alpha04......androidx/fragment/app/FragmentManager.java

private final ConcurrentHashMap<String, Bundle> mResults = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LifecycleAwareResultListener> mResultListeners =
        new ConcurrentHashMap<>();
    
@Override
public final void setFragmentResult(@NonNull String requestKey, @Nullable Bundle result) {
    if (result == null) {
        // mResults 是 ConcurrentHashMap 的實(shí)例庐橙，用來(lái)存儲(chǔ)數(shù)據(jù)傳輸?shù)?Bundle
        // 如果傳遞的參數(shù) result 為空假勿，移除 requestKey 對(duì)應(yīng)的 Bundle
        mResults.remove(requestKey);
        return;
    }

    // Check if there is a listener waiting for a result with this key
    // mResultListeners 是 ConcurrentHashMap 的實(shí)例，用來(lái)儲(chǔ)存注冊(cè)的 listener
    // 獲取 requestKey 對(duì)應(yīng)的 listener
    LifecycleAwareResultListener resultListener = mResultListeners.get(requestKey);
    if (resultListener != null && resultListener.isAtLeast(Lifecycle.State.STARTED)) {
        // 如果 resultListener 不為空态鳖，并且生命周期處于 STARTED 狀態(tài)時(shí)转培，調(diào)用回調(diào)
        resultListener.onFragmentResult(requestKey, result);
    } else {
        // 否則保存當(dāng)前傳輸?shù)臄?shù)據(jù)
        mResults.put(requestKey, result);
    }
}

• 獲取 requestKey 注冊(cè)的 listener
• 當(dāng)生命周期處于 STARTED 狀態(tài)時(shí)，開(kāi)始發(fā)送數(shù)據(jù)
• 否則保存當(dāng)前傳輸?shù)臄?shù)據(jù)

源碼分析到這里結(jié)束了郁惜，我們一起來(lái)思考一下堡距，在之前我們的都有那些數(shù)據(jù)傳方式

匯總 Fragment 之間的通信的方式

• 通過(guò)共享 ViewModel 或者關(guān)聯(lián) Activity來(lái)完成，F(xiàn)ragment 之間不應(yīng)該直接通信 參考 Google: ViewModel#sharing
• 通過(guò)接口兆蕉，可以在 Fragment 定義接口羽戒，并在 Activity 實(shí)現(xiàn)它 參考 Google: 與其他 Fragment 通信
• 通過(guò)使用 findFragmentById 方法，獲取 Fragment 的實(shí)例虎韵，然后調(diào)用 Fragment 的公共方法 參考 Google: 與其他 Fragment 通信
• 調(diào)用 Fragment.setTargetFragment() 和 Fragment.getTargetFragment() 方法易稠，但是注意 target fragment 需要直接訪問(wèn)另一個(gè) fragment 的實(shí)例，這是十分危險(xiǎn)的包蓝，因?yàn)槟悴恢滥繕?biāo) fragment 處于什么狀態(tài)
• Fragment 新的 API, setFragmentResult() 和 setFragmentResultListener()

綜合以上通信方式驶社，那么你認(rèn)為 Fragment 之間通信最好的方式是什么？

參考文獻(xiàn)

• Now in Android #17: https://medium.com/androiddeve......
• Pass data between fragments: https://developer.android.com/training/basi......
• ViewModel#sharing: https://developer.android.com/topic/librari......
• 與其他 Fragment 通信: https://developer.android.com/training/basic......

結(jié)語(yǔ)

致力于分享一系列 Android 系統(tǒng)源碼测萎、逆向分析亡电、算法、翻譯相關(guān)的文章硅瞧，目前正在翻譯一系列歐美精選文章份乒，不僅僅是翻譯，還有翻譯背后對(duì)每篇文章思考腕唧，如果你喜歡這片文章或辖，請(qǐng)幫我點(diǎn)個(gè)贊，感謝枣接，期待與你一起成長(zhǎng)

文章列表

Android 10 源碼系列

• 0xA01 Android 10 源碼分析：APK 是如何生成的
• 0xA02 Android 10 源碼分析：APK 的安裝流程
• 0xA03 Android 10 源碼分析：APK 加載流程之資源加載
• 0xA04 Android 10 源碼分析：APK 加載流程之資源加載（二）
• 0xA05 Android 10 源碼分析：Dialog 加載繪制流程以及在 Kotlin颂暇、DataBinding 中的使用
• 0xA06 Android 10 源碼分析：WindowManager 視圖綁定以及體系結(jié)構(gòu)

工具系列

• 為數(shù)不多的人知道的 AndroidStudio 快捷鍵(一)
• 為數(shù)不多的人知道的 AndroidStudio 快捷鍵(二)
• 關(guān)于 adb 命令你所需要知道的
• 如何高效獲取視頻截圖
• 10分鐘入門(mén) Shell 腳本編程
• 如何在項(xiàng)目中封裝 Kotlin + Android Databinding

逆向系列

• 基于 Smali 文件 Android Studio 動(dòng)態(tài)調(diào)試 APP
• 解決在 Android Studio 3.2 找不到 Android Device Monitor 工具