Android 经典笔记之三：Fragment中返回键事件处理

目录介绍
1.Fragment中返回键事件处理
1.1 如何在Fragment中处理返回键事件
1.2 如何区分Fragment和Activity的返回键事件
1.3 总结
2.Fragment中监听返回键的第二种方法

1.Fragment中返回键事件处理

如何在Fragment中处理返回键事件
Fragment监听返回键。有时候在Fragment中点击了物理返回键，不只是返回上一层。所以这时候需要在fragment中处理物理返回键的事件。
首先自定义接口

public interface FragmentBackListener {
void  onBackForward();
}

在Activity中添加自定义方法

private FragmentBackListener backListener;
private boolean isInterception = false;
public FragmentBackListener getBackListener() {
return backListener;
}

/**
* 设置Fragment中返回键监听
* @param backListener
*/
public void setBackListener(FragmentBackListener backListener) {
this.backListener = backListener;
}

public boolean isInterception() {
return isInterception;
}

/**
* 区别Activity和Fragment返回键的监听事件
* 可以自主在Fragment中设置监听事件
* @param isInterception
*/
public void setInterception(boolean isInterception) {
this.isInterception = isInterception;
}

在Activity中添加onKeyDown监听方法

@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
if (keyCode == KeyEvent.KEYCODE_BACK && event.getAction() == KeyEvent.ACTION_DOWN) {
if(**isInterception**){
//处理Fragment中的返回键监听事件
if (backListener != null) {
backListener.onBackForward();
return false;
}
}else {
finish();
return true;
}
}
return super.onKeyDown(keyCode, event);
}

在Activity中的指示器点击和ViewPager滑动中添加处理Fragment是否独立处理返回键监听

if (position == 2) {
setInterception(true);          //在第三个Fragment中，独立处理返回键逻辑
}else {
setInterception(false);         //其他Fragment，返回键逻辑与宿主Activity返回键逻辑一样
}

在需要独立处理返回键逻辑的Fragment中添加监听事件

@Override
public void onAttach(Context context) {
super.onAttach(context);
activity = (BarFirstActivity) context;
activity.setBackListener(this);
}

@Override
public void onDetach() {
super.onDetach();
activity.setBackListener(null);
}

@Override
public void onBackForward() {
if (webView!=null && webView.canGoBack()) {
webView.goBack();                                      //返回上一页面
}else {
activity.setInterception(false);
}
}

2.Fragment中监听返回键的第二种方法

思路分析
简单思路
1、利用Fragment的生命周期，在Fragment显示时通知到Activity，并由Activity保持。
2、当用户按下Acitivity时，首先将back键请求交给Fragment处理，如果处理返回true,未处理时返回false。
3、如果Fragment没有处理则由Activity处理。

改进思路
1、将Activity中的BackHandledFragment 改为List<BackHandledFragment> 。
2、为保证Fragment存在嵌套的情况下也能正常使用，Fragment本身也要用List<BackHandledFragment> 持有 子可见Fragment的引用集合。
3、Fragment不可见时通知Activity或父Fragment移除。
4、当用户按下back键时遍历所有的可见Fragment，同样为了支持嵌套的情况Fragment本身也要遍历所有的
子可见Fragment。

存在问题
虽然这样可以，但是这样太麻烦了，还得自己持有Fragment实例，难道就没有更好的方法?

新的实现方式
其实我们
7fe0
根本不用去持有各个Fragment的实例，FragmentManager已经帮我们做了。
Activity中的有的Fragment由FragmentManager管理，Fragment嵌套的子Fragment也由FragmentManager处理，那只要拿到FragmentManager就可以用递归的方式处理了，等等，我好像发现了什么。

第一步：先定义一个FragmentBackHandler

public interface FragmentBackHandler {
boolean onBackPressed();
}

第二步：定义一个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;
}

/**
* 将back事件分发给Fragment中的子Fragment,
* 该方法调用了 {@link #handleBackPress(FragmentManager)}
* @return 如果处理了back键则返回 <b>true</b>
*/
public static boolean handleBackPress(Fragment fragment) {
return handleBackPress(fragment.getChildFragmentManager());
}

/**
* 将back事件分发给Activity中的子Fragment,
* 该方法调用了 {@link #handleBackPress(FragmentManager)}
* @return 如果处理了back键则返回 <b>true</b>
*/
public static boolean handleBackPress(FragmentActivity fragmentActivity) {
return handleBackPress(fragmentActivity.getSupportFragmentManager());
}

/**
* 将back事件分发给ViewPager中的Fragment,{@link #handleBackPress(FragmentManager)}
* 已经实现了对ViewPager的支持，所以自行决定是否使用该方法
* @return 如果处理了back键则返回 <b>true</b>
* @see #handleBackPress(FragmentManager)
* @see #handleBackPress(Fragment)
* @see #handleBackPress(FragmentActivity)
*/
public static boolean handleBackPress(ViewPager viewPager) {
if (viewPager == null) return false;
PagerAdapter adapter = viewPager.getAdapter();
if (adapter == null) return false;
int currentItem = viewPager.getCurrentItem();
Fragment fragment;
if (adapter instanceof FragmentPagerAdapter) {
fragment = ((FragmentPagerAdapter) adapter).getItem(currentItem);
} else if (adapter instanceof FragmentStatePagerAdapter) {
fragment = ((FragmentStatePagerAdapter) adapter).getItem(currentItem);
} else {
fragment = null;
}
return isFragmentBackHandled(fragment);
}

/**
* 判断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();
}
}

第三步：当然 Fragment 也要实现 FragmentBackHandler接口

//没有处理back键需求的Fragment不用实现
public abstract class BackHandledFragment extends Fragment implements FragmentBackHandler {
@Override
public boolean onBackPressed() {
return BackHandlerHelper.handleBackPress(this);
}
}

第四步：Activity覆盖onBackPressed方法（必须）

private long lastBackPress;
@Override
public void onBackPressed() {
if (!BackHandlerHelper.handleBackPress(this)) {
if (System.currentTimeMillis() - lastBackPress < 1000) {
super.onBackPressed();
} else {
lastBackPress = System.currentTimeMillis();
Toast.makeText(MyActivity.this, "再按一次退出", Toast.LENGTH_SHORT).show();
}
}
}

图示



图中红色部分为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，其它可以不动。1.Fragment中返回键事件处理
1.1 如何在Fragment中处理返回键事件
1.2 如何区分Fragment和Activity的返回键事件
1.3 总结

后续：
平时喜欢写写文章，笔记。别人建议我把笔记，以前写的东西整理，然后写成博客，所以我会陆续整理文章，只发自己写的东西，敬请期待：
知乎：https://www.zhihu.com/people/yang-chong-69-24/pins/posts
领英：https://www.linkedin.com/in/chong-yang-049216146/
简书：http://www.jianshu.com/u/b7b2c6ed9284
csdn：http://my.csdn.net/m0_37700275
网易博客：http://yangchong211.blog.163.com/
新浪博客：http://blog.sina.com.cn/786041010yc
github：https://github.com/yangchong211
喜马拉雅听书：http://www.ximalaya.com/zhubo/71989305/
脉脉：yc930211
开源中国：https://my.oschina.net/zbj1618/blog