自动实现 ViewBinding 的 Fragment Base类

前言

在 Android 开发中，使用 ViewBinding 可以更方便地绑定布局文件中的视图组件，避免了手动 findViewById 的繁琐步骤。然而，当我们使用 ViewBinding 时，每个 Fragment 都需要手动实现绑定逻辑，这会让代码变得冗长和重复。为了简化这个过程，我们可以通过抽象类来封装 ViewBinding 的逻辑，实现自动绑定的 Fragment。

本文将介绍一个通用的 ViewBinding 抽象类，并深入讲解其实现原理和使用方法。我们将学习如何减少重复代码，提高开发效率，以及解决可能遇到的一些问题。

ViewBindingFragment 抽象类

以下是我们要介绍的 ViewBindingFragment 抽象类的代码：

import android.os.Bundle
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup
import androidx.fragment.app.Fragment
import androidx.viewbinding.ViewBinding
import java.lang.reflect.Method
import java.lang.reflect.ParameterizedType

abstract class BaseViewBindingFragment<VB : ViewBinding> : Fragment() {
    
    private var _viewBinding: VB? = null
    
    protected val viewBinding: VB
        get() = _viewBinding ?: throw IllegalStateException("ViewBinding is not initialized.")

    private val inflateMethod: Method

    init {
        //获取泛型参数化类型信息
        val parameterizedType = javaClass.genericSuperclass as ParameterizedType
        //由BaseViewBindingFragment<VB : ViewBinding>可知只有一个参数类型
        val clazz = parameterizedType.actualTypeArguments.first() as Class<*>
        //获取ViewBinding实现类中的inflate方法，如下：
//        public static ***Binding inflate(@NonNull LayoutInflater inflater, @Nullable ViewGroup parent, boolean attachToParent) {
//            View root = inflater.inflate(R.layout.***, parent, false);
//            if (attachToParent) {
//                parent.addView(root);
//            }
//            return bind(root);
//        }
        inflateMethod = clazz.getMethod("inflate", LayoutInflater::class.java, ViewGroup::class.java, Boolean::class.java)
    }


    override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
        //获取viewBinding
        _viewBinding = inflateMethod.invoke(null, inflater, container, false) as VB
        return viewBinding.root
    }


    override fun onDestroyView() {
        super.onDestroyView()
        _viewBinding = null
    }
}

实现原理

BaseViewBindingFragment 抽象类通过泛型 VB : ViewBinding 定义了一个类型参数 VB，表示使用的 ViewBinding 类型。它继承自 Fragment。

在 BaseViewBindingFragment 类的构造函数中，我们使用反射技术获取子类的 ViewBinding 类型。具体来说，我们使用了 javaClass.genericSuperclass 获取子类的带有泛型参数的父类类型。然后，通过 actualTypeArguments.first() 取得泛型参数的类型，并将其转换为 Class 对象。

接着，我们获取了 ViewBinding 类型的 inflate 方法，该方法用于将布局文件解析为对应的 ViewBinding 对象。这样，我们就获得了将布局文件解析为 ViewBinding 对象的方法引用 inflateMethod。

在 onCreateView 方法中，我们通过调用 inflateMethod.invoke 方法，将布局文件解析为 ViewBinding 对象，并将其保存在 binding 属性中。然后，返回 ViewBinding 对象的根视图作为 Fragment 的视图。

使用方法

为了使用 BaseViewBindingFragment 抽象类，我们只需要继承它，并指定 ViewBinding 类型作为泛型参数。下面是一个示例：

import com.*.FragmentSampleBinding

class SampleFragment : BaseViewBindingFragment<FragmentSampleBinding>() {

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
        super.onViewCreated(view, savedInstanceState)
        
        // 在这里可以通过 viewBinding 对象访问视图组件
        viewBinding.textView.text = "Hello, ViewBinding!"

        // ...
    }
}

在这个示例中，我们创建了一个继承自 BaseViewBindingFragment<FragmentSampleBinding> 的 Fragment 子类 SampleFragment。我们不再需要手动实现 ViewBinding 的逻辑，而是通过继承 BaseViewBindingFragment 抽象类，自动实现了 ViewBinding 的绑定。我们可以通过 binding 对象来访问视图组件，实现更简洁、易读的代码。

总结

通过封装 ViewBinding 的逻辑到 BaseViewBindingFragment 抽象类，我们实现了自动绑定的 Fragment。通过泛型和反射技术，我们可以获取子类的 ViewBinding 类型，并自动将布局文件解析为 ViewBinding 对象。这样，我们可以大大减少重复的代码，提高开发效率。在实际开发中，可以更方便地使用 ViewBinding，并减少出错的可能性。