文章

[摘]DialogFragment 使用总结

文章目录

本想自己总结一下,但发现有网友已经整理,而且还不错。本文摘抄于《Android 必知必会 - DialogFragment 使用总结

背景

Android 官方推荐使用 DialogFragment 来代替 Dialog ,可以让它具有更高的可复用性(降低耦合)和更好的便利性(很好的处理屏幕翻转的情况)。

而创建 DialogFragment 有两种方式:

  1. 覆写其 onCreateDialog 方法 — ①
  2. 覆写其 onCreateView 方法 — ②

虽然这两种方式都能实现相同的效果,但是它们各有自己适合的应用场景:

  1. 方法 ①,一般用于创建替代传统的 Dialog 对话框的场景,UI 简单,功能单一。
  2. 方法 ②,一般用于创建复杂内容弹窗或全屏展示效果的场景,UI 复杂,功能复杂,一般有网络请求等异步操作。

应用

基本用法

对于方法 ①,创建一个 Dialog 并返回它即可:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> Dialog <span class="hljs-title">onCreateDialog</span>(Bundle savedInstanceState) {
    <span class="hljs-comment">//为了样式统一和兼容性,可以使用 V7 包下的 AlertDialog.Builder</span>
    AlertDialog.Builder builder = <span class="hljs-keyword">new</span> AlertDialog.Builder(getActivity());
    <span class="hljs-comment">// 设置主题的构造方法</span>
    <span class="hljs-comment">// AlertDialog.Builder builder = new AlertDialog.Builder(getActivity(), R.style.CustomDialog);</span>
    builder.setTitle(<span class="hljs-string">"注意:"</span>)
           .setMessage(<span class="hljs-string">"是否退出应用?"</span>)
           .setPositiveButton(<span class="hljs-string">"确定"</span>, <span class="hljs-keyword">null</span>)
           .setNegativeButton(<span class="hljs-string">"取消"</span>, <span class="hljs-keyword">null</span>)
           .setCancelable(<span class="hljs-keyword">false</span>);
           <span class="hljs-comment">//builder.show(); // 不能在这里使用 show() 方法</span>
    <span class="hljs-keyword">return</span> builder.create();
}

当然,你也可以使用自定义 View 来创建:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> Dialog <span class="hljs-title">onCreateDialog</span>(Bundle savedInstanceState) {
    AlertDialog.Builder builder = <span class="hljs-keyword">new</span> AlertDialog.Builder(getActivity());
    <span class="hljs-comment">// 设置主题的构造方法</span>
    <span class="hljs-comment">// AlertDialog.Builder builder = new AlertDialog.Builder(getActivity(), R.style.CustomDialog);</span>
    LayoutInflater inflater = getActivity().getLayoutInflater();  
    View view = inflater.inflate(R.layout.fragment_dialog, <span class="hljs-keyword">null</span>);  
    builder.setView(view) 
    <span class="hljs-comment">// Do Someting,eg: TextView tv = view.findViewById(R.id.tv);</span>
    <span class="hljs-keyword">return</span> builder.create();
}

PS:创建 Dialog 的方式有多种,比如下面这种,使用时略有差异,需要自己注意:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> Dialog <span class="hljs-title">onCreateDialog</span>(Bundle savedInstanceState) {
    LayoutInflater inflater = getActivity().getLayoutInflater();
    View view = inflater.inflate(R.layout.fragment_dialog, <span class="hljs-keyword">null</span>);
    Dialog dialog = <span class="hljs-keyword">new</span> Dialog(getActivity());
    <span class="hljs-comment">// 设置主题的构造方法</span>
    <span class="hljs-comment">// Dialog dialog = new Dialog(getActivity(), R.style.CustomDialog);</span>
    dialog.setContentView(view);
    <span class="hljs-comment">// Do Someting</span>
    <span class="hljs-keyword">return</span> dialog;
}

对于方法 ②,和普通的 Fragment 用法基本一致:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> View <span class="hljs-title">onCreateView</span>(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
    View rootView = inflater.inflate(R.layout.fragment_dialog, container, <span class="hljs-keyword">false</span>);
    <span class="hljs-comment">// Do Someting</span>
    <span class="hljs-keyword">return</span> rootView;
}
<span class="hljs-javadoc">/**
 * 设置主题需要在 onCreate() 方法中调用 setStyle() 方法
 */</span>
<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onCreate</span>(@Nullable Bundle savedInstanceState) {
    <span class="hljs-keyword">super</span>.onCreate(savedInstanceState);
    setStyle(DialogFragment.STYLE_NO_TITLE, R.style.CustomDialog);
}

处理屏幕翻转

如果使用传统的 Dialog ,需要我们手动处理屏幕翻转的情况,但使用 DialogFragment 的话,则不需要我们进行任何处理,FragmentManager 会自动管理 DialogFragment 的生命周期。

无标题栏/全屏

在基本用法里代码注释有设置主题的地方,下面详细说下两种方法下设置无标题栏和实现全屏的方式:

对于方法 ① :

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> Dialog <span class="hljs-title">onCreateDialog</span>(Bundle savedInstanceState) {
    LayoutInflater inflater = getActivity().getLayoutInflater();
    View view = inflater.inflate(R.layout.fragment_dialog, <span class="hljs-keyword">null</span>);
    Dialog dialog = <span class="hljs-keyword">new</span> Dialog(getActivity(), R.style.CustomDialog);
    <span class="hljs-comment">// 关闭标题栏,setContentView() 之前调用</span>
    dialog.requestWindowFeature(Window.FEATURE_NO_TITLE);
    dialog.setContentView(view);
    dialog.setCanceledOnTouchOutside(<span class="hljs-keyword">true</span>);
    <span class="hljs-keyword">return</span> dialog;
}

对于方法 ②:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onCreate</span>(@Nullable Bundle savedInstanceState) {
    <span class="hljs-keyword">super</span>.onCreate(savedInstanceState);
    <span class="hljs-javadoc">/**
     * setStyle() 的第一个参数有四个可选值:
     * STYLE_NORMAL|STYLE_NO_TITLE|STYLE_NO_FRAME|STYLE_NO_INPUT
     * 其中 STYLE_NO_TITLE 和 STYLE_NO_FRAME 可以关闭标题栏
     * 每一个参数的详细用途可以直接看 Android 源码的说明
     */</span>
    setStyle(DialogFragment.STYLE_NO_TITLE, R.style.CustomDialog);
}

实现全屏(宽/高度全屏)

常用的形式大多是宽度上和屏幕一样宽,高度自适应,下面直接看代码:

方法 ① :

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> Dialog <span class="hljs-title">onCreateDialog</span>(Bundle savedInstanceState) {
    LayoutInflater inflater = getActivity().getLayoutInflater();
    View view = inflater.inflate(R.layout.fragment_dialog, <span class="hljs-keyword">null</span>);
    Dialog dialog = <span class="hljs-keyword">new</span> Dialog(getActivity(), R.style.CustomDialog);
    dialog.requestWindowFeature(Window.FEATURE_NO_TITLE);
    dialog.setContentView(view);
    dialog.setCanceledOnTouchOutside(<span class="hljs-keyword">true</span>);
    <span class="hljs-comment">//Do something</span>
    <span class="hljs-comment">// 设置宽度为屏宽、位置靠近屏幕底部</span>
    Window window = dialog.getWindow();
    window.setBackgroundDrawableResource(R.color.transparent); //12
    WindowManager.LayoutParams wlp = window.getAttributes();
    wlp.gravity = Gravity.BOTTOM;
    wlp.width = WindowManager.LayoutParams.MATCH_PARENT;//15
    wlp.height = WindowManager.LayoutParams.WRAP_CONTENT;
    window.setAttributes(wlp);
    <span class="hljs-keyword">return</span> dialog;
}

代码 12 行设置了窗口的背景色为透明,这一步是必须的;

代码 15 行设置窗口的宽度为 MATCH_PARENT,效果是和屏幕宽度一样大,同样你也可以设置高度的值。设置宽度和高度除了 MATCH_PARENT 和 WRAP_CONTENT ,也可以直接设置成具体的数值。

方法 ②:

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onCreate</span>(@Nullable Bundle savedInstanceState) {
    <span class="hljs-keyword">super</span>.onCreate(savedInstanceState);
    setStyle(DialogFragment.STYLE_NO_TITLE, R.style.CustomDialog);
}

<span class="hljs-annotation">@Override</span>
<span class="hljs-keyword">public</span> View <span class="hljs-title">onCreateView</span>(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        getDialog().setCanceledOnTouchOutside(<span class="hljs-keyword">true</span>);
        View rootView = inflater.inflate(R.layout.fragment_dialog, container, <span class="hljs-keyword">false</span>);
        <span class="hljs-comment">//Do something</span>
        <span class="hljs-comment">// 设置宽度为屏宽、靠近屏幕底部。</span>
        <span class="hljs-keyword">final</span> Window window = getDialog().getWindow();
        window.setBackgroundDrawableResource(R.color.transparent); // 14
        window.getDecorView().setPadding(<span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>, <span class="hljs-number">0</span>); //15 
        WindowManager.LayoutParams wlp = window.getAttributes();
        wlp.gravity = Gravity.BOTTOM;
        wlp.width = WindowManager.LayoutParams.MATCH_PARENT;
        wlp.height = WindowManager.LayoutParams.WRAP_CONTENT;
        window.setAttributes(wlp);
        <span class="hljs-keyword">return</span> rootView;
}

代码 14 行设置了窗口的背景色为透明,这一步是必须的;

代码 15 行设置了窗口的 Pading 值全部为0,这一步也是必须的,内容不能填充全部宽度和高度。

其他的和 ① 中的类似。

应用场景区别

文章一开始简单总结了方法 ① 和方法 ② 的应用场景,这里说明下:

  • 从基本的用法中可以看到方法 ① 为简单的替代 Dialog 提供了非常方便的创建方式,比方法 ② 有优势
  • 方法 ① 在使用了多线程(例如网络请求)的情况下,不能正确的获取当前 Fragment 的状态,会产生空指针异常。方法 ② 则没有此问题,而且,其创建方式默认使用了自定义 View,更便于应对复杂 UI 的场景。

这里举例说明:方法 ① 和方法 ② 的//Do something 代码处,我们进行一些异步操作:

TextView title = rootView.findViewById(R.id.dialoag_tv);
title.setText(<span class="hljs-string">"Value A"</span>);
<span class="hljs-keyword">new</span> SomeTask().execute(url);

<span class="hljs-keyword">private</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">SomeTask</span> <span class="hljs-keyword">extends</span> <span class="hljs-title">AsyncTask</span><<span class="hljs-title">String</span>, <span class="hljs-title">Void</span>, <span class="hljs-title">Boolean</span>> {</span>

        <span class="hljs-annotation">@Override</span>
        <span class="hljs-keyword">protected</span> Boolean <span class="hljs-title">doInBackground</span>(String... params) {
            <span class="hljs-comment">// 一些网络请求</span>
            <span class="hljs-comment">// 成功时 return true;</span>
            <span class="hljs-comment">// 异常时 return false;</span>
        }

        <span class="hljs-annotation">@Override</span>
        <span class="hljs-keyword">protected</span> <span class="hljs-keyword">void</span> <span class="hljs-title">onPostExecute</span>(Boolean aBoolean) {
            <span class="hljs-keyword">super</span>.onPostExecute(aBoolean);
            <span class="hljs-comment">// if (!isVisible()) return; //17</span>
            <span class="hljs-keyword">if</span> (aBoolean) {
                title.setText(<span class="hljs-string">"Value B"</span>);
            }
        }
}

如果在网络请求未结束或者刚结束时关闭了当前 DialogFragment ,代码 19 行就会报空指针异常了,代码 17 的作用就是判断 DialogFragment 当前的状态是否为可用态,但是 isVisible() 以及 isHide() 对于方法 ① 无法正确返回其状态,方法 ② 则正常。方法 ① 和方法 ② 创建 DialogFragment 的一些状态并不是完全一致。

PS:你也可以使用静态 Handler 结合弱引用等来处理异步操作,那样对 DialogFragment 状态的获取就不重要了。

发表评论