從本篇博客開始,慢慢的開始在項目中學習使用Jetpack,這東西出來時間挺長了,但是一直種種原因,沒學習(說白了就是:懶)。 由於項目中使用的是MVVM,前段時間想重新學習下MVVM,然後就搜到了這個Jetpack,從JetPack的LiveData ——> Lifecycle,這個學習過程,漸漸的發現,Google推出這套開發組件是有道理的。 本篇博客寫一下學習到的Lifecycle知識點。
Lifecycle使用
創建一個類實現LifecycleObserver接口
public class BaseLifeCycleObserver implements LifecycleObserver {
private final String TAG = BaseLifeCycleObserver.class.getName();
@OnLifecycleEvent(Lifecycle.Event.ON_CREATE)
public void onCreate(LifecycleOwner owner) {
LogUtil.e(TAG, "onCreate");
}
@OnLifecycleEvent(Lifecycle.Event.ON_START)
public void onStart(LifecycleOwner owner) {
LogUtil.e(TAG, "start");
}
@OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
public void onResume(LifecycleOwner owner) {
LogUtil.e(TAG, "onResume");
}
@OnLifecycleEvent(Lifecycle.Event.ON_ANY)
public void onAny(LifecycleOwner owner, Lifecycle.Event event) {
LogUtil.e(TAG, "AnY: " + event.name());
}
@OnLifecycleEvent(Lifecycle.Event.ON_PAUSE)
public void onPause(LifecycleOwner owner) {
LogUtil.e(TAG, "onPause");
}
@OnLifecycleEvent(Lifecycle.Event.ON_STOP)
public void onStop(LifecycleOwner owner) {
LogUtil.e(TAG, "onStop");
}
@OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
public void onDestroy(LifecycleOwner owner) {
LogUtil.e(TAG, "onDestroy");
}
}
代碼中有7中枚舉類型的註解, 分別對應被觀察者的生命週期,LifecycleObserver的實現類相當於觀察者,現在我們看下被觀察者。
被觀察者需要實現LifecycleOwner接口,而我們的Activity和Fragment都實現了該接口,所以可以直接在Activity或者Fragment中添加觀察者。
以Activity爲例, 在onCreate方法中添加下面代碼:
getLifecycle().addObserver(new BaseLifeCycleObserver());
可看到控制檯打印相應日誌。
Lifecycle的用途
其實說到用途,官網說的那個例子就很好,屏幕顯示位置信息爲例,在onStart和onStop方法中,分別需要開啓和停止定位,此時定位的位置代碼就和Activity的生命週期關聯了起來,爲了結偶,並且減少Activity 的工作量,引入Lifecycle就很有必要了。
總結起來,當我們需要處理一個業務,該業務的子業務需要根據Activity或者Fragment 的生命週期不同變化時,就引入Lifecycle。例如:自定義埋點需求。
當然了,脫離UI層, 自定義LifecycleOwner,根據自己需求發送相應事件。這個具體自定義,看完源碼應該有進一步的瞭解。
Lifecycle源碼分析
根據Lifecycle的使用,我們從getLifecycle().addObserver(觀察者)說起,開發者創建的Activity繼承自:ComponentActivity,該類實現了LifecycleOwner接口, 而LifecycleOwner接口就一個方法:
public interface LifecycleOwner {
/**
* Returns the Lifecycle of the provider.
*
* @return The lifecycle of the provider.
*/
@NonNull
Lifecycle getLifecycle();
}
因此ComponentActivity實現了接口,必然實現了該方法:
public Lifecycle getLifecycle() {
return mLifecycleRegistry;
}
private final LifecycleRegistry mLifecycleRegistry = new LifecycleRegistry(this);
getLifecycle方法返回的就是這個LifecycleRegistry對象。而getLifecycle().addObserver(觀察者)也就是調用的就是LifecycleRegistry的addObserver方法:
@Override
public void addObserver(@NonNull LifecycleObserver observer) {
//初始化Observer的狀態標記:INITIALIZED;
State initialState = mState == DESTROYED ? DESTROYED : INITIALIZED;
// 將Observer和標記封裝成一個對象:ObserverWithState
ObserverWithState statefulObserver = new ObserverWithState(observer, initialState);
//將該對象放入Map集合中
ObserverWithState previous = mObserverMap.putIfAbsent(observer, statefulObserver);
// 如果該Observer之前已經在Map中了,那麼就直接返回
if (previous != null) {
return;
}
LifecycleOwner lifecycleOwner = mLifecycleOwner.get();
if (lifecycleOwner == null) {
// it is null we should be destroyed. Fallback quickly
return;
}
//如果沒放入過,也就是初次放入,那麼就需要“倒灌”:給該Observer 發送之前沒接收到的事件,
//比如:在onResume的時候添加了Observer,那麼之前丟失的事件onCreate,onStart,事件都會依此分發,
//也可以理解爲:EventBus的粘性事件。
boolean isReentrance = mAddingObserverCounter != 0 || mHandlingEvent;
State targetState = calculateTargetState(observer);
mAddingObserverCounter++;
while ((statefulObserver.mState.compareTo(targetState) < 0
&& mObserverMap.contains(observer))) {
pushParentState(statefulObserver.mState);
statefulObserver.dispatchEvent(lifecycleOwner, upEvent(statefulObserver.mState));
popParentState();
// mState / subling may have been changed recalculate
targetState = calculateTargetState(observer);
}
if (!isReentrance) {
// we do sync only on the top level.
sync();
}
mAddingObserverCounter--;
}
這時候我們可以得到的信息是:實現LifecycleOwner的被觀察者和觀察者Observer關聯了起來。並且將Observer和狀態一起保存在了Map中。
現在我們需要看下這裏的“狀態”是什麼東西?
Lifecycle源碼裏面有兩個枚舉Event和State:
Event:
public enum Event {
ON_CREATE, //對應onCreate方法
ON_START, // 對應onStart方法
ON_RESUME, // 對應onResume方法
ON_PAUSE, //對應onPause方法
ON_STOP, //對應onStop方法
ON_DESTROY, //對應onDestory方法
ON_ANY //
}
這個枚舉是定義在Observer實現類的相應接收方法上的註解。 舉例:當被觀察者(Activity)調用onStart方法是,Observer實現類標有註解ON_START的方法就會執行。
這個枚舉相當於是一個暴露給開發者自定義Observer接收被觀察者事件的註解標記。
State:
public enum State {
DESTROYED,
INITIALIZED,
CREATED,
STARTED,
RESUMED;
public boolean isAtLeast(@NonNull State state) {
return compareTo(state) >= 0;
}
}
這個枚舉用於表示生命週期狀態。這個枚舉比較難理解,因爲這個枚舉是上一個枚舉是有對應關係的, 下文解讀。
PS:枚舉定義的先後順序,大小值,是一次增大的:DESTROYED < INITIALIZED < CREATED < STARTED < RESUMED。
分發事件
註冊完畢了,那麼Activity怎樣根據不同的生命週期發送不同的事件呢?
答案還是在:ComponentActivity的onCreate方法中。
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mSavedStateRegistryController.performRestore(savedInstanceState);
// 重點
ReportFragment.injectIfNeededIn(this);
if (mContentLayoutId != 0) {
setContentView(mContentLayoutId);
}
}
調用了ReportFragment的injectIfNeededIn方法,參數是:Activity本身。
ReportFragment是什麼呢?
public static void injectIfNeededIn(Activity activity) {
android.app.FragmentManager manager = activity.getFragmentManager();
if (manager.findFragmentByTag(REPORT_FRAGMENT_TAG) == null) {
// 創建了一個空的ReportFragment,並且添加到了Activity中
manager.beginTransaction().add(new ReportFragment(), REPORT_FRAGMENT_TAG).commit();
// Hopefully, we are the first to make a transaction.
manager.executePendingTransactions();
}
}
看方法名:注入如果需要的話。 在該方法中創建了空的ReportFragment ,該Fragment是沒有界面的,並添加到Activity中,依此感知Activity的生命週期,這種做法熟悉麼?提示:Glide感知Ui層的生命週期。
那麼自然而然的就要看ReportFragment的相應生命週期方法了。
@Override
public void onActivityCreated(Bundle savedInstanceState) {
....
//分發ON_CREATE事件
dispatch(Lifecycle.Event.ON_CREATE);
}
@Override
public void onStart() {
...
// 分發ON_START事件
dispatch(Lifecycle.Event.ON_START);
}
......
private void dispatch(Lifecycle.Event event) {
Activity activity = getActivity();
if (activity instanceof LifecycleRegistryOwner) {
((LifecycleRegistryOwner) activity).getLifecycle().handleLifecycleEvent(event);
return;
}
// ComponentActivity實現的接口是:LifecycleOwner
if (activity instanceof LifecycleOwner) {
Lifecycle lifecycle = ((LifecycleOwner) activity).getLifecycle();
if (lifecycle instanceof LifecycleRegistry) {
// 調用的還是LifecycleReegister的handleLifecycleEvent方法
((LifecycleRegistry) lifecycle).handleLifecycleEvent(event);
}
}
}
1: 將Activity的業務邏輯轉移到了Fragment 中
2:在Fragment的不同的生命週期方法中,分發不同的事件
3:將事件交還給:LifecycleRegister的handleLifecycleEvent方法處理
public void handleLifecycleEvent(@NonNull Lifecycle.Event event) {
//獲取Event對應的下一個狀態,也就是即將進入到的狀態
//將Event -> State
State next = getStateAfter(event);
//移動到該狀態
moveToState(next);
}
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;
}
首先將Event枚舉轉爲了State枚舉,然後跟巨State枚舉的不同,對應的同步到相應位置。
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);
}
可以看到發送的Event枚舉事件和枚舉的對應轉換關係。看下官網的一張圖:
當處於不同的狀態時,都會調用相應的方法:例如start resume方法以同步一致。 這裏我們以發送的Event事件是onStart方法到onResume方法,也就是說發送的時間是:ON_RESUME。 從上述代碼可以看出對應的State是:RESUMED。
此時我們的觀察者是:STARTED狀態, 而被觀察者是:RESUMED狀態,因此需要移動被觀察者的標記。
通過上圖可以知道,觀察者需要發送ON_REESUME事件,移動到RESUME狀態。
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.
/**
* 計算是往前推還是往後退
*/
//比較轉到的狀態和Observer的狀態做比較。(PS:枚舉可以比較大小)
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;
}
觀察者的對象做處於的狀態是:START,而被觀察者處於RESUME,根據枚舉比較的大小,RESUME大於START因此是:往前推,調用forwardPass方法。
往前推:比如:create -> start -> resume -> pause -> …
往後退:比如:pause -> resume -> start -> create
private void forwardPass(LifecycleOwner lifecycleOwner) {
Iterator<Entry<LifecycleObserver, ObserverWithState>> ascendingIterator =
mObserverMap.iteratorWithAdditions();
// 循環Map集合的每一個觀察者
while (ascendingIterator.hasNext() && !mNewEventOccurred) {
Entry<LifecycleObserver, ObserverWithState> entry = ascendingIterator.next();
ObserverWithState observer = entry.getValue();
// 對比每一個觀察者的狀態和被觀察者的狀態,循環到同步爲止
while ((observer.mState.compareTo(mState) < 0 && !mNewEventOccurred
&& mObserverMap.contains(entry.getKey()))) {
pushParentState(observer.mState);
// 調用觀察者的dispatchEven方法。
observer.dispatchEvent(lifecycleOwner, upEvent(observer.mState));
popParentState();
}
}
}
上面的代碼很簡單,也就是同步Map集合中的每一個觀察者,把觀察者的狀態和被觀察者的狀態同步一致。
爲什麼是while循環呢? 例子:被觀察者在:CREATED狀態,觀察者在:RESUMED狀態,是不是中間隔了一個STARTED狀態,所以需要循環到一致狀態。
然後真正的分發事件:
static class ObserverWithState {
State mState;
LifecycleEventObserver mLifecycleObserver;
ObserverWithState(LifecycleObserver observer, State initialState) {
//創建LifecycleEventObserver對象
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;
}
}
}
這裏創建的LifecycleEventObserver過程:
@NonNull
static LifecycleEventObserver lifecycleEventObserver(Object object) {
// 觀察者是否是繼承自:LifecycleEventObserver 或者 FullLifecycleObserver
boolean isLifecycleEventObserver = object instanceof LifecycleEventObserver;
boolean isFullLifecycleObserver = object instanceof FullLifecycleObserver;
if (isLifecycleEventObserver && isFullLifecycleObserver) {
return new FullLifecycleObserverAdapter((FullLifecycleObserver) object,
(LifecycleEventObserver) object);
}
// 如果是繼承自FullLifecycleObserver 直接返回FullLifecycleObserverAdapter
if (isFullLifecycleObserver) {
return new FullLifecycleObserverAdapter((FullLifecycleObserver) object, null);
}
//如果是繼承LifecycleEventObserver,直接返回LifecycleEventObserver
if (isLifecycleEventObserver) {
return (LifecycleEventObserver) object;
}
//如果都不是
final Class<?> klass = object.getClass();
//那麼就調用getObserverConstructorType根據返回的Type確定是返回CompositeGeneratedAdaptersObserver還是ReflectiveGenericLifecycleObserver
int type = getObserverConstructorType(klass);
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);
}
return new ReflectiveGenericLifecycleObserver(object);
}
由於我們的觀察者是繼承自:LifecycleObserver, 所以就需要通過Type來確定是返回CompositeGeneratedAdaptersObserver還是ReflectiveGenericLifecycleObserver。
GENERATED_CALLBACK: 通過註解處理
REFLECTIVE_CALLBACK:通過反射處理
private static int getObserverConstructorType(Class<?> klass) {
.....
int type = resolveObserverCallbackType(klass);
.....
}
private static int resolveObserverCallbackType(Class<?> klass) {
// anonymous class bug:35073837
//如果是匿名內部類直接只用反射
if (klass.getCanonicalName() == null) {
return REFLECTIVE_CALLBACK;
}
//尋找通過註解生成的GeneratedAdapter, 如果能找到,那麼使用GENERATED_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;
}
//如果都沒找到,那麼就是往父類找。
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));
}
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,如果找到,就是返回GENERATED_CALLBACK,如果沒找到,就尋找註解的方法,如果找到就返回REFLECTIVE_CALLBACK; 如果既沒有用找到GeneratedAdapter,也沒有找到註解的方法,那麼就往父類找。
關於GeneratedAdapter, 也就是通過APT技術在編譯期生成代碼,然後在運行期間直接運行,這裏可以參考之前的博客:Android進階9:手寫Bufferknife(編譯時註解)。
很顯然,這裏沒有使用APT,而是直接通過註解方法反射接收事件的,:
boolean hasLifecycleMethods(Class klass) {
......
Method[] methods = getDeclaredMethods(klass);
for (Method method : methods) {
//過濾收集到方法註解有OnLifecycleEvent.class的OnLifecycleEvent
OnLifecycleEvent annotation = method.getAnnotation(OnLifecycleEvent.class);
if (annotation != null) {
//在該類中,獲取到所有標有OnLifecycleEvent註解的方法信息
createInfo(klass, methods);
return true;
}
}
mHasLifecycleMethods.put(klass, false);
return false;
}
現在知道返回的是REFLECTIVE_CALLBACK,那麼也就是說返回的是:ReflectiveGenericLifecycleObserver對象,那麼進入到onStateChanged方法:
@Override
public void onStateChanged(LifecycleOwner source, Event event) {
mInfo.invokeCallbacks(source, event, mWrapped);
}
@SuppressWarnings("ConstantConditions")
void invokeCallbacks(LifecycleOwner source, Lifecycle.Event event, Object target) {
//通過反射調用相應事件的方法。
invokeMethodsForEvent(mEventToHandlers.get(event), source, event, target);
//每次發送事件,都會發送ON_ANY事件。
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);
}
}
}
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);
}
}
到這裏整個流程就完畢了 ,其實Lifecycle使用的設計模式就是:觀察者模式,具體的技術:註解 + 反射。
這裏可以有一個優化點:我們可以在編譯器生成代碼,然後通過編譯期間時,可以提高性能。
androidx.lifecycle:lifecycle-compiler:$lifecycle_version