LifeCycle源码分析
LifeCycle源码分析是有两部分，一部分是注册观察者，另一部分是被观察者。
一、先从观察者这块进行分析。
第一行代码
//注册观察者对象
getLifecycle().addObserver(lifeCycleView);getLifeCycle()返回的是LifecycleRegistry 实例。LifecycleRegistry 是定义在ComponentActivity类中的，并把this传到了LifecycleRegistry 构造函数中
private final LifecycleRegistry mLifecycleRegistry = new LifecycleRegistry(this);
@Override
public Lifecycle getLifecycle() {
return mLifecycleRegistry;
}注册观察者 addObserver(lifeCycleView)
创建了一个ObserverWithState 对象，并把观察者和该对象报错到了mObserverMap，一个hashmap中，一个Activity可以添加多个观察者,所以用一个HashMap集合存储观察者和对应的状态。
@Override
public void addObserver(@NonNull LifecycleObserver observer) {
//初始状态：INITIALIZED
State initialState = mState == DESTROYED ? DESTROYED : INITIALIZED;
//包含状态和观察者的类
ObserverWithState statefulObserver = new ObserverWithState(observer, initialState);
//以Observer为key，以statefulObserver为value的集合。
//一个Activity可以添加多个观察者,所以用一个HashMap集合存储观察者和对应的状态
ObserverWithState previous = mObserverMap.putIfAbsent(observer, statefulObserver);
....
}再看ObserverWithState类：
在构造函数中调用了mLifecycleObserver = Lifecycling.lifecycleEventObserver(observer);
mLifecycleObserver把传进来的observer观察者做了一层封装。
mState = initialState; 保存观察者状态，这个会和生命周期函数挂钩。
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 = event.getTargetState();
mState = min(mState, newState);
mLifecycleObserver.onStateChanged(owner, event);
mState = newState;
}
}再看Lifecycling.lifecycleEventObserver(observer);返回的是ReflectiveGenericLifecycleObserver对象的实例。注意它的构造函数，把观察者传递进去了。
static GenericLifecycleObserver lifecycleEventObserver(Object object) {
//传进来的observer是实现了LifecycleObserver接口，所以下面的代码可以忽略。
.......
return new ReflectiveGenericLifecycleObserver(object);
}ReflectiveGenericLifecycleObserver，从名字上看反射生成生命周期观察者。
在他的构造函数中，mWrapped，用了接收传递进来的observer对象。
CallbackInfo mInfo 保存了定义在观察者上的方法和注解。
class ReflectiveGenericLifecycleObserver implements LifecycleEventObserver {
private final Object mWrapped;
private final CallbackInfo mInfo;
ReflectiveGenericLifecycleObserver(Object wrapped) {
mWrapped = wrapped;
//解析定义在observer上的方法和注解
mInfo = ClassesInfoCache.sInstance.getInfo(mWrapped.getClass());
}
//用于生命周期函数改变后的回调
@Override
public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Event event) {
//反射调用？
mInfo.invokeCallbacks(source, event, mWrapped);
}
}再看mInfo = ClassesInfoCache.sInstance.getInfo(mWrapped.getClass());
把observer对象的class传进来的，可以大胆猜测，他是要通过反射的方式来拿到方法和注解了。看源码。
getInfo()先从hashmap中拿，没有的话再去解析，这个是常规操作，Retrofit中解析定义在方法上的注解时也是这样做的。
private final Map, CallbackInfo> mCallbackMap = new HashMap<>();
CallbackInfo getInfo(Class klass) {
//先从hashMap缓存中拿去，
CallbackInfo existing = mCallbackMap.get(klass);
if (existing != null) {
return existing;
}
//缓存中没有的话，再去解析
existing = createInfo(klass, null);
return existing;
}
//反射定义在observer身上的包含有OnLifecycleEvent注解的方法
private CallbackInfo createInfo(Class klass, @Nullable Method[] declaredMethods) {
//以MethodReference为key，方法和参数个数，
//以方法上的注解Lifecycle.Event为value
//考虑到java方法的重载，所以不能直接用方法名做为key。用的是方法名加参数格式为可以
Map handlerToEvent = new HashMap<>();
//通过反射获取所有定义的方法。
Method[] methods = declaredMethods != null ? declaredMethods : getDeclaredMethods(klass);
boolean hasLifecycleMethods = false;
for (Method method : methods) {
//过滤包含OnLifecycleEvent注解的方法。
OnLifecycleEvent annotation = method.getAnnotation(OnLifecycleEvent.class);
if (annotation == null) {
continue;
}
hasLifecycleMethods = true;
//获取方法的参数
Class[] params = method.getParameterTypes();
int callType = CALL_TYPE_NO_ARG;
if (params.length > 0) {
callType = CALL_TYPE_PROVIDER;
//如果是一个参数的，必须是LifecycleOwner类型。
if (!params[0].isAssignableFrom(LifecycleOwner.class)) {
throw new IllegalArgumentException(
"invalid parameter type. Must be one and instanceof LifecycleOwner");
}
}
//拿到定义在方法上的注解的值，
Lifecycle.Event event = annotation.value();
if (params.length > 1) {
callType = CALL_TYPE_PROVIDER_WITH_EVENT;
//如果有两个参数，第二个必须是Lifecycle.Event类型。
if (!params[1].isAssignableFrom(Lifecycle.Event.class)) {
throw new IllegalArgumentException(
"invalid parameter type. second arg must be an event");
}
//如果有两个参数，第二个参数的值必须是Lifecycle.Event.ON_ANY。
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);
//将methodReference和event，存放在handlerToEvent Map中
verifyAndPutHandler(handlerToEvent, methodReference, event, klass);
}
//这个构造函数将handlerToEvent转换为以event为key，以list为value，list存放method的HashMap
//因为同一个注解，可以定义在多个方法上，所以Method用一个List集合保存
CallbackInfo info = new CallbackInfo(handlerToEvent);
//将observer的 class 和 info保存的map中
mCallbackMap.put(klass, info);
//存放observer的class和boolean值，是否包含生命周期方法
mHasLifecycleMethods.put(klass, hasLifecycleMethods);
return info;
} //将MethodReference为key，Lifecycle.Event为value，保存在handlerToEvent集合中
private void verifyAndPutHandler(Map handlers,
MethodReference newHandler, Lifecycle.Event newEvent, Class klass) {
Lifecycle.Event event = handlers.get(newHandler);
if (event == null) {
handlers.put(newHandler, newEvent);
}
} 再看 CallbackInfo info = new CallbackInfo(handlerToEvent);
//mEventToHandlers 注解为key，value是方法签名的一个集合
final Map> mEventToHandlers;
//handlerToEvent，方法签名为key，注解为value
final Map mHandlerToEvent;
CallbackInfo(Map handlerToEvent) {
mHandlerToEvent = handlerToEvent;
mEventToHandlers = new HashMap<>();
for (Map.Entry entry : handlerToEvent.entrySet()) {
//拿到注解
Lifecycle.Event event = entry.getValue();
//拿到方法签名的集合
List methodReferences = mEventToHandlers.get(event);
if (methodReferences == null) {
methodReferences = new ArrayList<>();
//以注解为key，方法签名为value保存在了hashmap中
mEventToHandlers.put(event, methodReferences);
}
将方法签名保存在集合中
methodReferences.add(entry.getKey());
}
} 以上代码执行完成，addObserver的代码也就执行完了。
总结一下，addObserver 将定义在方法上的注解，解析完毕后，保存在了CallbackInfo中。
在CallbackInfo中，是通过Map
来保存的。以注解为key，以生命该注解的所有方法的集合为value。
准备工作已经做完，那么observer是如何感知生命周期变化的呢，接下来要看被观察者中的代码是如何实现的。
二、被观察者源码分析
还记得getLifecycle()方法定义在哪个类吗？
是定义在ComponentActivity这个类中，这个类实现了LifecycleOwner接口。
LifecycleOwner 字面意思，生命周期拥有者，没错。
LifecycleOwner接口，就定义了一个方法getLifecycle()。
public interface LifecycleOwner {
/**
* Returns the Lifecycle of the provider.
*
* @return The lifecycle of the provider.
*/
@NonNull
Lifecycle getLifecycle();
}
在ComponentActivity类中实现了该接口，重写了getLifecycle()方法。
private final LifecycleRegistry mLifecycleRegistry = new LifecycleRegistry(this);
@Override
public Lifecycle getLifecycle() {
return mLifecycleRegistry;
}在ComponentActivity onCreate方法中调用了 ReportFragment.injectIfNeededIn(this);
要监听Activity声明周期变化，首先得有一个能够感知Activity生命周期变化的类，ReportFragment。
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
//向Activity中，添加一个空的Fragment
ReportFragment.injectIfNeededIn(this);
}将ReportFragment添加到了FragmentManager中，这样它就能够感知Activity声明周期变化
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();
manager.executePendingTransactions();
}
}定义一个ReportFragment这样做的目的是啥呢？看他的生命周期方法。因为Activity生命周期发生变化后，会回调Fragment生命周期函数。
@Override
public void onActivityCreated(Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
dispatchCreate(mProcessListener);
dispatch(Lifecycle.Event.ON_CREATE);
}
@Override
public void onStart() {
super.onStart();
dispatchStart(mProcessListener);
dispatch(Lifecycle.Event.ON_START);
}
@Override
public void onResume() {
super.onResume();
dispatchResume(mProcessListener);
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);
// just want to be sure that we won't leak reference to an activity
mProcessListener = null;
}可以看到在他的生命周期函数中，都调用了同一个方法dispatch()，并传递了不同的参数。
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);
}
}上面的注释意思是。只有sdk小于29的会调用 dispatch(getActivity(), event);
在29+的api，被ActivityLifecycleCallbacks函数处理的。
Android 29对应的就是Android10，Android10版本的api变动很大。包括网络变化的监听，之前是通过广播的形式进行传递和接收的。也改成了注册回调函数的形式。关于网络变化的监听，以后会写文章进行分析。
再看dispatch(getActivity(), event);
static void dispatch(@NonNull Activity activity, @NonNull Lifecycle.Event event) {
if (activity instanceof LifecycleRegistryOwner) {
((LifecycleRegistryOwner) activity).getLifecycle().handleLifecycleEvent(event);
return;
}
//在这，走的是这个分支
if (activity instanceof LifecycleOwner) {
Lifecycle lifecycle = ((LifecycleOwner) activity).getLifecycle();
if (lifecycle instanceof LifecycleRegistry) {
((LifecycleRegistry) lifecycle).handleLifecycleEvent(event);
}
}
}很显然此时activity 是LifecycleOwner的实例，
getLifecycle()返回的就是定义在ComponentActivity中LifecycleRegistry 的实例对象。
再看 ((LifecycleRegistry) lifecycle).handleLifecycleEvent(event);
在LifecycleRegistry中，传递进来的event，就是不同生命周期函数中，传入的event。
public void handleLifecycleEvent(@NonNull Lifecycle.Event event) {
enforceMainThreadIfNeeded("handleLifecycleEvent");
moveToState(event.getTargetState());
}
event.getTargetState() 得到当前的状态。
@NonNull
public State getTargetState() {
switch (this) {
case ON_CREATE:
case ON_STOP:
return State.CREATED;
case ON_START:
case ON_PAUSE:
return State.STARTED;
case ON_RESUME:
return State.RESUMED;
case ON_DESTROY:
return State.DESTROYED;
case ON_ANY:
break;
}
throw new IllegalArgumentException(this + " has no target state");
}moveToState(event.getTargetState());重点看sync()函数。通过观察者中的生命周期函数回调。
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;
}
/同步Observer中的State，使之和Activity的当前状态保存一致
private void sync() {
while (!isSynced()) {
mNewEventOccurred = false;
//比较当前Activity的状态和集合中链表头部的observer中保存的状态值，
//如果小于0说明是mState的状态值小于Observer中保存的状态值，
//说明Activity是从onResume到onDestroy。
if (mState.compareTo(mObserverMap.eldest().getValue().mState) < 0) {
backwardPass(lifecycleOwner);
}
Entry newest = mObserverMap.newest();
//比较当前Activity的状态和集合中链表头部的observer中保存的状态值，
//如果大于0，说明是从onCreate到onResume
if (!mNewEventOccurred && newest != null
&& mState.compareTo(newest.getValue().mState) > 0) {
forwardPass(lifecycleOwner);
}
}
mNewEventOccurred = false;
}
private void backwardPass(LifecycleOwner lifecycleOwner) {
Iterator> descendingIterator = mObserverMap.descendingIterator();
//循环遍历map中保存的所有观察者
while (descendingIterator.hasNext() && !mNewEventOccurred) {
Entry entry = descendingIterator.next();
//拿到map中，保存Activity状态的观察者
ObserverWithState observer = entry.getValue();
//第二层循环，是逐个遍历observer中的状态，使之成为最新的状态，并调用生命周期方法
while ((observer.mState.compareTo(mState) > 0 && !mNewEventOccurred
&& mObserverMap.contains(entry.getKey()))) {
//downEvent通过observer中保存的状态，得到下一个生命周期的Event
Event event = downEvent(observer.mState);
pushParentState(getStateAfter(event));
//执行回调
observer.dispatchEvent(lifecycleOwner, event);
popParentState();
}
}
} observer.dispatchEvent(lifecycleOwner, event);
这个observer是 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 = event.getTargetState();
mState = min(mState, newState);
mLifecycleObserver.onStateChanged(owner, event);
mState = newState;
}
}在dispatchEvent()中会调用 mLifecycleObserver.onStateChanged(owner, event);
mLifecycleObserver就是构造函数中创建的ReflectiveGenericLifecycleObserver的实例，这就和注册观察者的代码关联上了。
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);
}
}看 mInfo.invokeCallbacks(source, event, mWrapped);
void invokeCallbacks(LifecycleOwner source, Lifecycle.Event event, Object target) {
invokeMethodsForEvent(mEventToHandlers.get(event), source, event, target);
invokeMethodsForEvent(mEventToHandlers.get(Lifecycle.Event.ON_ANY), source, event,
target);
} private static void invokeMethodsForEvent(List 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);
}
}
} 还记得这个Handlers是啥吗？
final Map
这个保存的Event注解为key，方法签名结合为value的hasmap
mEventToHandlers.get(event) 拿到的就是方法的集合。
这行代码就是在遍历这个集合，拿到MethodReference对象，调用他的invokeCallback方法。
for (int i = handlers.size() - 1; i >= 0; i--) {
handlers.get(i).invokeCallback(source, event, mWrapped);
} //通过反射调用observer中定义的生命周期方法，通过参数的个数匹配对应的方法。
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);
}
}通过以上代码，就调用到了定义在LifecycleObserver中对应的生命周期函数的方法。
通过对观察者，和被观察者源码的分析，就清楚了LifeCycle实现的逻辑。
主要用到的技术点，就是观察者设计模式和注解反射的综合使用。
而Retrofit框架，用到的是动态代理和注解反射的技术的结合。
在开源框架中，用到了大量的注解反射以及设计模式。所以我们要对设计模式有一个比较清晰的认识。