导航架构组件 - 对话框片段

Navigation Architecture Component - Dialog Fragments

是否可以将新的导航架构组件与 DialogFragment 一起使用?我必须创建自定义导航器吗?

我很乐意将它们与我的导航图中的新功能一起使用。

不,从 1.0.0-alpha01 版本开始,不支持将对话框作为导航图的一部分。您应该继续使用 show() 来显示 DialogFragment.

我为 DialogFragment 创建了自定义导航器。

样本为 here
(这只是示例,所以可能会有任何问题。)

@Navigator.Name("dialog_fragment")
class DialogNavigator(
    private val fragmentManager: FragmentManager
) : Navigator<DialogNavigator.Destination>() {

    companion object {
        private const val TAG = "dialog"
    }

    override fun navigate(destination: Destination, args: Bundle?, 
            navOptions: NavOptions?, navigatorExtras: Extras?) {
        val fragment = destination.createFragment(args)
       fragment.setTargetFragment(fragmentManager.primaryNavigationFragment, 
               SimpleDialogArgs.fromBundle(args).requestCode)
        fragment.show(fragmentManager, TAG)
        dispatchOnNavigatorNavigated(destination.id, BACK_STACK_UNCHANGED)
    }

    override fun createDestination(): Destination {
        return Destination(this)
    }

    override fun popBackStack(): Boolean {
        return true
    }

    class Destination(
            navigator: Navigator<out NavDestination>
    ) : NavDestination(navigator) {

        private var fragmentClass: Class<out DialogFragment>? = null

        override fun onInflate(context: Context, attrs: AttributeSet) {
            super.onInflate(context, attrs)
            val a = context.resources.obtainAttributes(attrs,
                    R.styleable.FragmentNavigator)
            a.getString(R.styleable.FragmentNavigator_android_name)
                    ?.let { className ->
                fragmentClass = parseClassFromName(context, className, 
                        DialogFragment::class.java)
            }
            a.recycle()
        }

        fun createFragment(args: Bundle?): DialogFragment {
            val fragment = fragmentClass?.newInstance()
                ?: throw IllegalStateException("fragment class not set")
            args?.let {
                fragment.arguments = it
            }
            return fragment
        }
    }
}

是的,您可以通过调用 getParentFragment().getView() 从对话框片段访问父片段的视图。并使用视图进行导航。

示例如下

Navigation.findNavController(getParentFragment().getView()).navigate(R.id.nextfragment);

。该框架的制作方式使您可以创建一个 class 扩展 Navigator 摘要 class 用于未开箱即用的视图并将其添加到您的 NavController 用方法 getNavigatorProvider().addNavigator(Navigator navigator)

如果您正在使用 NavHostFragment,您还需要扩展它以添加自定义导航器,或者创建您自己的 MyFragment 实现 NavHost 界面。它非常灵活,您可以使用 values 中定义的自定义属性创建自己的 xml 参数,就像创建自定义视图一样。像这样(未测试):

@Navigator.Name("dialog-fragment")
class DialogFragmentNavigator(
        val context: Context,
        private val fragmentManager: FragmentManager
) : Navigator<DialogFragmentNavigator.Destination>() {

    override fun navigate(destination: Destination, args: Bundle?,
                          navOptions: NavOptions?, navigatorExtras: Extras?
    ): NavDestination {
        val fragment = Class.forName(destination.name).newInstance() as DialogFragment
        fragment.show(fragmentManager, destination.id.toString())
        return destination
    }

    override fun createDestination(): Destination = Destination(this)

    override fun popBackStack() = fragmentManager.popBackStackImmediate()

    class Destination(navigator: DialogFragmentNavigator) : NavDestination(navigator) {

        // The value of <dialog-fragment app:name="com.example.MyFragmentDialog"/>
        lateinit var name: String

        override fun onInflate(context: Context, attrs: AttributeSet) {
            super.onInflate(context, attrs)
            val a = context.resources.obtainAttributes(
                    attrs, R.styleable.FragmentNavigator
            )
            name = a.getString(R.styleable.FragmentNavigator_android_name)
                    ?: throw RuntimeException("Error while inflating XML. " +
                            "`name` attribute is required")
            a.recycle()
        }
    }
}

用法

my_navigation.xml

<?xml version="1.0" encoding="utf-8"?>
<navigation 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:id="@+id/navigation"
    app:startDestination="@id/navigation_home">

    <fragment
        android:id="@+id/navigation_assistant"
        android:name="com.example.ui.HomeFragment"
        tools:layout="@layout/home">
        <action
            android:id="@+id/action_nav_to_dialog"
            app:destination="@id/navigation_dialog" />
    </fragment>

    <dialog-fragment
        android:id="@+id/navigation_dialog"
        android:name="com.example.ui.MyDialogFragment"
        tools:layout="@layout/my_dialog" />

</navigation>    

将导航的片段。

class HomeFragment : Fragment(), NavHost {

    private val navControllerInternal: NavController by lazy(LazyThreadSafetyMode.NONE){
        NavController(context!!)
    }

    override fun getNavController(): NavController = navControllerInternal

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        // Built-in navigator for `fragment` XML tag
        navControllerInternal.navigatorProvider.addNavigator(
            FragmentNavigator(context!!, childFragmentManager, this.id)
        )
        // Your custom navigator for `dialog-fragment` XML tag
        navControllerInternal.navigatorProvider.addNavigator(
            DialogFragmentNavigator(context!!, childFragmentManager)
        )
        navControllerInternal.setGraph(R.navigation.my_navigation)
    }

    override fun onCreateView(inflater: LayoutInflater, 
                              container: ViewGroup?, savedInstanceState: Bundle?): View? {
        super.onCreateView(inflater, container, savedInstanceState)
        val view = inflater.inflate(R.layout.home)
        view.id = this.id

        view.button.setOnClickListener{
            getNavController().navigate(R.id.action_nav_to_dialog)
        }

        return view
    }
}

一种选择是只使用常规片段并使其看起来类似于对话框。我发现这不值得麻烦,所以我使用标准方法使用 show()。如果你坚持 See here 的方法。

2019 年 5 月更新

DialogFragment are now fully supported starting from Navigation 2.1.0, you can read more here and here

导航的旧答案 <= 2.1.0-alpha02:

我是这样处理的:

1) 至少将 Navigation 库更新到 2.1.0-alpha01 版本,并将此 modified gist 的两个文件复制到您的项目中。

2) 然后在您的导航主机片段中,将 name 参数更改为您自定义的 NavHostFragment

<fragment
    android:id="@+id/nav_host_fragment"
    android:name="com.example.app.navigation.MyNavHostFragment"
    app:defaultNavHost="true"
    app:navGraph="@navigation/nav_graph"
    android:layout_width="0dp"
    android:layout_height="0dp"
    app:layout_constraintBottom_toBottomOf="parent"
    app:layout_constraintEnd_toEndOf="parent"
    app:layout_constraintStart_toStartOf="parent"
    app:layout_constraintTop_toBottomOf="@id/toolbar" />

3) 创建您的 DialogFragment 子类并将它们添加到您的 nav_graph.xml 中:

<dialog
    android:id="@+id/my_dialog"
    android:name="com.example.ui.MyDialogFragment"
    tools:layout="@layout/my_dialog" />

4) 现在从片段或 activity 使用

启动它们
findNavController().navigate(R.id.my_dialog)

或类似方法。

Version 2.1.0-alpha03 已发布,因此我们终于可以使用 DialogFragments。对我来说不幸的是,在使用可取消对话框时,我在后台堆栈方面遇到了一些问题。可能我的对话框实现有误..

[LATER-EDIT] 我的实现很好,问题与 issue tracker 中描述的 DialogFragmentNavigator 的错误对话计数有关 作为解决方法,您可以看看 on my recommendation

是的,现在可以了。在它的初始版本中这是不可能的,但现在 来自“androidx.navigation:navigation-fragment:2.1.0-alpha03”这个导航版本你可以在导航组件中使用对话框片段。

看看这个:- Naviagtion dialog fragment support

更新时间:

implementation "androidx.navigation:navigation-ui-ktx:2.2.0-rc04"

并在my_nav_graph.xml

中使用
<dialog
android:id="@+id/my_dialog"
android:name="com.example.ui.MyDialogFragment"
tools:layout="@layout/my_dialog" />

是的。在导航组件的最新更新中是可能的。您可以查看此 link 以获得清晰的概念。 raywenderlich.com