阅读 1030

为什么Fragment中要使用viewLifecycleOwner代替this

建议使用viewLifecycleOwner

在Fragment中对LiveData对象调用observe方法时,如果传递的LifecycleOwner参数为this,即Fragment时,会收到Android Studio的提醒,要求使用viewLifecycleOwner,如下图所示:

从类型上说,Fragment与viewLifecycleOwner的类型FragmentViewLifecycleOwner二者都继承了LifecycleOwner,向之前那样直接使用this,大部分情况下运行也是完全正常的。那么这里的Lint提醒是为什么呢?

通过在官网寻找androidx.fragment:fragment 的文档,可以看到 1.2.0版本有如下一条更新说明:

可见这是有意为之的,下面分析其原因。

viewLifecycleOwner相关生命周期

跟踪viewLifecycleOwner的相关代码(无关代码已省略):

//Fragment.java    
    void performCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container,
            @Nullable Bundle savedInstanceState) {
        mViewLifecycleOwner = new FragmentViewLifecycleOwner();
        mView = onCreateView(inflater, container, savedInstanceState);
        ...
    }
复制代码
//FragmentManager.java 	    
    private void destroyFragmentView(@NonNull Fragment fragment) {
        //下行代码会调用onDestroyView()
        fragment.performDestroyView();
        fragment.mViewLifecycleOwner = null;
        ...
    }
复制代码

可以发现,mViewLifecycleOwner的赋值在onCreateView之前,置空在onDestroyView之后,mViewLifecycleOwner的注释同样表明了这点:

This is initialized in performCreateView and unavailable outside of the onCreateView/onDestroyView lifecycle.

正如类名所示,该FragmentViewLifecycleOwner代表的是Fragment中View的LifecycleOwner,Fragment中View的生命周期与Fragment本身并不相同。复习一下Fragment生命周期:

Fragment入back stack的过程会执行onDestroyView但不执行之后的onDestroy与onDetach,而出back stack是从onCreateView开始执行,而没有之前的onAttach与onCreate。

LiveData的observe过程

理清了相关生命周期后,下面来看一下LiveData的observe过程。

我们知道在LiveData的observe方法内,会将参数owner与observer包装起来,使得observer的回调受owner的生命周期的影响,只有在owner处于活跃状态才回调observer,而活跃状态指的是当前owner的生命周期至少为STARTED,即如下(1)处,owner与observer的包装类中否活跃的判断方法。

    class LifecycleBoundObserver extends ObserverWrapper implements LifecycleEventObserver {
        @NonNull
        final LifecycleOwner mOwner;
        LifecycleBoundObserver(@NonNull LifecycleOwner owner, Observer<? super T> observer) {
            super(observer);
            mOwner = owner;
        }
        @Override
        boolean shouldBeActive() {
            return mOwner.getLifecycle().getCurrentState().isAtLeast(STARTED);
        }//1
        @Override
        public void onStateChanged(@NonNull LifecycleOwner source,
                @NonNull Lifecycle.Event event) {
            if (mOwner.getLifecycle().getCurrentState() == DESTROYED) {
                removeObserver(mObserver);//2
                return;
            }
            activeStateChanged(shouldBeActive());
        }
		...
    }
复制代码

可是,Fragment与Fragment中的View在活跃的生命周期状态是一致的,这里的owner使用fragment还是viewLifecycleOwner并无不同,二者只有在onCreateView到onDestroyView之外有区别。

包装类中的onStateChanged方法会执行observer的适时移除工作,而(2)处的移除observer正是在owner处于DESTROYED时发生的。对于Fragment,状态会在onDestroyView执行前夕,变为DESTROYED,如下所示:

//Fragment.java	
    void performDestroyView() {
        mChildFragmentManager.dispatchDestroyView();
        if (mView != null) {
            mViewLifecycleOwner.handleLifecycleEvent(Lifecycle.Event.ON_DESTROY);
        }
        mState = CREATED;
        onDestroyView();
		...
    }
复制代码

原因

此时,一切都解释得通了,在Fragment中对LiveData对象调用observe方法时,使用viewLifecycleOwner代替this的原因是:Fragment与Fragment中的View的生命周期并不一致,需要让observer感知Fragment中的View的生命周期而非Fragment,因此Android专门构造了Fragment中的View的LifecycleOwner,即viewLifecycleOwner。

我们可以使用Fragment的back stack轻易构造出一种场景,来体现出两者的差异。

val handler = Handler(Looper.getMainLooper())

class BlankFragment1 : Fragment() {
    val data = MutableLiveData<Int>()
    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        return inflater.inflate(R.layout.fragment_blank1, container, false)
    }

    override fun onActivityCreated(savedInstanceState: Bundle?) {
        super.onActivityCreated(savedInstanceState)
        tv.setOnClickListener {
            parentFragmentManager.beginTransaction()
                .replace(R.id.container, BlankFragment2())
                .addToBackStack(null)
                .commit()//1
            handler.postDelayed({
                data.value = (data.value ?: 0) + 1
            }, 2000)//2
        }
        data.observe(viewLifecycleOwner, Observer {
            Log.e("viewLifecycleOwner", "count: ${data.value}")
        })//3
        data.observe(this, Observer {
            Log.e("fragment", "count: ${data.value}")
        })//4
    }
}
复制代码

向Activity的id为container的FrameLayout中add上述BlankFragment1,然后点击tv时,(1)处将BlankFragment1 replace为BlankFragment2,注意要将BlankFragment1添加到back stack。然后延时2s,在(2)处修改LiveData值。这里延时是为了Fragment的生命周期执行完毕,另外,LiveData声明在Viewmodel中更合适,这里为了方便写在Fragment中。(3)(4)处分别使用两种写法observe data。

页面切换到BlankFragment2后,等待2s,返回BlankFragment1,查看打印如下:

2021-01-08 10:35:19.482 27156-27156/com.caz.test E/fragment: count: 1
2021-01-08 10:35:19.482 27156-27156/com.caz.test E/fragment: count: 1
2021-01-08 10:35:19.482 27156-27156/com.caz.test E/viewLifecycleOwner: count: 1
复制代码

可以发现用this作为LifecycleOwner的日志打印了两次,这是因为BlankFragment1返回时会重新执行onCreateView到onDestroyView生命周期方法,(4)处相同逻辑的绑定Fragment生命周期的Observer被添加了两次,而(3)处绑定Fragment View生命周期的Observer会随着replace时View的移除而移除,只留下BlankFragment1返回时新添加的Observer。

Android推荐使用viewLifecycleOwner正是因为,在几乎全部情况下,我们的Observer内逻辑,都是与Fragment 中View生命周期相关的。