jetpack-Lifecycle

Lifecycle

作用

简单的说就是用来监听Activity与Fragment的生命周期变化。

当Activity或Fragment的生命周期发生变化时，就会将事件分发给注册到LifecycleRegistry的LifecycleEventObserver，并调用它们的onStateChanged方法进行通知。

一些基本的类

• Lifecycle：一个抽象类，表示具有Android生命周期的对象
• LifecycleRegistry：Lifecycle的实现类，它内部的FastSafeIterableMap存储了LifecycleOwner的所有观察者。LifecycleOwner的实现类也就是生命周期持有者会持有这样一个对象，需要感知它们生命周期的观察者
• LifecycleOwner：一个接口，表示拥有lifecycle的对象，其中的getLifecycle方法可以获取到相应的Lifecycle对象；ComponentActivity和androidX包下的Fragment等都实现了这个接口。
• LifecycleObserver：一个接口，表示实现它的类是生命周期的观察者，当被观察的Lifecycle对象生命周期改变时会收到通知。

Lifecycle感知Fragment和Activity生命周期的原理

• 感知Fragment生命周期的原理：

  在Fragment的构造方法中会创建一个LifecycleRegistry对象。在Fragment的生命周期变化时会通过这个LifecycleRegistry的handleLifecycleEvent方法向所有观察者分发它的生命周期变化事件。

• 感知Activity生命周期的原理：

  Activity的间接父类ComponentActivity的onCreate方法中，有这样一行代码：

  ReportFragment.injectIfNeededIn(this);
  

  在Android 29及以上ReportFragment是通过向Activity添加了一个回调接口来监听它的生命周期变化的；而Android 29以下，它和Glide感知Activity的生命周期的实现类似，都是通过向Activity中添加一个Fragment来感知的。

源码分析

Activity生命周期的监听

Activity都会间接继承于ComponentActivity，它的onCreate方法如下：

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    mSavedStateRegistryController.performRestore(savedInstanceState);
    ReportFragment.injectIfNeededIn(this);  //调用ReportFragment的静态方法injectIfNeededIn
    if (mContentLayoutId != 0) {
        setContentView(mContentLayoutId);
    }
}

ReportFragment.injectIfNeededIn(Activity activity)

这个静态方法的作用就是通过ReportFragment监听传入的Activity的生命周期事件。

public static void injectIfNeededIn(Activity activity) {
    if (Build.VERSION.SDK_INT >= 29) {
        //Android 29及以上直接向Activity注册一个生命周期回调，
        activity.registerActivityLifecycleCallbacks(
            new LifecycleCallbacks());
    }
    //Android 29以下通过向Activity中添加一个ReportFragment对象本身来感知它的生命周期变化，这和Glide的做法很像
    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的生命周期回调中，都会调用dispatch方法来分发生命周期事件

@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);
}

...     //省略其他生命周期回调方法

ReportFragment.dispatch(xxx)

static void dispatch(@NonNull Activity activity, @NonNull Lifecycle.Event event) {
    //已经被废弃，support v7下的AppCompatActivity实现的是这个LifecycleRegistryOwner接口，忽略它
    if (activity instanceof LifecycleRegistryOwner) {
        ((LifecycleRegistryOwner) activity).getLifecycle().handleLifecycleEvent(event);
        return;
    }

    if (activity instanceof LifecycleOwner) {
        //获取Activity持有的LifecycleRegistry对象（LifecycleRegistry是Lifecycle的实现类）
        Lifecycle lifecycle = ((LifecycleOwner) activity).getLifecycle();
        if (lifecycle instanceof LifecycleRegistry) {
            ((LifecycleRegistry) lifecycle).handleLifecycleEvent(event);
        }
    }
}

LifecycleRegistry

LifecycleOwner的实现类都持有一个LifecycleRegistry来保存所有的观察者；同时LifecycleRegistry持有LifecycleOwner的一个弱引用，用于判断Activity/Fragment等是否被销毁。

public class LifecycleRegistry extends Lifecycle {

    /**
     其实就是一个LinkedList，它可以在遍历时修改元素
     * Invariant: at any moment of time for observer1 & observer2:
     * if addition_order(observer1) < addition_order(observer2), then
     * state(observer1) >= state(observer2),
     */
    private FastSafeIterableMap<LifecycleObserver, ObserverWithState> mObserverMap =
        new FastSafeIterableMap<>();
    
    private State mState;   //当前的状态
    /**
     通过弱引用持有LifecycleOwner的引用，防止Activity或Fragment发生内存泄漏
     */
    private final WeakReference<LifecycleOwner> mLifecycleOwner;

    private int mAddingObserverCounter = 0; //正在添加的Observer 的数量

    private boolean mHandlingEvent = false; //是否正在分发LifecycleOwner的生命周期事件
    private boolean mNewEventOccurred = false;  //是否有新的生命周期事件
    
    // we have to keep it for cases:
    // void onStart() {
    //     mRegistry.removeObserver(this);
    //     mRegistry.add(newObserver);
    // }
    // newObserver should be brought only to CREATED state during the execution of
    // this onStart method. our invariant with mObserverMap doesn't help, because parent observer
    // is no longer in the map.
    //就是防止上面这种情况的发生
    private ArrayList<State> mParentStates = new ArrayList<>();

    //在构造方法中创建对LifecycleOwner的弱引用并初始化它当前的状态
    public LifecycleRegistry(@NonNull LifecycleOwner provider) {
        mLifecycleOwner = new WeakReference<>(provider);
        mState = INITIALIZED;
    }
    
    public void handleLifecycleEvent(@NonNull Lifecycle.Event event) {
        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;
    }    
    
    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) {    //当前状态和map中最后的元素的状态进行比较
                backwardPass(lifecycleOwner);   //backwardPass和forwardPass类似
            }
            Entry<LifecycleObserver, ObserverWithState> newest = mObserverMap.newest();
            if (!mNewEventOccurred && newest != null
                    && mState.compareTo(newest.getValue().mState) > 0) {
                forwardPass(lifecycleOwner);
            }
        }
        mNewEventOccurred = false;
    }
}

backwardPass和forwardPass都会遍历mObserverMap中注册的观察者，并调用ObserverWithState的dispatchEvent方法

private void backwardPass(LifecycleOwner lifecycleOwner) {
    Iterator<Entry<LifecycleObserver, ObserverWithState>> descendingIterator =
        mObserverMap.descendingIterator();
    while (descendingIterator.hasNext() && !mNewEventOccurred) {
        Entry<LifecycleObserver, ObserverWithState> entry = descendingIterator.next();
        ObserverWithState observer = entry.getValue();
        while ((observer.mState.compareTo(mState) > 0 && !mNewEventOccurred
                && mObserverMap.contains(entry.getKey()))) {
            Event event = downEvent(observer.mState);
            pushParentState(getStateAfter(event));
            observer.dispatchEvent(lifecycleOwner, event);
            popParentState();
        }
    }
}

ObserverWithState.dispatchEvent()

static class ObserverWithState {
    State mState;
    LifecycleEventObserver mLifecycleObserver;  //这就是向Lifecycle（LifecycleRegistry）注册的观察者

    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);    //这里会回调它的onStateChanged方法，将事件传递给它
        mState = newState;
    }
}