目录
1. 生命周期拥有者
android中Activity和Fragment具有生命周期,在Lifecycle组件中用LifecycleOwner接口来定义具有生命周期的所有对象,该接口中只定义了一个方法Lifecycle getLifecycle(),其返回类型为Lifecycle虚类,通过该虚类的State getCurrentState()方法可知其表征Android生命周期,通过addObserver(LifecycleObserver observer)和removeObserver(LifecycleObserver observer)方法可知其具有管理LifecycleObserver的能力,其子类只有LifecycleRegistry一个,是真正实现管理生命周期和观察者的对象。如果需要观察一个LifecycleOwner,则是通过addObserver()方法来实现的:
public void addObserver(@NonNull LifecycleObserver observer) {
State initialState = mState == DESTROYED ? DESTROYED : INITIALIZED;
ObserverWithState statefulObserver = new ObserverWithState(observer, initialState);
...
}
2. 生命周期观察者
Lifecycle用接口LifecycleObserver来表征生命周期观察者,其子接口LifecycleEventObserver用来接收和分发生命周期事件,当有生命周期变化时都是通过onStateChanged()方法来处理的。LifecycleEventObserver的实现类主要分为3种:
- 用于适配不同生命周期事件实现事件分发的FullLifecycleObserverAdapter
- 用于将生命周期事件分发给APT生成的GeneratedAdapter的SingleGeneratedAdapterObserver和CompositeGeneratedAdaptersObserver
- 采用反射方式处理生命周期事件的ReflectiveGenericLifecycleObserver
从上一节可以知道通过LifecycleRegistry的addObservaer()方法添加一个LifecycleObserver对象时,实际是将该LifecycleObserver对象封装程了一个ObserverWithState对象,看一下这个类的构造函数:
static class ObserverWithState {
State mState;
LifecycleEventObserver mLifecycleObserver;
ObserverWithState(LifecycleObserver observer, State initialState) {
mLifecycleObserver = Lifecycling.lifecycleEventObserver(observer);
mState = initialState;
}
}
将该LifecycleObserver通过Lifecycling的lifecycleEventObserver()方法解析成一个LifecycleEventObserver对象(对应上述三个实现类):
static LifecycleEventObserver lifecycleEventObserver(Object object) {
boolean isLifecycleEventObserver = object instanceof LifecycleEventObserver;
boolean isFullLifecycleObserver = object instanceof FullLifecycleObserver;
//1.将LifecycleObserver对象封装成FullLifecycleObserverAdapter对象
if (isLifecycleEventObserver && isFullLifecycleObserver) {
return new FullLifecycleObserverAdapter((FullLifecycleObserver) object,
(LifecycleEventObserver) object);
}
if (isFullLifecycleObserver) {
return new FullLifecycleObserverAdapter((FullLifecycleObserver) object, null);
}
if (isLifecycleEventObserver) {
return (LifecycleEventObserver) object;
}
final Class<?> klass = object.getClass();
int type = getObserverConstructorType(klass);
//2. 将LifecycleObserver对象封装成SingleGeneratedAdapterObserver对象
if (type == GENERATED_CALLBACK) {
List<Constructor<? extends GeneratedAdapter>> constructors =
sClassToAdapters.get(klass);
if (constructors.size() == 1) {
GeneratedAdapter generatedAdapter = createGeneratedAdapter(
constructors.get(0), object);
return new SingleGeneratedAdapterObserver(generatedAdapter);
}
GeneratedAdapter[] adapters = new GeneratedAdapter[constructors.size()];
for (int i = 0; i < constructors.size(); i++) {
adapters[i] = createGeneratedAdapter(constructors.get(i), object);
}
return new CompositeGeneratedAdaptersObserver(adapters);
}
//3. 将LifecycleObserver对象封装成ReflectiveGenericLifecycleObserver对象
return new ReflectiveGenericLifecycleObserver(object);
}
2.1. FullLifecycleObserverAdapter实现方式
FullLifecycleObserverAdapter类重写了onStateChanged()方法,根具不同的生命周期事件调用FullLifecycleObserver的不同方法:
@Override
public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Lifecycle.Event event) {
switch (event) {
case ON_CREATE:
mFullLifecycleObserver.onCreate(source);
break;
case ON_START:
...
}
if (mLifecycleEventObserver != null) {
mLifecycleEventObserver.onStateChanged(source, event);
}
}
可知这里适配两种观察者:FullLifecycleObserver和LifecycleEventObserver,FullLifecycleObserver定义了不同生命周期方法,LifecycleEventObserver只有onStateChanged()方法。我们知道onStateChanged()方法是实际接收生命周期事件并适配处理的地方,那生命周期的触发到传递到FullLifecycleObserverAdapter的onStateChanged()方法的过程是怎样的呢?可以看一下时序图:
2.2. SingleGeneratedAdapterObserver和CompositeGeneratedAdaptersObserver实现方式
方法getObserverConstructorType()返回的type若等于GENERATED_CALLBACK则会采用SingleGeneratedAdapterObserver或者CompositeGeneratedAdaptersObserver来实现观察者,这个方法有是通过resolveObserverCallbackType()来解析type的:
private static int resolveObserverCallbackType(Class<?> klass) {
// 1.根据本类klass对象来判断是否有APT生成相应的GeneratedAdapter对象
if (klass.getCanonicalName() == null) {
return REFLECTIVE_CALLBACK;
}
Constructor<? extends GeneratedAdapter> constructor = generatedConstructor(klass);
if (constructor != null) {
sClassToAdapters.put(klass, Collections
.<Constructor<? extends GeneratedAdapter>>singletonList(constructor));
return GENERATED_CALLBACK;
}
boolean hasLifecycleMethods = ClassesInfoCache.sInstance.hasLifecycleMethods(klass);
if (hasLifecycleMethods) {
return REFLECTIVE_CALLBACK;
}
// 2.根据父类superclass对象来判断是否有APT生成相应的GeneratedAdapter对象
Class<?> superclass = klass.getSuperclass();
List<Constructor<? extends GeneratedAdapter>> adapterConstructors = null;
if (isLifecycleParent(superclass)) {
if (getObserverConstructorType(superclass) == REFLECTIVE_CALLBACK) {
return REFLECTIVE_CALLBACK;
}
adapterConstructors = new ArrayList<>(sClassToAdapters.get(superclass));
}
//3.根据其实现接口来判断是否有APT生成相应的GeneratedAdapter对象
for (Class<?> intrface : klass.getInterfaces()) {
if (!isLifecycleParent(intrface)) {
continue;
}
if (getObserverConstructorType(intrface) == REFLECTIVE_CALLBACK) {
return REFLECTIVE_CALLBACK;
}
if (adapterConstructors == null) {
adapterConstructors = new ArrayList<>();
}
adapterConstructors.addAll(sClassToAdapters.get(intrface));
}
if (adapterConstructors != null) {
sClassToAdapters.put(klass, adapterConstructors);
return GENERATED_CALLBACK;
}
return REFLECTIVE_CALLBACK;
}
上面函数主要是在判断该观察者对象是否有相应的GeneratedAdapter类生成,是通过generatedConstructor方法实现的,若有相应的GeneratedAdapter类生成,则通过反射生成相应的构造器:
private static Constructor<? extends GeneratedAdapter> generatedConstructor(Class<?> klass) {
try {
Package aPackage = klass.getPackage();
String name = klass.getCanonicalName();
final String fullPackage = aPackage != null ? aPackage.getName() : "";
final String adapterName = getAdapterName(fullPackage.isEmpty() ? name :
name.substring(fullPackage.length() + 1));
@SuppressWarnings("unchecked") final Class<? extends GeneratedAdapter> aClass =
(Class<? extends GeneratedAdapter>) Class.forName(
fullPackage.isEmpty() ? adapterName : fullPackage + "." + adapterName);
Constructor<? extends GeneratedAdapter> constructor =
aClass.getDeclaredConstructor(klass);
if (!constructor.isAccessible()) {
constructor.setAccessible(true);
}
return constructor;
} catch (ClassNotFoundException e) {
return null;
} catch (NoSuchMethodException e) {
// this should not happen
throw new RuntimeException(e);
}
}
从addObserver()函数开始,到构建一个ObserverWithState对象,再到调用resolveObserverCallbackType()方法,该过程中已经生成了相应GeneratedAdapter的构造器,并返回一个SingleGeneratedAdapterObserver对象或CompositeGeneratedAdaptersObserver对象,在SingleGeneratedAdapterObserver中onStateChanged()方法中调用相应GeneratedAdapter对象的callMethods()来分发生命周期事件:
class SingleGeneratedAdapterObserver implements LifecycleEventObserver {
private final GeneratedAdapter mGeneratedAdapter;
SingleGeneratedAdapterObserver(GeneratedAdapter generatedAdapter) {
mGeneratedAdapter = generatedAdapter;
}
@Override
public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Lifecycle.Event event) {
mGeneratedAdapter.callMethods(source, event, false, null);
mGeneratedAdapter.callMethods(source, event, true, null);
}
}
下面看一下APT生成的相应的GeneratedAdapter类的callMethods()方法:
//BoundLocationManager_BoundLocationListener_LifecycleAdapter.java
final BoundLocationManager.BoundLocationListener mReceiver;
public void callMethods(LifecycleOwner owner, Lifecycle.Event event, boolean onAny,
MethodCallsLogger logger) {
boolean hasLogger = logger != null;
if (onAny) {
return;
}
if (event == Lifecycle.Event.ON_RESUME) {
if (!hasLogger || logger.approveCall("addLocationListener", 1)) {
mReceiver.addLocationListener();
}
return;
}
if (event == Lifecycle.Event.ON_PAUSE) {
if (!hasLogger || logger.approveCall("removeLocationListener", 1)) {
mReceiver.removeLocationListener();
}
return;
}
}
}
通过上面代码可知在BoundLocationListener类中添加两处注解@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)和@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE),注解相对应的方法分别为BoundLocationListener类的addLocationListener()方法和removeLocationListener()方法。
2.3 ReflectiveGenericLifecycleObserver实现方式
在上一节中,generatedConstructor()方法反射GeneratedAdapter对应的构造器,若成功则用来处理生命周期变化的回调类型就是GENERATED_CALLBACK,如果失败则用来处理生命周期变化的回调类型就是REFLECTIVE_CALLBACK,其对应生成的生命周期回调为ReflectiveGenericLifecycleObserver。根据resolveObserverCallbackType()函数的处理流程,若生成GeneratedAdapter对应的构造器失败,则就通过反射来解析具有OnLifecycleEvent注解的方法,因为反射是十分耗费性能的,因此ClassesInfoCache类会缓存解析好的具有OnLifecycleEvent注解的方法,解析过程为:
//class ClassesInfoCache.java
private CallbackInfo createInfo(Class<?> klass, @Nullable Method[] declaredMethods) {
//1.递归解析父类
Class<?> superclass = klass.getSuperclass();
Map<MethodReference, Lifecycle.Event> handlerToEvent = new HashMap<>();
if (superclass != null) {
//因为会有多重继承,因此会递归解析父类,getInfo()方法还会调用createInfo()方法
CallbackInfo superInfo = getInfo(superclass);
if (superInfo != null) {
handlerToEvent.putAll(superInfo.mHandlerToEvent);
}
}
//2.递归解析接口。Java中接口也可以继承,这里getInterfaces()方法处理两种情况:a. klass对应一个类,b. kclass对应一个接口
Class<?>[] interfaces = klass.getInterfaces();
for (Class<?> intrfc : interfaces) {
for (Map.Entry<MethodReference, Lifecycle.Event> entry : getInfo(
intrfc).mHandlerToEvent.entrySet()) {
//接口中解析的方法可能与父类中解析的是重复定义的,会做去重后再添加到handlerToEvent中
verifyAndPutHandler(handlerToEvent, entry.getKey(), entry.getValue(), klass);
}
}
//3. 解析本类对象具有OnLifecycleEvent注解的方法
Method[] methods = declaredMethods != null ? declaredMethods : getDeclaredMethods(klass);
boolean hasLifecycleMethods = false;
for (Method method : methods) {
OnLifecycleEvent annotation = method.getAnnotation(OnLifecycleEvent.class);
if (annotation == null) {
continue;
}
hasLifecycleMethods = true;
Class<?>[] params = method.getParameterTypes();
//OnLifecycleEvent注解的方法最多允许两个Event参数,定义参数超过两个会抛出异常
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;
//第二个参数类型期望为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);
//去重添加到handlerToEvent中
verifyAndPutHandler(handlerToEvent, methodReference, event, klass);
}
CallbackInfo info = new CallbackInfo(handlerToEvent);
mCallbackMap.put(klass, info);
mHasLifecycleMethods.put(klass, hasLifecycleMethods);
return info;
}
通过createInfo()方法会将传入的Method[]解析成CallbackInfo对象,该对象有两个成员变量:mEventToHandlers和mHandlerToEvent。mHandlerToEvent是MethodReference和Event的键值对,是一对一关系,并且mHandlerToEvent是从构造函数传入并保存在成员变量中的;在构造函数中会将mHandlerToEvent解析成mEventToHandlers,mEventToHandlers是Event和MethodReference链表的键值对,是一对多关系。
static class CallbackInfo {
final Map<Lifecycle.Event, List<MethodReference>> mEventToHandlers;
final Map<MethodReference, Lifecycle.Event> mHandlerToEvent;
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);
}
}
当有生命周期变化事件发生时,ReflectiveGenericLifecycleObserver的onStateChanged()方法即会被调用(参上一节的时序图),进而调用CallbackInfo的invokeCallbacks()方法将事件分发给所有method。