BindingCollectionAdapter 使用教程
项目介绍
BindingCollectionAdapter 是一个用于 Android 的开源库,旨在简化在 MVVM 架构中绑定集合数据到 ListView 和 RecyclerView 的过程。它与 Android Data Binding 框架紧密结合,提供了一种方便的方式来实现数据的自动更新。该库支持 AndroidX 和 Data Binding V2,并且可以在 GitHub 上找到其源代码和文档。
项目快速启动
添加依赖
首先,在你的 build.gradle
文件中添加以下依赖:
implementation 'me.tatarka.bindingcollectionadapter2:bindingcollectionadapter:4.0.0'
implementation 'me.tatarka.bindingcollectionadapter2:bindingcollectionadapter-recyclerview:4.0.0'
创建布局文件
创建一个布局文件 item_layout.xml
,用于定义列表项的视图:
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
<data>
<variable
name="item"
type="com.example.Item" />
</data>
<LinearLayout
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:orientation="vertical">
<TextView
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="@{item.name}" />
</LinearLayout>
</layout>
创建 ViewModel
创建一个 ViewModel 类 MainViewModel.java
,用于管理数据:
public class MainViewModel {
public final ObservableList<Item> items = new ObservableArrayList<>();
public final ItemBinding<Item> itemBinding = ItemBinding.of(BR.item, R.layout.item_layout);
public MainViewModel() {
// 添加示例数据
for (int i = 0; i < 10; i++) {
items.add(new Item("Item " + i));
}
}
}
创建 Activity
在 Activity 中使用 ViewModel 和 BindingCollectionAdapter:
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ActivityMainBinding binding = DataBindingUtil.setContentView(this, R.layout.activity_main);
MainViewModel viewModel = new MainViewModel();
binding.setViewModel(viewModel);
}
}
创建主布局文件
创建主布局文件 activity_main.xml
,用于显示 RecyclerView:
<?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>
<variable
name="viewModel"
type="com.example.MainViewModel" />
</data>
<androidx.recyclerview.widget.RecyclerView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:items="@{viewModel.items}"
app:itemBinding="@{viewModel.itemBinding}" />
</layout>
应用案例和最佳实践
处理多个 View Types
BindingCollectionAdapter 支持处理多个视图类型。你可以通过重写 getItemLayoutRes
方法来实现:
public class MultiTypeViewModel {
public final ObservableList<Object> items = new ObservableArrayList<>();
public final ItemBinding<Object> itemBinding = ItemBinding.of(new OnItemBind<Object>() {
@Override
public void onItemBind(ItemBinding itemBinding, int position, Object item) {
if (item instanceof TypeA) {
itemBinding.set(BR.item, R.layout.item_type_a);
} else if (item instanceof TypeB) {
itemBinding.set(BR.item, R.layout.item_type_b);
}
}
});
}
绑定多个变量
你可以在布局文件中绑定多个变量:
<layout xmlns: