Fragment之间进行通信的最佳实现方式

前言

在Android应用程序中，片段（Fragments）是一种组件，用于构建灵活且可重用的用户界面。然而，当在应用程序中使用多个片段时，它们之间的通信变得非常重要。本文将介绍在Android应用程序中实现片段之间和片段与宿主活动之间通信的方式

使用ViewModel进行通信

ViewModel是一种Android架构组件，用于在活动（Activity）和片段之间共享和管理数据。它提供了一种有效的方式，可以将数据存储在内存中，以便在配置更改（如屏幕旋转）或片段之间的切换时保持数据的一致性。

使用ViewModel可以方便地在多个片段之间共享数据，也可以在片段和它们的宿主活动之间共享数据。下面是一个示例，展示了如何使用ViewModel在片段和宿主活动之间共享数据：

// ViewModel
class MainViewModel : ViewModel() {
    private val mutableSelectedItem = MutableLiveData<Item>()
    val selectedItem: LiveData<Item> get() = mutableSelectedItem

    fun selectItem(item: Item) {
        mutableSelectedItem.value = item
    }
}

// 宿主活动
class MainActivity : AppCompatActivity() {
    private val viewModel: MainViewModel by viewModels()

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

        viewModel.selectedItem.observe(this, Observer { item ->
            // 执行操作
        })
    }
}

// 片段
class MainFragment : Fragment() {
    private val viewModel: MainViewModel by activityViewModels()

    // 当项目被点击时调用
    fun onItemClicked(item: Item) {
        // 设置一个新的项目
        viewModel.selectItem(item)
    }
}

在这个示例中，宿主活动和片段都可以通过ViewModel来共享和观察数据。它们使用by viewModels()和by activityViewModels()来获取ViewModel实例，确保它们使用的是相同的ViewModel对象。

在片段之间共享数据

当在同一个活动中使用多个片段时，这些片段之间通常需要进行通信。为了实现片段之间的通信，可以使用宿主活动作为ViewModel的范围，让这些片段共享同一个ViewModel实例。下面是一个示例，展示了如何使用共享ViewModel在两个片段之间进行通信：

// ViewModel
class MainViewModel : ViewModel() {
    val filters = MutableLiveData<Set<Filter>>()

    // ...其他逻辑...
}

// 片段 A
class ListFragment : Fragment() {
    private val viewModel: MainViewModel by activityViewModels()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        viewModel.filteredList.observe(viewLifecycleOwner, Observer { list ->
            // 执行操作
        })
    }
}

// 片段 B
class FilterFragment : Fragment() {
    private val viewModel: MainViewModel by activityViewModels()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        viewModel.filters.observe(viewLifecycleOwner, Observer { set ->
            // 更新选定的过滤器UI
        })
    }

    fun onFilterSelected(filter: Filter) = viewModel.addFilter(filter)
    fun onFilterDeselected(filter: Filter) = viewModel.removeFilter(filter)
}

在这个示例中，片段A和片段B都使用宿主活动作为ViewModel的范围。它们通过获取相同的ViewModel实例来实现数据的共享和通信。

在父子片段之间共享数据

当使用子片段时，父片段和其子片段可能需要共享数据。为了在父子片段之间共享数据，可以使用父片段作为ViewModel的范围。下面是一个示例，展示了如何在父片段和子片段之间共享数据：

// 父片段
class ListFragment : Fragment() {
    private val viewModel: MainViewModel by viewModels()

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        viewModel.filteredList.observe(viewLifecycleowner, Observer { list ->
            // 更新列表UI
        })
    }
}

// 子片段
class ChildFragment : Fragment() {
    private val viewModel: MainViewModel by viewModels({ requireParentFragment() })

    // ...其他逻辑...
}

在这个示例中，子片段通过by viewModels({ requireParentFragment() })来获取父片段的ViewModel实例。这样，父子片段之间就可以共享并观察同一个ViewModel中的数据。

使用导航图对ViewModel进行作用域限定

如果你正在使用导航库（Navigation library），你还可以将ViewModel限定在目标NavBackStackEntry的生命周期范围内。例如，可以将ViewModel的作用域限定在ListFragment的NavBackStackEntry上，如下所示：

// ListFragment
class ListFragment : Fragment() {
    private val viewModel: ListViewModel by navGraphViewModels(R.id.list_fragment)

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        viewModel.filteredList.observe(viewLifecycleOwner, Observer { item ->
            // 更新列表UI
        })
    }
}

在这个示例中，通过使用navGraphViewModels()从fragment-ktx库中检索ViewModel，将ViewModel的作用域限定在ListFragment的NavBackStackEntry上。这样，ViewModel的生命周期将与ListFragment的导航生命周期保持一致。

使用Fragment Result API进行通信

在Fragment 1.3.0及更高版本中，每个FragmentManager都实现了FragmentResultOwner接口。这意味着FragmentManager可以作为一个中央存储器来存储片段结果。这种改变使得组件可以通过设置片段结果和监听这些结果来相互通信，而无需这些组件直接引用对方。

要将数据传递回片段A，首先在接收结果的片段A上设置一个结果监听器。在片段A的FragmentManager上调用setFragmentResultListener()方法即可。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    // Use the Kotlin extension in the fragment-ktx artifact.
    setFragmentResultListener("requestKey") { requestKey, bundle ->
        // We use a String here, but any type that can be put in a Bundle is supported.
        val result = bundle.getString("bundleKey")
        // Do something with the result.
    }
}

button.setOnClickListener {
    val result = "result"
    // Use the Kotlin extension in the fragment-ktx artifact.
    setFragmentResult("requestKey", bundleOf("bundleKey" to result))
}

接收结果：

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        supportFragmentManager
                .setFragmentResultListener("requestKey", this) { requestKey, bundle ->
            // We use a String here, but any type that can be put in a Bundle is supported.
            val result = bundle.getString("bundleKey")
            // Do something with the result.
        }
    }
}

以上是在Android应用程序中实现片段之间和片段与宿主活动之间通信的方式。根据具体的使用场景，可以选择使用ViewModel进行通信，或者使用Fragment Result API进行通信。这些方法都提供了灵活且可靠的方式来实现片段之间的通信，使得Android应用程序的开发更加高效和可维护。