记一个DialogFragment.show()的Bug

作者: 承香墨影 | 来源:发表于2016-05-16 00:11 被阅读2833次

Fragment虽然使用起来确实非常的方便,而且在效率上来看,也比Activity要高。但是也存在各种各样的问题。这里对DialogFragment.show()调用的时候,可能引发的一个Bug解决来看看DialogFragment。

还原现场

既然是Bug,直接上现场,崩溃栈如下:


show.png

可以看到是因为调用了DialogFragment.show(),最终导致了IllegalStateException。

IllegalStateException : Can not perform this action after onSaveInstanceSate

复盘

既然有崩溃栈,那么接下来我们来根据复盘。

直接根据调用栈来看源码,最终崩溃的地方如下。

    /**
     * Adds an action to the queue of pending actions.
     *
     * @param action the action to add
     * @param allowStateLoss whether to allow loss of state information
     * @throws IllegalStateException if the activity has been destroyed
     */
    public void enqueueAction(Runnable action, boolean allowStateLoss) {
        if (!allowStateLoss) {
            checkStateLoss();
        }
        synchronized (this) {
            if (mDestroyed || mHost == null) {
                throw new IllegalStateException("Activity has been destroyed");
            }
            if (mPendingActions == null) {
                mPendingActions = new ArrayList<Runnable>();
            }
            mPendingActions.add(action);
            if (mPendingActions.size() == 1) {
                mHost.getHandler().removeCallbacks(mExecCommit);
                mHost.getHandler().post(mExecCommit);
            }
        }
    }

    private void checkStateLoss() {
        if (mStateSaved) {
            throw new IllegalStateException(
                    "Can not perform this action after onSaveInstanceState");
        }
        if (mNoTransactionsBecause != null) {
            throw new IllegalStateException(
                    "Can not perform this action inside of " + mNoTransactionsBecause);
        }
    }

可以看到在checkStateLoss()的时候,如果mStateSaved已经被置为true,导致直接抛出此异常。那么问题就出在mStateSaved这个变量什么时候会被置为true,通过源码继续找下去发现只有在saveAllState()的时候,才会将它置为true。

    Parcelable saveAllState() {
        // ...
        if (HONEYCOMB) {
            // As of Honeycomb, we save state after pausing.  Prior to that
            // it is before pausing.  With fragments this is an issue, since
            // there are many things you may do after pausing but before
            // stopping that change the fragment state.  For those older
            // devices, we will not at this point say that we have saved
            // the state, so we will allow them to continue doing fragment
            // transactions.  This retains the same semantics as Honeycomb,
            // though you do have the risk of losing the very most recent state
            // if the process is killed...  we'll live with that.
            mStateSaved = true;
        }
        // ...
    }

这段注释解释的很清楚了,就不再翻译了。

只有在API level 11+之后,才会用到这个状态,在Fragment所在的依附的Activity被销毁的时候,会调用此方法保存Fragment的状态,体现在代码中,就是在FragmentActivity的onSaveInstanceState()的时候,会去调用FragmentManager.saveAllState()方法去保存当前所有的Fragment的状态,以便下次进行恢复。而在被销毁到恢复期间的时候,去做有关Fragment状态的操作,就会引起IllegalStateException。

而调用的地方在FragmentActivity.java中。

    /**
     * Save all appropriate fragment state.
     */
    @Override
    protected void onSaveInstanceState(Bundle outState) {
        super.onSaveInstanceState(outState);
        Parcelable p = mFragments.saveAllState();
        if (p != null) {
            outState.putParcelable(FRAGMENTS_TAG, p);
        }
    }

当然,onSaveInstanceState会在什么时候调用,有什么地方需要注意,可以自行Google,这个不是本篇的主题。

解决思路

既然已经找到了问题出在哪里,那么如何解决呢。从上面的FragmentManager.enqueueAction()代码可以看出,是有传递一个参数去控制是否允许状态的损失,也就是在状态被保存的时候依然继续执行。

    /**
     * Adds an action to the queue of pending actions.
     *
     * @param action the action to add
     * @param allowStateLoss whether to allow loss of state information
     * @throws IllegalStateException if the activity has been destroyed
     */
    public void enqueueAction(Runnable action, boolean allowStateLoss) {
        if (!allowStateLoss) {
            checkStateLoss();
        }
        // ...
    }

而allowStateLoss什么时候会传递true呢?继续查看源码会发现FragmentTransaction中出了commit()还提供了一个类似的方法commitAllowingStateLoss(),调用它就会去忽略mStateSaved。

    /**
     * Schedules a commit of this transaction.  The commit does
     * not happen immediately; it will be scheduled as work on the main thread
     * to be done the next time that thread is ready.
     *
     * <p class="note">A transaction can only be committed with this method
     * prior to its containing activity saving its state.  If the commit is
     * attempted after that point, an exception will be thrown.  This is
     * because the state after the commit can be lost if the activity needs to
     * be restored from its state.  See {@link #commitAllowingStateLoss()} for
     * situations where it may be okay to lose the commit.</p>
     * 
     * @return Returns the identifier of this transaction's back stack entry,
     * if {@link #addToBackStack(String)} had been called.  Otherwise, returns
     * a negative number.
     */
    public abstract int commit();

    /**
     * Like {@link #commit} but allows the commit to be executed after an
     * activity's state is saved.  This is dangerous because the commit can
     * be lost if the activity needs to later be restored from its state, so
     * this should only be used for cases where it is okay for the UI state
     * to change unexpectedly on the user.
     */
    public abstract int commitAllowingStateLoss();

这样来看,实际上设计的时候是有考虑过状态的问题的,只需要把commit()替换成commitAllowingStateLoss()即可。但是DialogFragment本身提供的show()方法,会去直接调用commit()。根本没有调用commitAllowingStateLoss()的入口。

/**
     * Display the dialog, adding the fragment to the given FragmentManager.  This
     * is a convenience for explicitly creating a transaction, adding the
     * fragment to it with the given tag, and committing it.  This does
     * <em>not</em> add the transaction to the back stack.  When the fragment
     * is dismissed, a new transaction will be executed to remove it from
     * the activity.
     * @param manager The FragmentManager this fragment will be added to.
     * @param tag The tag for this fragment, as per
     * {@link FragmentTransaction#add(Fragment, String) FragmentTransaction.add}.
     */
    public void show(FragmentManager manager, String tag) {
        mDismissed = false;
        mShownByMe = true;
        FragmentTransaction ft = manager.beginTransaction();
        ft.add(this, tag);
        ft.commit();
    }

看来Android设计者还是有遗漏的没有考虑到的地方。

解决方案

既然已经找到了问题的症结。那么就有办法解决了。

try.catch住

已经很明朗是因为mStateSaved出现的错误,那么在继承DialogFragment之后,从写show()方法,然后把super.show()用try.catch包裹住即可。这样就可以忽略此Bug了。

    @Override
    public void show(FragmentManager manager, String tag) {
        try{
            super.show(manager,tag);
        }catch (IllegalStateException ignore){
        }
    }

重写DialogFragment

使用try.catch的方式明显不够优雅。那么就可以考虑第二种方案。

既然DialogFragment是继承于Fragment,那么可以把它完整的代码全部拷贝过来,然后重写show()方法,把commit()替换为commitAllowingStateLoss()即可。

不过如果Fragment的继承有包的限制,可以在自己的项目中,新建一个android.support.v4.app的Package,然后在其中新建一个PDialogFragment.java,将DialogFragment的代码全部copy过来,重写对应的方法即可。

    public void show(FragmentManager manager, String tag) {
        mDismissed = false;
        mShownByMe = true;
        FragmentTransaction ft = manager.beginTransaction();
        ft.add(this, tag);
        ft.commitAllowingStateLoss();
    }

虽然用继承DialogFragment的方式,自己去写show(),不去调用super.show()应该也可以,但是show()中其实是有一些状态的置换的,最好不要用这种方式,用这种方式在调试的时候可能没有问题,但是发布出去可能会导致未知问题。

总结

此处应有总结。

相关文章

  • 记一个DialogFragment.show()的Bug

    Fragment虽然使用起来确实非常的方便,而且在效率上来看,也比Activity要高。但是也存在各种各样的问题。...

  • Fatal Exception:java.lang.illega

    定位问题 : dialogFragment.show(fragmentManager, TAG); 解决: 在自己...

  • 记一个Bug

    重后台获取以下数据,其中"课程摘要" "系列课程" "讲座报告" 是有顺序的安卓和使用postMan 获取数据顺序...

  • [HME_JPEG_DEC_Delete](3321): HME

    记遇到的一个bug, glid加载图片闪烁并且log打印出很多这种东西,有待解决

  • 记一个玄学bug

    Part I 写了一段代码要批量导出数据,格式如下, 然后经过检查发现大量数据字段为空,首先...

  • 难以复现的bug怎么处理

    1、首先出现难以复现的bug一定要截图提交bug2、首先评估bug的重要程度以及对整个项目的影响,如果影响小,就记...

  • 一份简明的 Base64 原理解析

    书接上回,在 记一个 Base64 有关的 Bug[https://mazhuang.org/2020/03/01...

  • 05. getWriter()has already been

    记一次bug fixed: getWriter()has already been called for this...

  • 记一次HuaWei p9输入法的bug

    记一次HuaWei p9输入法的bug 今天刚上班,刚跟测试小姐姐打了个招呼,小姐姐反手就给我丢了一个bug,我....

  • 记一个疑似 Zuul 的 Bug

    问题 半夜11点多,合作方突然在群里叫我方测试环境服务返回502 Bad Gateway,当时以为服务掉线没当回事...

网友评论

  • abf5a41e167b:并没有遗漏,DialogFragment的源码中有一个方法showAllowingStateLoss,最后调用的也是commitAllowingStateLoss这个方法,只是showAllowingStateLoss方法被隐藏起来无法调用,Google是不推荐使用这种方法的
  • 81c17c76d562:还有改进的地方,在saveInstance之后调用ft.commitAllowingStateLoss();依然不会显示出dialog,可以把这个commit缓存下来,到下次页面再显示的时候再触发一下
  • 烧烤摊前卖烧烤:全部copy之后,还是有一个地方报错。getLayoutInflater这个方法的super.getLayoutInflater(savedInstanceState)必须在相同的groupid
    46abe5d8bfe5:@承香墨影 包名是package android.support.v4.app;类名是PDialogFragment。是不是和support包版本有关?
    承香墨影:@烧烤摊前卖烧烤 不过如果Fragment的继承有包的限制,可以在自己的项目中,新建一个android.support.v4.app的Package,然后在其中新建一个PDialogFragment.java,将DialogFragment的代码全部copy过来,重写对应的方法即可。
    package对吗?
  • 李小小小男:@谢文东 楼主的文章不就是解决方案么。
  • 捡淑:mark
  • Ivor0057:DialogFragment的使用不建议直接使用show( )方法,可以用fragmentTransaction的方式。
    FragmentTransaction fragmentTransaction = getFragmentManager().beginTransaction();
    dialog.show(fragmentTransaction, null);
    承香墨影:这样最终还是会调用commit的
  • 李小小小男:困扰好久的问题,终于解决了
    妮玛小姐:@李小小小男怎么解决的?

本文标题:记一个DialogFragment.show()的Bug

本文链接:https://www.haomeiwen.com/subject/idyurttx.html