jetpack系列笔记
一、jetpack系列之lifecycle
二、jetpack系列之LiveData
jetpack系列之lifecycle
前言
jetpack是什么？
按照官方解释如下：
Jetpack 是一个由多个库组成的套件，可帮助开发者遵循最佳做法、减少样板代码并编写可在各种 Android 版本和设备中一致运行的代码，让开发者可将精力集中于真正重要的编码工作。
jetackt为开发者提供了很多库，方便开发者开发。它拥有生命周期感知能力，可以减少崩溃，ANR，内存泄露等常见问题。提高开发者的开发效率。本系列文章介绍了几个热门库的使用方式和原理。
一、lifecycle是什么
lifecycle是生命周期感知型组件，可执行操作来响应另一个组件（如 activity 和 fragment）的生命周期状态的变化。这些组件有助于写出更有条理且往往更精简的代码，这样的代码更易于维护。
二、使用方式
- 实现LifecycleObserver接口;
- 创建方法，添加注解@OnLifecycleEvent，注解的参数为Lifecycle.Event，对应不同的生命周期，如Lifecycle.Event.ON_CREATE对应activity的OnCreate();
class MyLifecycleObserver : LifecycleObserver {
private val TAG = MyLifecycleObserver::class.java.simpleName
@OnLifecycleEvent(Lifecycle.Event.ON_CREATE)
fun createX() {
Log.d(TAG, "createX")
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
fun resumeX(owner: LifecycleOwner) {
Log.d(TAG, "resumeX -- $owner")
}
}
- activity继承AppCompatActivity，lifecycle添加观察者
class LifecycleActivity : AppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
lifecycle.addObserver(MyLifecycleObserver())
}
}
三、lifecycle实现原理
（1）LifecycleObserver的注册过程
- 开始注册LifecycleObserver
lifecycle.addObserver(MyLifecycleObserver())
- 看一下lifecycle添加Observer时候都做了什么：
//LifecycleRegistry.kt
override fun addObserver(observer: LifecycleObserver) {
enforceMainThreadIfNeeded("addObserver")
//1.初始化状态
val initialState = if (state == State.DESTROYED) State.DESTROYED else State.INITIALIZED
//2.将observer和状态包装成ObserverWithState
val statefulObserver = ObserverWithState(observer, initialState)
//3.使用observer本身作为key，将包装成的ObserverWithState 放到一个Map中，observerMap存放了所有的观察者
val previous = observerMap.putIfAbsent(observer, statefulObserver)
if (previous != null) {
return
}
val lifecycleOwner = lifecycleOwner.get()
?: // it is null we should be destroyed. Fallback quickly
return
val isReentrance = addingObserverCounter != 0 || handlingEvent
var targetState = calculateTargetState(observer)
addingObserverCounter++
while (statefulObserver.state < targetState && observerMap.contains(observer)
) {
pushParentState(statefulObserver.state)
val event = Event.upFrom(statefulObserver.state)
?: throw IllegalStateException("no event up from ${statefulObserver.state}")
statefulObserver.dispatchEvent(lifecycleOwner, event)
popParentState()
// mState / subling may have been changed recalculate
targetState = calculateTargetState(observer)
}
if (!isReentrance) {
// we do sync only on the top level.
sync()
}
addingObserverCounter--
}
- 看一下ObserverWithState的实现：
internal class ObserverWithState(observer: LifecycleObserver?, initialState: State) {
var state: State
var lifecycleObserver: LifecycleEventObserver
init {
lifecycleObserver = Lifecycling.lifecycleEventObserver(observer!!)
state = initialState
}
fun dispatchEvent(owner: LifecycleOwner?, event: Event) {
val newState = event.targetState
state = min(state, newState)
lifecycleObserver.onStateChanged(owner!!, event)
state = newState
}
}
ObserverWithStates封装了LifecycleEventObserver。LifecycleEventObserver是一个LifecycleObserver接口实现，实现了fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) 方法。看一下LifecycleEventObserver的生成过程：
@JvmStatic
@Suppress("DEPRECATION")
public fun lifecycleEventObserver(`object`: Any): LifecycleEventObserver {
...
return ReflectiveGenericLifecycleObserver(`object`)
}
这里返回的是ReflectiveGenericLifecycleObserver类。由名字可以得出，它是一个依赖反射的LifecycleObserver。看一下它的实现：
class ReflectiveGenericLifecycleObserver implements LifecycleEventObserver {
private final Object mWrapped;
private final androidx.lifecycle.ClassesInfoCache.CallbackInfo mInfo;
@SuppressWarnings("deprecation")
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);
}
}
它实现了LifecycleEventObserver，封装了一个mWrapped，即我们最开始的时候传入的LifecycleObserver。还有一个mInfo，它通过反射记录了我们自己的LifecycleObserver有关生命周期的方法：
CallbackInfo getInfo(Class<?> klass) {
CallbackInfo existing = mCallbackMap.get(klass);
if (existing != null) {
return existing;
}
existing = createInfo(klass, null);
return existing;
}
private CallbackInfo createInfo(Class<?> klass, @Nullable Method[] declaredMethods) {
Class<?> superclass = klass.getSuperclass();
Map<MethodReference, Lifecycle.Event> handlerToEvent = new HashMap<>();
//1.如果父类不为空，则获取父类的所有信息，并保存到handlerToEvent中
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);
}
}
//2.获取该类中所有的方法，进行遍历
Method[] methods = declaredMethods != null ? declaredMethods : getDeclaredMethods(klass);
boolean hasLifecycleMethods = false;
for (Method method : methods) {
//3.检查每个方法是否有OnLifecycleEvent注解，没有则跳过
OnLifecycleEvent annotation = method.getAnnotation(OnLifecycleEvent.class);
if (annotation == null) {
continue;
}
hasLifecycleMethods = true;
//4.获取该方法的所有参数类型，检查有几个参数，如果没有参数，callType 标记成CALL_TYPE_NO_ARG；一个参数，标记成CALL_TYPE_PROVIDER，如果有两个参数标记成CALL_TYPE_PROVIDER_WITH_EVENT，不能多于两个参数。
Class<?>[] params = method.getParameterTypes();
int callType = CALL_TYPE_NO_ARG;
if (params.length > 0) {
callType = CALL_TYPE_PROVIDER;
if (!LifecycleOwner.class.isAssignableFrom(params[0])) {
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;
if (!Lifecycle.Event.class.isAssignableFrom(params[1])) {
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");
}
//5.将参数封装成MethodReference，并放进handlerToEvent 中
MethodReference methodReference = new MethodReference(callType, method);
verifyAndPutHandler(handlerToEvent, methodReference, event, klass);
}
//6.将handlerToEvent包装成CallbackInfo，并进行返回。
CallbackInfo info = new CallbackInfo(handlerToEvent);
mCallbackMap.put(klass, info);
mHasLifecycleMethods.put(klass, hasLifecycleMethods);
return info;
}
其中，MethodReference保存了改方法和方法的参数，以及根据方法参数个数的不同，通过反射的方式调用该方法。CallbackInfo缓存了回调信息，使用了两个map, mHandlerToEvent就是保存了上文的handlerToEvent，还有一个mEventToHandlers，它将mHandlerToEvent中的事件做为key，List缓存下来，便于后续调用。
（2）LifecycleOwner的注册过程
- 监听一个Activity的生命周期，需要继承LifecycleOwner。Activity的继承关系如下：
Activity -> AppCompatActivity -> FragmentActivity -> ComponentActivity -> LifecycleOwner
- ComponentActivity 的onCreate方法中调用了 ReportFragment.injectIfNeededIn(this)；
- ReportFragment 的 injectIfNeededIn(activity: Activity) 方法，区分了SDK版本29之后和29之前是不一样的。29版本之前，是绑定了一个Fragment，事件跟随Fragment的生命周期进行分发。我们现在看SDK大于等于29的情况。此时调用关系如下：
//ReportFragment.kt
@JvmStatic
fun injectIfNeededIn(activity: Activity) {
if (Build.VERSION.SDK_INT >= 29) {
// On API 29+, we can register for the correct Lifecycle callbacks directly
LifecycleCallbacks.registerIn(activity)
}
// Prior to API 29 and to maintain compatibility with older versions of
// ProcessLifecycleOwner (which may not be updated when lifecycle-runtime is updated and
// need to support activities that don't extend from FragmentActivity from support lib),
// use a framework fragment to get the correct timing of Lifecycle events
val manager = activity.fragmentManager
if (manager.findFragmentByTag(REPORT_FRAGMENT_TAG) == null) {
manager.beginTransaction().add(ReportFragment(), REPORT_FRAGMENT_TAG).commit()
// Hopefully, we are the first to make a transaction.
manager.executePendingTransactions()
}
}
//ReportFragment.kt
companion object {
@JvmStatic
fun registerIn(activity: Activity) {
activity.registerActivityLifecycleCallbacks(LifecycleCallbacks())
}
}
//Activity.java
public void registerActivityLifecycleCallbacks(
@NonNull Application.ActivityLifecycleCallbacks callback) {
synchronized (mActivityLifecycleCallbacks) {
mActivityLifecycleCallbacks.add(callback);
}
}
LifecycleCallbacks 继承了Application.ActivityLifecycleCallbacks，是ReportFragment的内部类，实现了不同生命周期事件的分发。
mActivityLifecycleCallbacks是一个ArrayList, 当Activity有生命周期改变时，会从这个ArrayList中寻找是否有观察者需要通知。
（3）事件分发的过程
- 当Activity有生命周期变化时，以onCteate生命周期为例，调用过程如下：
//Activity.java
@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
final void performCreate(Bundle icicle, PersistableBundle persistentState) {
...
dispatchActivityPostCreated(icicle);
Trace.traceEnd(Trace.TRACE_TAG_WINDOW_MANAGER);
}
//Activity.java 找到所有的callbacks进行分发
private void dispatchActivityPostCreated(@Nullable Bundle savedInstanceState) {
Object[] callbacks = collectActivityLifecycleCallbacks();
if (callbacks != null) {
for (int i = 0; i < callbacks.length; i++) {
((Application.ActivityLifecycleCallbacks) callbacks[i]).onActivityPostCreated(this,
savedInstanceState);
}
}
getApplication().dispatchActivityPostCreated(this, savedInstanceState);
}
//ReportFragment.kt LifecycleCallbacks类
override fun onActivityPostCreated(
activity: Activity,
savedInstanceState: Bundle?
) {
dispatch(activity, Lifecycle.Event.ON_CREATE)
}
@JvmStatic
internal fun dispatch(activity: Activity, event: Lifecycle.Event) {
if (activity is LifecycleRegistryOwner) {
activity.lifecycle.handleLifecycleEvent(event)
return
}
if (activity is LifecycleOwner) {
val lifecycle = (activity as LifecycleOwner).lifecycle
if (lifecycle is LifecycleRegistry) {
lifecycle.handleLifecycleEvent(event)
}
}
}
open fun handleLifecycleEvent(event: Event) {
//检查是否是主线程
enforceMainThreadIfNeeded("handleLifecycleEvent")
//走这里分发状态
moveToState(event.targetState)
}
private fun moveToState(next: State) {
if (state == next) {
return
}
check(!(state == State.INITIALIZED && next == State.DESTROYED)) {
"no event down from $state in component ${lifecycleOwner.get()}"
}
state = next
if (handlingEvent || addingObserverCounter != 0) {
newEventOccurred = true
// we will figure out what to do on upper level.
return
}
handlingEvent = true
//开始同步
sync()
handlingEvent = false
if (state == State.DESTROYED) {
observerMap = FastSafeIterableMap()
}
}
// happens only on the top of stack (never in reentrance),
// so it doesn't have to take in account parents
private fun sync() {
val lifecycleOwner = lifecycleOwner.get()
?: throw IllegalStateException(
"LifecycleOwner of this LifecycleRegistry is already " +
"garbage collected. It is too late to change lifecycle state."
)
while (!isSynced) {
newEventOccurred = false
if (state < observerMap.eldest()!!.value.state) {
backwardPass(lifecycleOwner)
}
val newest = observerMap.newest()
if (!newEventOccurred && newest != null && state > newest.value.state) {
forwardPass(lifecycleOwner)
}
}
newEventOccurred = false
}
走到这里，会根据state这个状态，判断需要走当前生命周期的前一个生命周期还是后边一个生命周期从而走backwardPass 或 forwardPass。两个方法实现差不多，我们看一下backwardPass：
private fun backwardPass(lifecycleOwner: LifecycleOwner) {
val descendingIterator = observerMap.descendingIterator()
while (descendingIterator.hasNext() && !newEventOccurred) {
val (key, observer) = descendingIterator.next()
while (observer.state > state && !newEventOccurred && observerMap.contains(key)
) {
val event = Event.downFrom(observer.state)
?: throw IllegalStateException("no event down from ${observer.state}")
pushParentState(event.targetState)
//给观察者分发事件。 observer是之前包装的ObserverWithState
observer.dispatchEvent(lifecycleOwner, event)
popParentState()
}
}
}
//ObserverWithState 的dispatchEvent方法
fun dispatchEvent(owner: LifecycleOwner?, event: Event) {
val newState = event.targetState
state = min(state, newState)
lifecycleObserver.onStateChanged(owner!!, event)
state = newState
}
这里通知LifecycleEventObserver 状态改变，并把LifecycleOwner 就是自己的Activity和当前的事件Event传递过去。lifecycleObserver是注册lifeCycleObserver创建的ReflectiveGenericLifecycleObserver。
//ReflectiveGenericLifecycleObserver.java mInfo
@Override
public void onStateChanged(@NonNull LifecycleOwner source, @NonNull Event event) {
mInfo.invokeCallbacks(source, event, mWrapped);
}
//ClassesInfoCache.java CallbackInfo类
@SuppressWarnings("ConstantConditions")
void invokeCallbacks(LifecycleOwner source, Lifecycle.Event event, Object target) {
//mEventToHandlers中找到当前Event的所有MethodReference进行处理
invokeMethodsForEvent(mEventToHandlers.get(event), source, event, target);
//mEventToHandlers中找到不限制生命周期的所有MethodReference进行处理
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);
}
}
}
//ClassesInfoCache.java MethodReference类 通过反射的方式去执行LifecycleObserver中的方法。
void invokeCallback(LifecycleOwner source, Lifecycle.Event event, Object target) {
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);
}
}
（4）状态改变
上文分析流程的时候，有一个Event事件，还有一个lifecycle状态State。Event对应Activity的生命周期，State是lifecycle维护了一套自己的状态机，跟Activity的生命周期对应如下：
可以看到，当知道了Activity的生命周期是什么，我们就获取到下一个状态。而我们知道了State状态，可以根据箭头的方向，也就是前后状态的不同， 获取到当前生命周期是什么，便于管理和记录。实现如下：
public enum class Event {
ON_CREATE,
ON_START,
ON_RESUME,
ON_PAUSE,
ON_STOP,
ON_DESTROY,
ON_ANY;
//通过Event获取State
public val targetState: State
get() {
when (this) {
ON_CREATE, ON_STOP -> return State.CREATED
ON_START, ON_PAUSE -> return State.STARTED
ON_RESUME -> return State.RESUMED
ON_DESTROY -> return State.DESTROYED
ON_ANY -> {}
}
throw IllegalArgumentException("$this has no target state")
}
//通过State以及箭头方向判断下一个Event
public companion object {
@JvmStatic
public fun downFrom(state: State): Event? {
return when (state) {
State.CREATED -> ON_DESTROY
State.STARTED -> ON_STOP
State.RESUMED -> ON_PAUSE
else -> null
}
}
@JvmStatic
public fun downTo(state: State): Event? {
return when (state) {
State.DESTROYED -> ON_DESTROY
State.CREATED -> ON_STOP
State.STARTED -> ON_PAUSE
else -> null
}
}
@JvmStatic
public fun upFrom(state: State): Event? {
return when (state) {
State.INITIALIZED -> ON_CREATE
State.CREATED -> ON_START
State.STARTED -> ON_RESUME
else -> null
}
}
@JvmStatic
public fun upTo(state: State): Event? {
return when (state) {
State.CREATED -> ON_CREATE
State.STARTED -> ON_START
State.RESUMED -> ON_RESUME
else -> null
}
}
}
}
总结
lifecycle是将LifecycleObserver通过反射，将所有的方法、对应的生命周期，和方法参数记录下来，放到缓存中。将LifecycleOwner也就是自己的Activity放到一个Map中缓存下来。生命周期改变时，找到缓存下来的LifecycleObserver通过反射的方式执行对应的方法。
扫一扫
380
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
