兩步搞定Fragment的返回鍵
Fragment可以說是在Android開發必需要使用到技術,專案中的介面基本上都是使用Fragment來實現,而Activity只是作為Fragment的載體,但有些特殊情況下Fragment也不得不處理Back鍵,如果是Activity的話還好說,直接覆蓋 Activity的
onBackPressed
即可,但Fragment可就沒有這麼幸運了,你可能和我一樣,最開始有這樣的需求的時候都會想去覆蓋Fragment的onBackPressed
方法,但是事與願違,Fragment中並沒有這樣的方法,不僅如此,Fragment也沒有更不可能有onKeyDown
、onKeyUp
這樣的方法,那麼Fragment如何處理back鍵成難題。
在此之前先賣個關子看看別人都是怎麼實現的,看過的該方式的同學可以直接到最後。
別人的實現方式
注:出自優雅的讓Fragment監聽返回鍵
1、定義一個BackHandledInterface
public interface BackHandledInterface {
public abstract void setSelectedFragment(BackHandledFragment selectedFragment);
}
2、定義一個BackHandledFragment 抽象類繼承Fragment並提供一個onBackPressed
方法,所有的Fragment都派生自該類
public abstract class BackHandledFragment extends Fragment {
protected BackHandledInterface mBackHandledInterface;
protected abstract boolean onBackPressed();
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
if (!(getActivity() instanceof BackHandledInterface)){
throw new ClassCastException("Hosting Activity must implement BackHandledInterface");
}else{
this.mBackHandledInterface = (BackHandledInterface)getActivity();
}
}
@Override
public void onStart() {
super.onStart();
mBackHandledInterface.setSelectedFragment(this);
}
}
3、Activity實現第一步中定義的BackHandledInterface
介面
public class MainActivity extends FragmentActivity implements BackHandledInterface{
private BackHandledFragment mBackHandedFragment;
private boolean hadIntercept;
@Override
public void setSelectedFragment(BackHandledFragment selectedFragment) {
this.mBackHandedFragment = selectedFragment;
}
@Override
public void onBackPressed() {
if(mBackHandedFragment == null || !mBackHandedFragment.onBackPressed()){
if(getSupportFragmentManager().getBackStackEntryCount() == 0){
super.onBackPressed();
}else{
getSupportFragmentManager().popBackStack();
}
}
}
}
原理分析
1、利用Fragment的生命週期,在Fragment顯示時通知到Activity,並由Activity保持。
2、當用戶按下Acitivity時,首先將back鍵請求交給Fragment處理,如果處理返回true
,未處理時返回false
。
3、如果Fragment沒有處理則由Activity處理。
存在的問題
1、只適用於一個Activity上只有一個Fragment的情況。
2、只適用於沒有Fragment巢狀的情況。
改進方式
1、將Activity中的BackHandledFragment 改為List<BackHandledFragment> 。
2、為保證Fragment存在巢狀的情況下也能正常使用,Fragment本身也要用List<BackHandledFragment> 持有 子可見Fragment的引用集合。
3、Fragment不可見時通知Activity或父Fragment移除。
4、當用戶按下back鍵時遍歷所有的可見Fragment,同樣為了支援巢狀的情況Fragment本身也要遍歷所有的
子可見Fragment。
雖然這樣可以,但是這樣太麻煩了,還得自己持有Fragment例項,難道就沒有更好的方法?
新實現方式
其實我們根本不用去持有各個Fragment的例項,
FragmentManager
已經幫我們做了。
Activity中的有的Fragment由FragmentManager
管理,Fragment巢狀的子Fragment也由FragmentManager
處理,那隻要拿到FragmentManager
就可以用遞迴的方式處理了,等等,我好像發現了什麼。
1、同樣的先定義一個FragmentBackHandler
介面。
public interface FragmentBackHandler {
boolean onBackPressed();
}
2、定義一個BackHandlerHelper
工具類,用於實現分發back事件,Fragment和Activity的外理邏輯是一樣,所以兩者都需要呼叫該類的方法。
public class BackHandlerHelper {
/**
* 將back事件分發給 FragmentManager 中管理的子Fragment,如果該 FragmentManager 中的所有Fragment都
* 沒有處理back事件,則嘗試 FragmentManager.popBackStack()
*
* @return 如果處理了back鍵則返回 <b>true</b>
* @see #handleBackPress(Fragment)
* @see #handleBackPress(FragmentActivity)
*/
public static boolean handleBackPress(FragmentManager fragmentManager) {
List<Fragment> fragments = fragmentManager.getFragments();
if (fragments == null) return false;
for (int i = fragments.size() - 1; i >= 0; i--) {
Fragment child = fragments.get(i);
if (isFragmentBackHandled(child)) {
return true;
}
}
if (fragmentManager.getBackStackEntryCount() > 0) {
fragmentManager.popBackStack();
return true;
}
return false;
}
public static boolean handleBackPress(Fragment fragment) {
return handleBackPress(fragment.getChildFragmentManager());
}
public static boolean handleBackPress(FragmentActivity fragmentActivity) {
return handleBackPress(fragmentActivity.getSupportFragmentManager());
}
/**
* 判斷Fragment是否處理了Back鍵
*
* @return 如果處理了back鍵則返回 <b>true</b>
*/
public static boolean isFragmentBackHandled(Fragment fragment) {
return fragment != null
&& fragment.isVisible()
&& fragment.getUserVisibleHint() //for ViewPager
&& fragment instanceof FragmentBackHandler
&& ((FragmentBackHandler) fragment).onBackPressed();
}
}
3、當然 Fragment
也要實現 FragmentBackHandler
介面(按需)
//沒有處理back鍵需求的Fragment不用實現
public abstract class BackHandledFragment extends Fragment implements FragmentBackHandler {
@Override
public boolean onBackPressed() {
return BackHandlerHelper.handleBackPress(this);
}
}
4、Activity覆蓋onBackPressed
方法(必須)
public class MyActivity extends FragmentActivity {
//.....
@Override
public void onBackPressed() {
if (!BackHandlerHelper.handleBackPress(this)) {
super.onBackPressed();
}
}
}
不是說好的兩步麼,這TM是4步啊!大哥不要生氣,第一步和第二步我都給你做了,你只要在Gradle中加入以下的話以及第3、4步即可。你可以使用我提供的BackHandledFragment
也可以讓自己的BaseFragment
實現FragmentBackHandler介面(只在需要Fragmen中實現就行),並在onBackPressed
中用填入return
BackHandlerHelper.handleBackPressed(this);
。
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
dependencies {
compile 'com.github.ikidou:FragmentBackHandler:2.1'
}
當你需要自己處理back事件時覆蓋onBackPressed
方法,如:
@Override
public boolean onBackPressed() {
// 當確認沒有子Fragmnt時可以直接return false
if (backHandled) {
Toast.makeText(getActivity(), toastText, Toast.LENGTH_SHORT).show();
return true;
} else {
return BackHandlerHelper.handleBackPress(this);
}
}
圖示
Fragment的back鍵處理原理
圖中紅色部分為BackHandledFragment
或其它實現了 FragmentBackHandler
的Fragment。
back事件由下往上傳遞,當中間有未實現FragmentBackHandler
的Fragment作為其它Fragment的容器時,或該Fragment攔截了事件時,其子Fragment無法處理back事件。
有沒有一種似曾相識的感覺?其實這和View的事件分發機制是一個道理。
原理
1、不管是Activity
也好,Fragment
也好,其中內部包含的Fragment都是通過FragmentManager
來管理的。
2、FragmentManager.getFragments()
可以獲取當前Fragment/Activity
中處於活動狀態的所有Fragment
3、事件由Activity交給當前Fragment處理,如果Fragment有子Fragment的情況同樣可以處理。
這麼做的好處
1、Activity不必實現介面,僅需在onBackPressed
中呼叫BackHandlerHelper.handleBackPress(this)
即可,Fragment同理。
2、支援多個Fragment
3、支援Fragment巢狀
4、改動小,只修改有攔截back鍵需求的Fragment及其父Fragment,其它可以不動。