为什么要使用Lifecycle?
如果在Activity或者Fragment生命周期中做了很多操作,代码看起来特别多,Activity或者Fragment看起来特别的臃肿,为了解决这样的代码臃肿,Lifecycle把这些生命周期的操作拿了出来,新建了一个类去维护生命周期里的逻辑。
首先看一下代码的具体实现
本地的依赖
dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
implementation 'androidx.appcompat:appcompat:1.2.0'
implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
}
Activity实现
public class JetpackActivity extends AppCompatActivity {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_jectpack);
Log.d("JeckpackActivity","onCreate");
getLifecycle().addObserver(new MyObserver(this));
}
}
具体的类实现
public class MyObserver implements LifecycleObserver {
private Activity mActivity;
private Button mBtn ;
public MyObserver(Activity activity){
mActivity = activity;
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
public void onResume(){
Log.d("WANZIKAIFA","onResume");
}
@OnLifecycleEvent(Lifecycle.Event.ON_START)
public void onStart(){
Log.d("WANZIKAIFA","onStart");
}
@OnLifecycleEvent(Lifecycle.Event.ON_CREATE)
public void onCreate(){
Button btn = (Button)mActivity.findViewById(R.id.btn);
Log.d("WANZIKAIFA","onCreate");
btn.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
mActivity.finish();
}
});
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
public void onPause(){
Log.d("WANZIKAIFA","onPause");
}
@OnLifecycleEvent(Lifecycle.Event.ON_STOP)
public void onStop(){
Log.d("WANZIKAIFA","onStop");
}
@OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
public void onDestory(){
Log.d("WANZIKAIFA","onDestory");
}
}
运行结果
01-01 00:08:57.767 12450 12450 D WANZIKAIFA: onCreate
01-01 00:08:57.774 12450 12450 D WANZIKAIFA: onStart
01-01 00:08:57.777 12450 12450 D WANZIKAIFA: onResume
01-01 00:09:12.035 12450 12450 D WANZIKAIFA: onPause
01-01 00:09:12.257 12450 12450 D WANZIKAIFA: onStop
01-01 00:09:12.261 12450 12450 D WANZIKAIFA: onDestory
Lifecycle的原理
Lifecycle的生命周期状态事件和状态
Lifecycle使用两个枚举来跟踪其关联组件的生命周期状态,这两个枚举分别是Event和State。State代表Lifecycle的生命周期所处的状态,Event代表Lifecycle生命周期对应的事件,这些事件会映射到Activity和Fragment的回调事件中。
当前使用的是9.0环境源码如下
package androidx.lifecycle
public abstract class Lifecycle {
...
//添加观察者
@MainThread
public abstract void addObserver(@NonNull LifecycleObserver observer);
//移除观察者
@MainThread
public abstract void removeObserver(@NonNull LifecycleObserver observer);
@MainThread
@NonNull
public abstract State getCurrentState();
@SuppressWarnings("WeakerAccess")
public enum Event {
/**
* {@link LifecycleOwner}的onCreate事件常量.
*/
ON_CREATE,
/**
* {@link LifecycleOwner}的onStart事件常量.
*/
ON_START,
/**
* {@link LifecycleOwner}的onResume事件常量.
*/
ON_RESUME,
/**
* {@link LifecycleOwner}的onPause事件常量.
*/
ON_PAUSE,
/**
* {@link LifecycleOwner}的onStop事件常量.
*/
ON_STOP,
/**
* {@link LifecycleOwner}的onDestroy事件常量.
*/
ON_DESTROY,
/**
* 可以用来匹配所有事件的{@link Event Event}常量.
*/
ON_ANY
}
@SuppressWarnings("WeakerAccess")
public enum State {
/**
* 在此之后,Lifecycle 不会再派发生命周期事件。
* 此状态在 Activity.onDestroy() 之前
*/
DESTROYED,
/**
*在 Activity 已经实例化但未 onCreate() 之前
*/
INITIALIZED,
/**
*在 Activity 的 onCreate() 之后到 onStop() 之前
*/
CREATED,
/**
*在 Activity 的 onStart() 之后到 onPause() 之前
*/
STARTED,
/**
* 在 Activity 的 onResume() 之后
*/
RESUMED;
/**
* 比较这个状态是否大于或等于给定的{@code State}
*如果这个状态大于或等于给定的{@code State},则返回true
*/
public boolean isAtLeast(@NonNull State state) {
return compareTo(state) >= 0;
}
}
}
关系图如下
(转发:刘望舒 https://www.sohu.com/a/341890749_100004247)
Lifecycle是如何观察Activity和Fragment的生命周期?
在Android Support Library 26.1.0 及其之后的版本,Activity和Fragment已经默认实现了LifecycleOwner接口,LifecycleOwner可以理解为被观察者,那么Lifecycle是如何观察Activity和Fragment的生命周期的呢?
MainActivity继承了AppCompatActivity,而AppCompatActivity继承了FragmentActivity。在Android 8.0时,FragmentActivity继承自SupportActivity,而在Android 9.0,FragmentActivity继承自ComponentActivity 。当前环境为9.0,以ComponentActivity 为例子(为什么先查看ComponentActivity ,因为父类的执行流程先于子类)
源码如下
public class ComponentActivity extends androidx.core.app.ComponentActivity implements
LifecycleOwner,
ViewModelStoreOwner,
HasDefaultViewModelProviderFactory,
SavedStateRegistryOwner,
OnBackPressedDispatcherOwner {
private final LifecycleRegistry mLifecycleRegistry = new LifecycleRegistry(this);//1 创建了LifecycleRegistry
...
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mSavedStateRegistryController.performRestore(savedInstanceState);
ReportFragment.injectIfNeededIn(this);//2 将ComponentActivity注入ReportFragment
if (mContentLayoutId != 0) {
setContentView(mContentLayoutId);
}
}
@CallSuper
@Override
protected void onSaveInstanceState(@NonNull Bundle outState) {
Lifecycle lifecycle = getLifecycle();
if (lifecycle instanceof LifecycleRegistry) {
((LifecycleRegistry) lifecycle).setCurrentState(Lifecycle.State.CREATED);//3 将lifecycle的状态设置为CREATED
}
super.onSaveInstanceState(outState);
mSavedStateRegistryController.performSave(outState);
}
@NonNull
@Override
public Lifecycle getLifecycle() {
return mLifecycleRegistry;//4实现了LifecycleOwner接口定义的getLifecycle方法
}
}
正常来说应该在ComponentActivity的各个生命周期方法中改变Lifecycle的State,显然在ComponentActivity中没有做这些,而是将这个任务交给了ReportFragment,注释2处的将ComponentActivity注入到ReportFragment中。
接下来看一下ReportFragment源码
package androidx.lifecycle;
public class ReportFragment extends Fragment {
private static final String REPORT_FRAGMENT_TAG = "androidx.lifecycle"
+ ".LifecycleDispatcher.report_fragment_tag";
public static void injectIfNeededIn(Activity activity) {
android.app.FragmentManager manager = activity.getFragmentManager();
if (manager.findFragmentByTag(REPORT_FRAGMENT_TAG) == null) {
manager.beginTransaction().add(new ReportFragment(), REPORT_FRAGMENT_TAG).commit();
// Hopefully, we are the first to make a transaction.
manager.executePendingTransactions();
}
}
@SuppressWarnings("deprecation")
static void dispatch(@NonNull Activity activity, @NonNull Lifecycle.Event event) {
if (activity instanceof LifecycleRegistryOwner) {//2判断当前activity是否实现了LifecycleRegistryOwner接口
((LifecycleRegistryOwner) activity).getLifecycle().handleLifecycleEvent(event);
return;
}
if (activity instanceof LifecycleOwner) {//3判断当前activity是否实现了LifecycleOwner
Lifecycle lifecycle = ((LifecycleOwner) activity).getLifecycle();
if (lifecycle instanceof LifecycleRegistry) {
((LifecycleRegistry) lifecycle).handleLifecycleEvent(event);
}
}
}
static ReportFragment get(Activity activity) {
return (ReportFragment) activity.getFragmentManager().findFragmentByTag(
REPORT_FRAGMENT_TAG);
}
@Override
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
dispatch(Lifecycle.Event.ON_CREATE);
}
@Override
public void onStart() {
super.onStart();
dispatch(Lifecycle.Event.ON_START); //1
}
@Override
public void onResume() {
super.onResume();
dispatch(Lifecycle.Event.ON_RESUME);
}
@Override
public void onPause() {
super.onPause();
dispatch(Lifecycle.Event.ON_PAUSE);
}
@Override
public void onStop() {
super.onStop();
dispatch(Lifecycle.Event.ON_STOP);
}
@Override
public void onDestroy() {
super.onDestroy();
dispatch(Lifecycle.Event.ON_DESTROY);
}
private void dispatch(@NonNull Lifecycle.Event event) {
if (Build.VERSION.SDK_INT < 29) {
// Only dispatch events from ReportFragment on API levels prior
// to API 29. On API 29+, this is handled by the ActivityLifecycleCallbacks
// added in ReportFragment.injectIfNeededIn
dispatch(getActivity(), event);
}
}
}
ReportFragment的onStart方法中会调用注释1处的dispatch方法。在dispatch方法的注释2处,判断Activity是否实现了LifecycleRegistryOwner接口,LifecycleRegistryOwner继承了LifecycleOwner接口,这两个接口不同的是,LifecycleRegistryOwner定义的getLifecycle方法返回的是LifecycleRegistry类型,而LifecycleOwner定义的getLifecycle方法返回的是Lifecycle类型。注释3处如果Activity实现了LifecycleOwner接口,会调用LifecycleRegistry的handleLifecycleEvent方法。
接下来看一下执行的handleLifecycleEvent方法
public void handleLifecycleEvent(@NonNull Lifecycle.Event event) {
State next = getStateAfter(event);
moveToState(next);
}
static State getStateAfter(Event event) {
switch (event) {
case ON_CREATE:
case ON_STOP:
return CREATED;
case ON_START:
case ON_PAUSE:
return STARTED;
case ON_RESUME:
return RESUMED;
case ON_DESTROY:
return DESTROYED;
case ON_ANY:
break;
}
throw new IllegalArgumentException("Unexpected event value " + event);
}
private void moveToState(State next) {
if (mState == next) {
return;
}
mState = next;
if (mHandlingEvent || mAddingObserverCounter != 0) {
mNewEventOccurred = true;
// we will figure out what to do on upper level.
return;
}
mHandlingEvent = true;
sync();
mHandlingEvent = false;
}
getStateAfter方法会获取“即将的事件” :当前事件执行后,即将会处于什么事件
这个和文章开头给出的State与Event关系的时序图对照看会比较好理解,比如当前执行了ON_CREATE事件或者ON_STOP事件,那么状态就会处于CREATED。回到handleLifecycleEvent方法,其内部还会调用moveToState方法。如果当前所处的状态和即将要处于的状态一样就不做任何操作,sync方法如下所示。
private void sync() {
LifecycleOwner lifecycleOwner = mLifecycleOwner.get();
if (lifecycleOwner == null) {
throw new IllegalStateException("LifecycleOwner of this LifecycleRegistry is already"
+ "garbage collected. It is too late to change lifecycle state.");
}
while (!isSynced()) {
mNewEventOccurred = false;
// no need to check eldest for nullability, because isSynced does it for us.
if (mState.compareTo(mObserverMap.eldest().getValue().mState) < 0) {
backwardPass(lifecycleOwner);
}
Entry<LifecycleObserver, ObserverWithState> newest = mObserverMap.newest();
if (!mNewEventOccurred && newest != null
&& mState.compareTo(newest.getValue().mState) > 0) {
forwardPass(lifecycleOwner);
}
}
mNewEventOccurred = false;
}
sync方法中会根据当前状态和mObserverMap中的eldest和newest的状态做对比 ,判断当前状态是向前还是向后,比如由STARTED到RESUMED是状态向前,反过来就是状态向后,这个不要和Activity的生命周期搞混。向前还是向后的代码大同小异,这里以向后为例。
private void forwardPass(LifecycleOwner lifecycleOwner) {
Iterator<Entry<LifecycleObserver, ObserverWithState>> ascendingIterator =
mObserverMap.iteratorWithAdditions();
while (ascendingIterator.hasNext() && !mNewEventOccurred) {
Entry<LifecycleObserver, ObserverWithState> entry = ascendingIterator.next();
ObserverWithState observer = entry.getValue();//1
while ((observer.mState.compareTo(mState) < 0 && !mNewEventOccurred
&& mObserverMap.contains(entry.getKey()))) {
pushParentState(observer.mState);
observer.dispatchEvent(lifecycleOwner, upEvent(observer.mState));//2
popParentState();
}
}
}
注释1处的用于获取ObserverWithState,后面会在提到它。
注释2处的upEvent方法会得到当前状态的向前状态。ObserverWithState的dispatchEvent方法如下所示。
static class ObserverWithState {
State mState;
LifecycleEventObserver mLifecycleObserver;
ObserverWithState(LifecycleObserver observer, State initialState) {
mLifecycleObserver = Lifecycling.lifecycleEventObserver(observer);
mState = initialState;
}
void dispatchEvent(LifecycleOwner owner, Event event) {
State newState = getStateAfter(event);
mState = min(mState, newState);
mLifecycleObserver.onStateChanged(owner, event);
mState = newState;
}
}
从名称就可以看出来,它内部包括了State和LifecycleEventObserver ,LifecycleEventObserver 是一个接口,它继承了LifecycleObserver接口。
接下来分析onStateChanged方法是如何实现的。寻找该实现方式发现有两处如下
class ReflectiveGenericLifecycleObserver implements LifecycleEventObserver {
private final Object mWrapped;
private final CallbackInfo mInfo;
ReflectiveGenericLifecycleObserver(Object wrapped) {
mWrapped = wrapped;
mInfo = ClassesInfoCache.sInstance.getInfo(mWrapped.getClass());
}
@Override
public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Event event) {
mInfo.invokeCallbacks(source, event, mWrapped);//1
}
}
注释1处会调用CallbackInfo的invokeCallbacks方法,在讲这个方法前,需要先了解CallbackInfo是怎么创建的,是由createInfo方法创建的,如下所示。
private CallbackInfo createInfo(Class<?> klass, @Nullable Method[] declaredMethods) {
Class<?> superclass = klass.getSuperclass();
Map<MethodReference, Lifecycle.Event> handlerToEvent = new HashMap<>();
if (superclass != null) {
CallbackInfo superInfo = getInfo(superclass);
if (superInfo != null) {
handlerToEvent.putAll(superInfo.mHandlerToEvent);
}
}
Class<?>[] interfaces = klass.getInterfaces();
for (Class<?> intrfc : interfaces) {
for (Map.Entry<MethodReference, Lifecycle.Event> entry : getInfo(
intrfc).mHandlerToEvent.entrySet()) {
verifyAndPutHandler(handlerToEvent, entry.getKey(), entry.getValue(), klass);
}
}
Method[] methods = declaredMethods != null ? declaredMethods : getDeclaredMethods(klass);
boolean hasLifecycleMethods = false;
for (Method method : methods) {
OnLifecycleEvent annotation = method.getAnnotation(OnLifecycleEvent.class);//1
if (annotation == null) {
continue;
}
hasLifecycleMethods = true;
Class<?>[] params = method.getParameterTypes();
int callType = CALL_TYPE_NO_ARG;
if (params.length > 0) {
callType = CALL_TYPE_PROVIDER;
if (!params[0].isAssignableFrom(LifecycleOwner.class)) {
throw new IllegalArgumentException(
"invalid parameter type. Must be one and instanceof LifecycleOwner");
}
}
Lifecycle.Event event = annotation.value();//2
if (params.length > 1) {
callType = CALL_TYPE_PROVIDER_WITH_EVENT;
if (!params[1].isAssignableFrom(Lifecycle.Event.class)) {
throw new IllegalArgumentException(
"invalid parameter type. second arg must be an event");
}
if (event != Lifecycle.Event.ON_ANY) {
throw new IllegalArgumentException(
"Second arg is supported only for ON_ANY value");
}
}
if (params.length > 2) {
throw new IllegalArgumentException("cannot have more than 2 params");
}
MethodReference methodReference = new MethodReference(callType, method);//3
verifyAndPutHandler(handlerToEvent, methodReference, event, klass);//4
}
CallbackInfo info = new CallbackInfo(handlerToEvent);//5
mCallbackMap.put(klass, info);
mHasLifecycleMethods.put(klass, hasLifecycleMethods);
return info;
}
关键点在注释1处,不断的遍历各个方法,获取方法上的名为OnLifecycleEvent的注解,这个注解正是实现LifecycleObserver接口时用到的。注释2处获取该注解的值,也就是在@OnLifecycleEvent中定义的事件。注释3处新建了一个MethodReference,其内部包括了使用了该注解的方法。注释4处的verifyAndPutHandler方法用于将MethodReference和对应的Event存在类型为Map<MethodReference, Lifecycle.Event> 的handlerToEvent中。注释5处新建CallbackInfo,并将handlerToEvent传进去。接着回头看CallbackInfo的invokeCallbacks方法,代码如下所示。
package androidx.lifecycle;
class ClassesInfoCache {
private final Map<Class<?>, CallbackInfo> mCallbackMap = new HashMap<>();
private final Map<Class<?>, Boolean> mHasLifecycleMethods = new HashMap<>();
@SuppressWarnings("WeakerAccess")
static class CallbackInfo {
final Map<Lifecycle.Event, List<MethodReference>> mEventToHandlers;
final Map<MethodReference, Lifecycle.Event> mHandlerToEvent;
CallbackInfo(Map<MethodReference, Lifecycle.Event> handlerToEvent) {
mHandlerToEvent = handlerToEvent;
mEventToHandlers = new HashMap<>();
for (Map.Entry<MethodReference, Lifecycle.Event> entry : handlerToEvent.entrySet()) {//1
Lifecycle.Event event = entry.getValue();
List<MethodReference> methodReferences = mEventToHandlers.get(event);
if (methodReferences == null) {
methodReferences = new ArrayList<>();
mEventToHandlers.put(event, methodReferences);
}
methodReferences.add(entry.getKey());
}
}
@SuppressWarnings("ConstantConditions")
void invokeCallbacks(LifecycleOwner source, Lifecycle.Event event, Object target) {
invokeMethodsForEvent(mEventToHandlers.get(event), source, event, target);//2
invokeMethodsForEvent(mEventToHandlers.get(Lifecycle.Event.ON_ANY), source, event,
target);
}
private static void invokeMethodsForEvent(List<MethodReference> handlers,
LifecycleOwner source, Lifecycle.Event event, Object mWrapped) {
if (handlers != null) {
for (int i = handlers.size() - 1; i >= 0; i--) {
handlers.get(i).invokeCallback(source, event, mWrapped);
}
}
}
}
}
注释1处的循环的意义在于将handlerToEvent进行数据类型转换,转化为一个HashMap,key的值为事件,value的值为MethodReference。注释2处的invokeMethodsForEvent方法会传入mEventToHandlers.get(event),也就是事件对应的MethodReference的集合。invokeMethodsForEvent方法中会遍历MethodReference的集合,调用MethodReference的invokeCallback方法。
@SuppressWarnings("WeakerAccess")
static class MethodReference {
final int mCallType;
final Method mMethod;
MethodReference(int callType, Method method) {
mCallType = callType;
mMethod = method;
mMethod.setAccessible(true);
}
void invokeCallback(LifecycleOwner source, Lifecycle.Event event, Object target) {
//noinspection TryWithIdenticalCatches
try {
switch (mCallType) {
case CALL_TYPE_NO_ARG:
mMethod.invoke(target);
break;
case CALL_TYPE_PROVIDER:
mMethod.invoke(target, source);
break;
case CALL_TYPE_PROVIDER_WITH_EVENT:
mMethod.invoke(target, source, event);
break;
}
} catch (InvocationTargetException e) {
throw new RuntimeException("Failed to call observer method", e.getCause());
} catch (IllegalAccessException e) {
throw new RuntimeException(e);
}
}
}
MethodReference类中有两个变量,一个是callType,它代表调用方法的类型,另一个是Method,它代表方法,不管是哪种callType都会通过invoke对方法进行反射。简单来说,实现LifecycleObserver接口的类中,注解修饰的方法和事件会被保存起来,通过反射对事件的对应方法进行调用。这个调用链的时序图如下所示。
3.Lifecycle关联类
是以一个调用链的形式来介绍Lifecycle,调用链中涉及的类具体都是什么关系很难整体去把握,因此这里再以UML图的形式给出Lifecycle关联类,版本为Android 9.0。
AppCompatActivity继承自FragmentActivity,这两个类都不算是Lifecycle关联类。FragmentActivity实现了LifecycleOwner接口,LifecycleOwner和Lifecycle有一个"弱拥有的关系",LifecycleRegistry继承自Lifecycle,剩下的就不多介绍了,看图一目了然。
本文借鉴刘皇叔的文章:连接地址(https://www.sohu.com/a/341890749_100004247)