Android應用中使用Fragment組件的一些問題及解決方案總結

Fragment的主要意義就是提供與Activity綁定的生命周期回調。
Fragment不一定要向Activity的視圖層級中添加View. 當某個模塊需要獲得Activity的生命周期回調的時候,就可以考慮通過Fragment來實現.
例如: DialogFragment, 調用show方法來顯示一個Dialog(這個一個子Window,並不在Activity的視圖層級中),當旋屏時,DialogFragment利用onDestroyView回調來dismiss Dialog,然後Activity重建之後,DialogFragment利用onStart回調再顯示Dialog。
當然,我們也可以創建一個完全沒有UI的Fragment,比如BackgroundWorkerFragment,在onResume的時候執行一個Task,在onPause的時候暫停一個Task。

Fragment 生命周期
先來回顧一下基礎知識，Fragment的生命周期圖如下：

說明：總的來說，Fragment和Activity的生命周期類似。需要注意的是，它相比於Activity，多了onAttach(), onDetch(), onCreateView()和onDestroyView()這幾個回調函數；但是，卻少了onRestart()。
Fragment的生命周期非常復雜,分為以下幾種情況:

• 如果是通過XML中的<fragment/>標簽實例化的,那麼第一個收到的回調將是onInflate
• 如果setRetainInstance(true),那麼當Activity重建時,Fragment的onDestroy以及Activity重建後Fragment的onCreate回調不會被調用.(無論是否將其添加到了返回棧)
• 如果當前顯示的是Fragment A,然後執行FragmentTransaction.replace(),那麼Fragment A會執行onPause()->onStop()->onDestroyView()->onDestroy()->onDetach(),如果執行FragmentTransaction.replace().addToBackStack(),那麼Fragment A會執行onPause()->onStop()->onDestroyView()
• FragmentTransaction.hide(),將不會導致onPause(),而是會觸發onHiddenChanged()
• FragmentTransaction.detach(),會導致onPause()->onStop()->onDestroyView(),注意:onDestroy()和onDetach()不會調用

FragmentTransaction

• 對於Fragment的操作都是通過FragmentTransaction來進行的,一個FragmentTransaction可以包含一個或者多個操作,通過commit或者commitAllowingStateLoss來提交.如果該FragmentTransaction被加入返回棧,那麼出棧的時候,該Transaction中的所有操作都會被撤銷
• commit方法是異步的(handler post相應的message到MainLooper關聯的Message queue),如果需要立刻執行Transaction的操作,可以調用executePendingTransactions()
• FragmentTransaction的commit方法以及FragmentManager的popBackStack方法都是異步的,給調用者帶來了很多不便,雖然可以通過調用executePendingTransactions()方法來立即執行,但是為什麼默認是異步的呢??(我覺得是因為:提交一個Transaction,會導致Fragment的生命周期方法的執行,甚至是多個回調的執行,如果Fragment在這些回調中又提交新的Transaction,那麼可能會破壞當前Transaction的狀態,比方說這是一個pop操作)

Can not perform this action after onSaveInstanceState

在使用Fragment的過程中,常常會遇到在Activity的onSaveInstanceState方法調用之後,操作commit或者popBackStack而導致的crash.
因為在onSaveInstanceState方法之後的操作狀態可能會丟失,因此Android framework默認會拋出一個異常.
對於commit方法來說,單純避免這個異常很簡單,使用commitAllowingStateLoss方法即可.但是popBackStack以及popBackStackImmediate也都會檢查state(checkStateLoss),特別需要注意的是Activity的onBackPressed方法

public void onBackPressed() {
  if (!mFragments.popBackStackImmediate()) {//注意
    supportFinishAfterTransition();
  }
}

如果onBackPressed在onSavedInstanceState之後調用,那麼就會crash.
onBackPressed的調用時機:

* targetSdkVersion <= 5,在onKeyDown中調用
* targetSdkVersion > 5,在onKeyUp中調用
onSavedInstanceState的調用時機(如果調用的話):

* 一定在onStop之前
* 可能在onPause之前,也可能在onPause與onStop之間
需要注意的是: onSavedInstanceState方法不一定會調用,只有在Activity因為某些原因而被Framework銷毀,並且之後還需要重新創建的情況,才需要調用(例如:旋屏,或者內存不足而回收返回棧中的某些Activity)

舉例:
* Activity A在前台時,屏幕逐漸變暗直至鎖屏,那麼A的onSavedInstanceState會被調用
* Activity A start Activity B,Activity A的onSavedInstanceState會被調用
* Activity A因為返回鍵或者finish調用而返回到上一個界面,那麼A的onSavedInstanceState不會被調用
因此,當onBackPressed在onSavedInstanceState方法之後調用,就一定會crash.解決方法主要有兩種:

重寫Activity的onSavedInstanceState()方法,並且注釋掉super調用.
這種方法能避免crash,但是它會導致整個Activity的狀態丟失.以DialogFragment為例,正常情況下,顯示的DialogFragment在旋屏Activity重新創建之後,不需要我們處理,Dialog會自動顯示出來(參見DialogFragment.onStart()),但是注釋掉Activity的onSavedInstanceState()方法之後,Fragment狀態丟失,Activity重新創建之後,Dialog也就不會再顯示出來了.

更好且通用的做法:在調用commit,popBackStack以及onBackPressed方法之前,判斷onSavedInstanceState()方法是否已經執行,並且onResume方法還沒有執行,如果不是,那麼直接操作,否則加入到pending隊列,等待onResumeFragments或者onPostResume之後再執行.

注意:不要在onResume中操作,因為這時候FragmentManager中的mStateSaved依然可能是true.(如果執行順序是onSavedInstanceState()->onPause()->onResume() 或者 onPause()->onSavedInstanceState()->onResume())

例如:

public void onDataReceived() {
  if(isStateSaved()) {//isStateSaved()由BaseActivity提供
    addPendingFragmentOperation(new Runnable() {
      @Override
      public void run() {
        getSupportFragmentManager().popBackStackImmediate();
      }
    });
  } else {
    getSupportFragmentManager().popBackStackImmediate();
  }
}

@Override
protected void onPostResume() {
  super.onPostResume();
  if(pendingFragmentOperation != null && !pendingFragmentOperation.isEmpty()) {
    for(Runnable operation : pendingFragmentOperation) {
      operation.run();
    }
    pendingFragmentOperation.clear();
  }
}

startActivityForResult

requestCode的可用區間:

1.Activity: [Integer.MIN_VALUE, Integer.MAX_VALUE]
（1）當requestCode取值在[Integer.MIN_VALUE, -1]區間中,效果和startActivity()一樣,不會收到onActivityResult()回調
（2）內置的Fragment可用requestCode的區間和Activity相同
2.support庫: Fragment,以及FragmentActivity:[-1, 65535]
（1）requestCode == -1,效果和startActivity()一樣,不會收到onActivityResult()回調
（2）requestCode 在 [Integer.MIN_VALUE, -2]或者[65536, Integer.MAX_VALUE]之間,會拋出異常(requestCode只能使用低16比特)
建議: requestCode的取值統一限制在[-1, 65535]之間

嵌套Fragment

首先要說的是盡量不要使用嵌套Fragment.
當在嵌套Fragment中使用startActivityForResult()時,會遇到的問題:

所有的Fragment都收不到onActivityResult()
某個level 1 的Fragment收到了onActivityResult()
總之那個發起startActivityForResult()的嵌套Fragment是一定不會收到onActivityResult()回調的.

原因如下:(可參考上面說的requestCode)
FragmentActivity.startActivityFromFragment()會改動requestCode,用高16比特存儲Fragment在FragmentManager中的index,而低16比特作為Fragment可用的requestCode.在FragmentActivity.onActivityResult()中,根據高16比特,從FragmentManager中找到對應的Fragment,然後將低16比特的值作為requestCode,調用Fragment.onActivityResult().

那麼requestCode中只能存儲一個index,即root FragmentManager中的Fragment index.因此就會出現上面所列出的情形:

• 當嵌套Fragment在childFragmentManager中的index,大於rootFragmentManager中的所有index時, rootFragmentManager將找不到與此index對應的Fragment,所以沒有Fragment能收到onActivityResult()
• 當嵌套Fragment在childFragmentManager中的index,小於等於rootFragmentManager中的所有index時,那麼隸屬於rootFragmentManager的一個Fragment將會收到onActivityResult()
• 總之即使能有Fragment能收到onActivityResult(),那也是頂層的某個Fragment,而不是發起請求的嵌套Fragment

解決方案:

• 不使用嵌套Fragment :)
• 依然利用requestCode,將其低16位拆分,其中的高8位用來存儲childFragmentManager中的index,低8位留給ChildFragment使用.(如果嵌套層級不深,那麼此方案還是不錯的,如果層級較深,那麼留給Fragment的requestCode的可用值區間將非常局限)
• Android 4.2(Api 17)以後,可以使用內置的Fragment,以及ChildFragmentManager,內置Fragment不再需要借助requestCode的高16比特來記錄它的index.而是由Framework收到Fragment.startActivityForResult()時,記錄該Fragment的標識(android:fragment:${parentIndex}:${myIndex}),派發result時,就根據這個標識找到那個Fragment.因此就不會出現ChildFragment收不到onActivityResult()回調的問題了.可以參考Activity.dispatchActivityResult()

Tips

開發的時候,可以打開Fragment相關的調試信息

FragmentManager.enableDebugLogging(BuildConfig.DEBUG);
Activity的onResume被調用時,Fragment的onResume還未被調用.
protected void onPostResume() {
  super.onPostResume();
  mHandler.removeMessages(MSG_RESUME_PENDING);
  onResumeFragments();
  mFragments.execPendingActions();
}
protected void onResumeFragments() {
  mFragments.dispatchResume();
}

如果需要在Fragment的onResume都執行完後再執行某個操作,可以重寫onPostResume()方法,一定要調用 super.onPostResume()

1.IllegalStateException(Fragment not attached to Activity)的問題
這個異常通常的發生情況是:在Fragment中啟動一個異步任務,然後在回調中執行和resource相關的操作(getString(...)),或者startActivity(...)之類的操作.但是這個時候Fragment可能已經被detach了,所以它的mHost==null,因此在執行這些操作之前,需要先判斷一下isAdded().
注意: 這裡不要使用isDetached()來判斷,因為Fragment被detach之後,它的isDetached()方法依然可能返回false

2.如果Fragment A是因為被replace而detach的,那麼它的isDetached()將返回false
3.如果Fragment A對應的FragmentTransaction被加入到返回棧中,因為出棧而detach,那麼它的isDetached()將返回true

final public Resources getResources() {
  if (mHost == null) {
    throw new IllegalStateException("Fragment " + this + " not attached to Activity");
  }
  return mHost.getContext().getResources();
}
public void startActivity(Intent intent, @Nullable Bundle options) {
  if (mHost == null) {
    throw new IllegalStateException("Fragment " + this + " not attached to Activity");
  }
  mHost.onStartActivityFromFragment(this /*fragment*/, intent, -1, options);
}