本篇文章属于架构重构。由于Android很早就废弃了TabActivity,但是我们的项目还在使用,所以要将他替换掉。
项目地址:https://github.com/jiahongfei/UITabDemo
TabActivity废弃
当前公司的App使用的UI Tab架构还是很老的TabActivity+TabHost+Activity
形式,这是个历史遗留问题,也不去纠结当时为什么要这么做,现在要做的就是将他替换掉。否则如果Android去修改TabActivity
的源码造成App不能使用肯定是后果自负,已经通知废弃这个类了。如下截图:
Android官方文档写的非常详细,API13已经废弃了,新的app应该使用Fragment来代替。
Fragment代替
重构App UI Tab框架非常危险,因为牵扯的东西非常多。所以重构之前需要仔细想好如下几点在开始写代码。
- 尽量少的修改代码,选择工作近似的类来进行替换。
- 特别需要注意生命周期的回调,切换Tab、跳转、返回等生命周期的回调方式。
- 需要注意父类扩展的方法。
- 尽量增加代码,减少修改代码。
1. 尽量少的修改代码,选择工作近似的类来进行替换。
我们先观察老代码是什么样的,如下代码片段:
代码片段都是我写的demo,真实的app项目要复杂的多,但是在demo上我会把重构需要注意的点都提现出来。
MainActivity.java
public class MainActivity extends TabActivity {
private TabHost tabHost;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
tabHost = getTabHost();
TabHost.TabSpec tabSpec1 = tabHost
.newTabSpec(AActivity.class.getSimpleName())
.setIndicator(AActivity.class.getSimpleName())
.setContent(new Intent(this, AActivity.class));
tabHost.addTab(tabSpec1);
TabHost.TabSpec tabSpec2 = tabHost
.newTabSpec(BActivity.class.getSimpleName())
.setIndicator(BActivity.class.getSimpleName())
.setContent(new Intent(this, BActivity.class));
tabHost.addTab(tabSpec2);
findViewById(R.id.btn_1).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
tabHost.setCurrentTab(0);
}
});
findViewById(R.id.btn_2).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
tabHost.setCurrentTab(1);
}
});
}
}
activity_main.xml
<?xml version="1.0" encoding="UTF-8"?>
<TabHost xmlns:android="http://schemas.android.com/apk/res/android"
android:id="@android:id/tabhost"
android:layout_width="fill_parent"
android:layout_height="fill_parent">
<LinearLayout
android:layout_width="fill_parent"
android:layout_height="fill_parent"
android:orientation="vertical">
<FrameLayout
android:id="@android:id/tabcontent"
android:layout_width="fill_parent"
android:layout_height="0.0dip"
android:layout_weight="1.0" >
</FrameLayout>
<TabWidget
android:id="@android:id/tabs"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_weight="0.0"
android:visibility="gone" />
<RadioGroup
android:id="@+id/main_radio"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_gravity="bottom"
android:gravity="center_vertical"
android:orientation="horizontal">
<Button
android:layout_weight="1"
android:id="@+id/btn_1"
android:text="btn_1"
android:layout_width="match_parent"
android:layout_height="match_parent" />
<Button
android:layout_weight="1"
android:id="@+id/btn_2"
android:text="btn_2"
android:layout_width="match_parent"
android:layout_height="match_parent" />
</RadioGroup>
</LinearLayout>
</TabHost>
我们观察老代码使用TabActivity+TabHost+Activity
。
结合上面提出的第一点和第二点,我们使用FragmentActivity+FragmentTabHost+Fragment
来替换原来的架构,这也是Android官方文档提倡的。
针对第一点,FragmentTabHost
是TabHost
的子类,所以原来老代码使用TabHost
地方的方法基本都可以用,例如切换Tab的方法tabHost.setCurrentTab(0);
。
我们先替换如下代码片段:
不一样的地方在代码中注释提现注意观察
MainActivity.java
//将extends TabActiviy 修改成 FragmentActivity
public class MainActivity extends FragmentActivity {
//将TabHost 修改成 FragmentTabHost
private FragmentTabHost tabHost;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
//将tabHost = getTabHost();修改成如下方式获取,并且调用tabHost.setup(xxxx);方法进行设置
tabHost = findViewById(android.R.id.tabhost);
tabHost.setup(this,getSupportFragmentManager(), android.R.id.tabcontent);
//不需要设置tabSpec.setContent(xxxx);方法
TabHost.TabSpec tabSpecA = tabHost
.newTabSpec(AFragment.class.getSimpleName())
.setIndicator(AFragment.class.getSimpleName());
//tabHost.addTab(xxx);进行修改,增加Fragment.class,和Bundle参数
tabHost.addTab(tabSpecA,AFragment.class,null);
TabHost.TabSpec tabSpecB = tabHost
.newTabSpec(BFragment.class.getSimpleName())
.setIndicator(BFragment.class.getSimpleName());
tabHost.addTab(tabSpecB, BFragment.class,null);
//切换代码没有任何修改
findViewById(R.id.btn_1).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
tabHost.setCurrentTab(0);
}
});
findViewById(R.id.btn_2).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
tabHost.setCurrentTab(1);
}
});
}
}
activity_main.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--将TabHost替换成FragmentTabHost-->
<android.support.v4.app.FragmentTabHost
xmlns:android="http://schemas.android.com/apk/res/android"
android:id="@android:id/tabhost"
android:layout_width="fill_parent"
android:layout_height="fill_parent">
<LinearLayout
android:layout_width="fill_parent"
android:layout_height="fill_parent"
android:orientation="vertical">
<FrameLayout
android:id="@android:id/tabcontent"
android:layout_width="fill_parent"
android:layout_height="0.0dip"
android:layout_weight="1.0" >
</FrameLayout>
<TabWidget
android:id="@android:id/tabs"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_weight="0.0"
android:visibility="gone" />
<RadioGroup
android:id="@+id/main_radio"
android:layout_width="fill_parent"
android:layout_height="wrap_content"
android:layout_gravity="bottom"
android:gravity="center_vertical"
android:orientation="horizontal">
<Button
android:layout_weight="1"
android:id="@+id/btn_1"
android:text="btn_1"
android:layout_width="match_parent"
android:layout_height="match_parent" />
<Button
android:layout_weight="1"
android:id="@+id/btn_2"
android:text="btn_2"
android:layout_width="match_parent"
android:layout_height="match_parent" />
</RadioGroup>
</LinearLayout>
</android.support.v4.app.FragmentTabHost>
如上代码的注释修改的地方非常的少,这就满足了我们的第一点。
2. 特别需要注意生命周期的回调,切换Tab、跳转、返回等生命周期的回调方式。
针对第二点,Fragment
有着类似Activity
的生命周期,所以只要让新老代码的生命周期回调方式一样就可以。
下面我们来观察生命周期的走向。
老代码生命周期的走向如下:
//App启动 A页生命周期
02-23 15:47:37.392 12953-12953/com.andrjhf.ui.tab.demo E/AActivity: onCreate
02-23 15:47:37.392 12953-12953/com.andrjhf.ui.tab.demo E/AActivity: onStart
02-23 15:47:37.402 12953-12953/com.andrjhf.ui.tab.demo E/AActivity: onResume
//切换到B页生命周期
02-23 15:48:10.102 12953-12953/com.andrjhf.ui.tab.demo E/AActivity: onPause
02-23 15:48:10.122 12953-12953/com.andrjhf.ui.tab.demo E/BActivity: onCreate
02-23 15:48:10.122 12953-12953/com.andrjhf.ui.tab.demo E/BActivity: onStart
02-23 15:48:10.122 12953-12953/com.andrjhf.ui.tab.demo E/BActivity: onResume
//切换回A页生命周期
02-23 15:48:23.382 12953-12953/com.andrjhf.ui.tab.demo E/BActivity: onPause
02-23 15:48:23.382 12953-12953/com.andrjhf.ui.tab.demo E/AActivity: onResume
新代码生命周期回调:
//App启动 A页生命周期
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onAttach
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onCreate
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onCreateView
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onActivityCreated
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onStart
02-23 15:51:21.522 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onResume
//切换到B页生命周期
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onAttach
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onCreate
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onPause
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onStop
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onDestroyView
02-23 15:51:39.662 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onCreateView
02-23 15:51:39.672 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onActivityCreated
02-23 15:51:39.672 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onStart
02-23 15:51:39.672 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onResume
//切换回A页生命周期
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onPause
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onStop
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/BFragment: onDestroyView
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onCreateView
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onActivityCreated
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onStart
02-23 15:51:50.282 13378-13378/com.andrjhf.ui.tab.demo E/AFragment: onResume
我们看差异,A、B页来回切换,老代码的生命周期只是onPause
和onResume
的方法进行切换。
而新代码则不是,切换到B页时AFragment
会调用onDestroyView
方法销毁视图,而切换回来A页时会重新调用AFragment
的onCreateView
方法来重新加载视图,和老代码的生命周期不一样。
寻找突破点,首先想到的就是负责切换的FragmentTabHost
类,我们查看源码,直接上重点如下代码片段:
public class NotDestroyedFragmentTabHost extends FragmentTabHost {
......忽略
@Nullable
private FragmentTransaction doTabChanged(@Nullable String tag,
@Nullable FragmentTransaction ft) {
final TabInfo newTab = getTabInfoForTag(tag);
if (mLastTab != newTab) {
if (ft == null) {
ft = mFragmentManager.beginTransaction();
}
if (mLastTab != null) {
if (mLastTab.fragment != null) {
//重要代码,表示加载过的Fragment切换时需要销毁
//ft.detach(mLastTab.fragment);
//修改成如下代码,由于ft.hide(xxx);方法只是回到了Fragment的onHiddenChanged方法所以我手动调用了fragment的生命周期方法
mLastTab.fragment.onPause();
mLastTab.fragment.onStop();
ft.hide(mLastTab.fragment);
}
}
if (newTab != null) {
if (newTab.fragment == null) {
newTab.fragment = Fragment.instantiate(mContext,
newTab.clss.getName(), newTab.args);
ft.add(mContainerId, newTab.fragment, newTab.tag);
} else {
//重要代码,表示已经添加过的Fragment展示的时候重新绑定
//ft.attach(newTab.fragment);
//修改成如下代码,由于ft.show(xxx);方法只是回到了Fragment的onHiddenChanged方法所以我手动调用了fragment的生命周期方法
newTab.fragment.onStart();
newTab.fragment.onResume();
ft.show(newTab.fragment);
}
}
mLastTab = newTab;
}
return ft;
}
......忽略
}
修改完成之后将activity_main.xml
中的TabHost
替换成NotDestroyedFragmentTabHost
之后再看生命周期打印信息:
//App启动 A页生命周期
02-23 16:09:39.412 15819-15819/? E/AFragment: onAttach
02-23 16:09:39.412 15819-15819/? E/AFragment: onCreate
02-23 16:09:39.422 15819-15819/? E/AFragment: onCreateView
02-23 16:09:39.422 15819-15819/? E/AFragment: onActivityCreated
02-23 16:09:39.422 15819-15819/? E/AFragment: onStart
02-23 16:09:39.422 15819-15819/? E/AFragment: onResume
//切换到B页生命周期
02-23 16:09:53.772 15819-15819/com.andrjhf.ui.tab.demo E/AFragment: onPause
02-23 16:09:53.772 15819-15819/com.andrjhf.ui.tab.demo E/AFragment: onStop
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onAttach
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onCreate
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onCreateView
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onActivityCreated
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onStart
02-23 16:09:53.782 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onResume
//切换回A页生命周期
02-23 16:10:01.062 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onPause
02-23 16:10:01.062 15819-15819/com.andrjhf.ui.tab.demo E/BFragment: onStop
02-23 16:10:01.062 15819-15819/com.andrjhf.ui.tab.demo E/AFragment: onStart
02-23 16:10:01.062 15819-15819/com.andrjhf.ui.tab.demo E/AFragment: onResume
如上A、B也的切换只是onStart、onResume
和onPause、onStop
来回进行切换,达到了我们的目的。
3.需要注意父类扩展的方法。
第三点,如果之前Activity
的父类是自己写的例如BaseActiviy
那么Fragment
也要自己写父类BaseFragment
去实现相应的方法。
在我真实项目的代码中BaseActivity
实现了EventBus
、ButterKnife
、登录成功的回调等等。
在BaseFragment
中也要去相应的实现这些功能。
如下代码示例:
BaseActivity.java
public abstract class BaseActivity extends Activity {
private static final String TAG = BaseActivity.class.getSimpleName();
protected Context mContext = null;
private Unbinder unbinder;
@Override
public void onContentChanged() {
super.onContentChanged();
unbinder = ButterKnife.bind(this);
}
public <T extends View> T findById(int resId) {
return ButterKnife.findById(this, resId);
}
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mContext = this;
requestWindowFeature(Window.FEATURE_NO_TITLE);
EventBus.getDefault().register(this);
PushUtil.init(mContext);
}
@Override
protected void onDestroy() {
super.onDestroy();
ToastUtil.getInstance(this).cancelToast();
dismissPermissionDialog();
EventBus.getDefault().unregister(this);
HttpRequestUtil.cancelPendingRequests(this);
if (unbinder != null) {
unbinder.unbind();
unbinder = null;
}
}
protected void showLoadingView() {
}
protected void dismissLoadingView() {
}
public void onEventMainThread(Object event) {
if (event instanceof OnLoginEvent) {
Object result = ((OnLoginEvent) event).mMoInfoModel;
onLoginCompleted(result);
}
}
protected void onLoginCompleted(Object login) {
Logger.d(TAG, "onLoginCompleted, result = " + login);
}
}
BaseFragment.java
public abstract class BaseFragment extends cn.feng.skin.manager.base.BaseFragment {
private static final String TAG = BaseActivity.class.getSimpleName();
protected Activity mActivity;
protected Context mContext;
private Unbinder unbinder;
@Override
public void onAttach(Activity activity) {
mActivity = activity;
mContext = activity;
super.onAttach(activity);
}
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
EventBus.getDefault().register(this);
}
@Override
public void onViewCreated(View view, @Nullable Bundle savedInstanceState) {
super.onViewCreated(view, savedInstanceState);
unbinder = ButterKnife.bind(this, view);
}
@Override
public void onDestroyView() {
super.onDestroyView();
ToastUtil.getInstance(mActivity).cancelToast();
EventBus.getDefault().unregister(this);
HttpRequestUtil.cancelPendingRequests(this);
if (unbinder != null) {
unbinder.unbind();
unbinder = null;
}
}
@Override
public void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
protected void onLoginCompleted(Object login) {
Logger.d(TAG, "onLoginCompleted, result = " + login);
}
public void onEventMainThread(Object event) {
if (event instanceof OnLoginEvent) {
Object result = ((OnLoginEvent) event).mMoInfoModel;
onLoginCompleted(result);
}
}
protected void showLoadingView() {
}
protected void dismissLoadingView() {
}
}
4.尽量增加代码,减少修改代码。
第四点 :这个很简单我们用Fragment
替换Activity
不要删除Activity
或者在原有代码上修改,一定要新建一个Fragment
文件进行修改保留当时Activity
的代码,用来进行后期比较。
总结:
对于这种重构一定要想清楚在修改,改完之后一定要进行严格的回归测试,把每个逻辑都测试到,避免留下bug。