MVVM架构下ViewBinding实现include布局onClick事件方案

问题场景 #

在MVVM架构的Android开发中，主布局通过<include>标签引入公共子布局时，原有DataBinding方式绑定的子布局内控件点击事件失效，要求完全不依赖DataBinding，仅通过ViewBinding实现子布局控件的点击事件绑定。
现有布局结构：

• 主布局X：activity_main.xml，通过<include>引入工具栏布局Y
• 子布局Y：toolbar_layout.xml，内部存在id为img_back的返回按钮，需要绑定点击事件触发ViewModel中的逻辑

原有配置代码如下：

布局X（activity_main.xml）原始代码：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">

    <data>
        <import type="android.view.View" />
        <variable
            name="viewModel"
            type=".view.ViewModel" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent">

        <include
            android:id="@+id/toolbar"
            layout="@layout/toolbar_layout"
            app:layout_constraintTop_toTopOf="parent"
            android:layout_width="match_parent"
            android:layout_height="wrap_content" />
        
    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

布局Y（toolbar_layout.xml）原始代码：

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <data>
        <import type="android.view.View" />
        <variable
            name="viewModel"
            type=".view.ViewModel" />
    </data>

    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_height="match_parent">

        <ImageView
            android:id="@+id/img_back"
            android:layout_width="48dp"
            android:layout_height="48dp"
            android:layout_marginStart="16dp"
            android:layout_marginTop="16dp"
            android:background="@drawable/circle_white"
            android:onClick="@{(v) -> viewModel.clickEvent()}"
            android:padding="12dp"
            app:layout_constraintStart_toStartOf="parent"
            app:layout_constraintTop_toTopOf="parent"
            app:srcCompat="@drawable/ic_baseline_arrow_back_24" />

    </androidx.constraintlayout.widget.ConstraintLayout>
</layout>

具体实现步骤 #

1. 清理DataBinding专属配置 #

因为仅使用ViewBinding，首先移除DataBinding相关的冗余配置：

• 删除两个布局文件中<data>标签及其内部所有import、variable节点
• 删除布局Y中ImageView上的DataBinding格式点击属性android:onClick="@{(v) -> viewModel.clickEvent()}"
• 可选优化：如果项目全量使用ViewBinding不接入DataBinding，可直接移除两个布局外层的<layout>根标签，ViewBinding对普通非包裹的布局同样生效

注意：布局X中<include>标签上的android:id="@+id/toolbar"必须保留，这是ViewBinding识别子布局引用的核心标记。

2. 在宿主页面（Activity/Fragment）中绑定点击事件 #

ViewBinding的机制会自动为设置了id的<include>节点生成对应子布局的Binding实例，不需要手动inflate子布局，直接通过主布局Binding即可访问子布局内的所有带id控件。
以Activity为例，实现代码如下：

class MainActivity : AppCompatActivity() {
    private lateinit var binding: ActivityMainBinding
    // 初始化ViewModel，按项目实际的注入/初始化方式即可
    private val viewModel: MainViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = ActivityMainBinding.inflate(layoutInflater)
        setContentView(binding.root)

        // 通过include的id(toolbar)直接获取子布局Binding实例，访问内部imgBack控件设置点击
        binding.toolbar.imgBack.setOnClickListener {
            // 执行ViewModel中对应的点击逻辑
            viewModel.clickEvent()
        }
    }
}

如果是Fragment场景逻辑完全一致，在onCreateView中初始化主布局Binding后按相同方式访问子布局控件即可。

常见问题排查 #

如果无法通过binding.toolbar访问到子布局控件，检查以下配置：

• 模块级build.gradle中已开启ViewBinding：

  android {
      buildFeatures {
          viewBinding true
      }
  }
  

• 两个布局文件都没有添加tools:viewBindingIgnore="true"属性
• <include>标签的id没有和子布局根容器的id重名，避免引用冲突

内容的提问来源于stack exchange，提问作者Prabhakar Thota