Здравствуйте уважаемые читатели. Все мы любим и используем DataBinding, который представила компания Google несколько лет назад, для связи модели данных с вьюшками через ViewModel. В этой статье, хочу поделиться с вами, как можно унифицировать этот процесс с помощью языка Kotlin, и уместить создание адаптеров для RecyclerView (далее RV), ViewPager и ViewPager2 в несколько строчек кода.
Начну с того, что раньше разрабатывали кастомные адаптеры, которые под капотом создавали ViewHolder'ы, и их написание, а тем более поддержка, занимала достаточно большое количество времени. Ниже приведу пример типичного адаптера для RV:
class CustomAdapter(private val dataSet: Array<String>) : RecyclerView.Adapter<CustomAdapter.ViewHolder>() { class ViewHolder(view: View) : RecyclerView.ViewHolder(view) { val textView: TextView init { textView = view.findViewById(R.id.textView) } } override fun onCreateViewHolder(viewGroup: ViewGroup, viewType: Int): ViewHolder { val view = LayoutInflater.from(viewGroup.context).inflate(R.layout.text_row_item, viewGroup, false) return ViewHolder(view) } override fun onBindViewHolder(viewHolder: ViewHolder, position: Int) { // Get element from your dataset at this position and replace the viewHolder.textView.text = dataSet[position] } override fun getItemCount() = dataSet.size}
С тем как проект увеличивается, подобных адаптеров может становиться намного больше. Помню, однажды, адаптер был настолько огромный, в несколько сотен строчек кода, что разобраться, что там происходит, а тем более добавить что-то новое занимало колосальное количество времени, так как он работал с разными моделями данных, а так же должен был создавать различные отображения для каждого типа данных. Честно скажу, это было тяжело.
Затем появился DataBinding
и большую часть по связыванию данных перекладывалась на него, но
адаптеры все равно приходилось писать вручную, изменились только
методы onCreateViewHolder
, где вместо инфлэйтинга
через LayoutInflater
, использовался
DataBindingUtil.inflate
, а при создании
вьюхолдеров данные связывались непосредственно с самой
вьюшкой через ссылку на созданный объект байдинга.
class BindingViewHolder(val binding: ItemTextRowBinding) : RecyclerView.ViewHolder(binding.root)override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): BindingViewHolder { val binding = DataBindingUtil.inflate<ItemTextRowBinding>(LayoutInflater.from(parent.context), viewType, parent, false) val viewHolder = BindingViewHolder(binding) return viewHolder}override fun onBindViewHolder(holder: BindingViewHolder, position: Int) { holder.binding.setVariable(BR.item, dataSet[position])}
Выглядит уже лучше, но что если в RV, по прежнему должны
отображаться элементы лайаута с разными типами данных, то такая
реализация не сильно помогла решить проблему больших адаптеров. И
здесь на помощь приходит аннотация BindingAdapter
из библиотеки androidx.databinding. С ее помощью, можно
создать универсальное решение, которое скрывает реализацию создания
адаптера для RV, если использовать вспомогательный
объект-конфигуратор DataBindingRecyclerViewConfig
, в
котором содержится ряд свойств для настройки адаптера.
В результате на свет появилась библиотека, которая называется
EasyRecyclerBinding. В нее
так же вошли BindingAdapters
для ViewPager и ViewPager2. Теперь процесс
связывания данных выглядит следующим образом:
1) В лайауте фрагмента, необходимо добавить специальные переменные,
которые содержат список отображаемых моделей данных и конфигурацию,
указав их атрибутами для RV, - app:items
и
app:rv_config
.
<?xml version="1.0" encoding="utf-8"?><layout xmlns:android="http://personeltest.ru/away/schemas.android.com/apk/res/android" xmlns:app="http://personeltest.ru/away/schemas.android.com/apk/res-auto" xmlns:tools="http://personeltest.ru/away/schemas.android.com/tools"> <data> <variable name="vm" type="com.rasalexman.erb.ui.base.ExampleViewModel" /> <variable name="rvConfig" type="com.rasalexman.easyrecyclerbinding.DataBindingRecyclerViewConfig" /> </data> <androidx.constraintlayout.widget.ConstraintLayout android:id="@+id/main" android:layout_width="match_parent" android:layout_height="match_parent"> <androidx.recyclerview.widget.RecyclerView android:layout_width="0dp" android:layout_height="0dp" app:items="@{vm.items}" app:rv_config="@{rvConfig}" app:layout_constraintBottom_toBottomOf="parent" app:layout_constraintEnd_toEndOf="parent" app:layout_constraintStart_toStartOf="parent" app:layout_constraintTop_toTopOf="parent" tools:listitem="@layout/item_recycler"/> </androidx.constraintlayout.widget.ConstraintLayout></layout>
ViewModel, соответственно, содержит список моделей данных для адаптера, которые должны отображаться в RV, а фрагмент конфигурацию DataBindingRecyclerViewConfig.
// названия пакетов не указаны для простоты примераclass ExampleViewModel : ViewModel() { val items: MutableLiveData<MutableList<RecyclerItemUI>> = MutableLiveData()}data class RecyclerItemUI( val id: String, val title: String)
Сам лайаут для элемента списка, должен содержать ссылку на модель данных, чтобы связать их вместе.
<?xml version="1.0" encoding="utf-8"?><layout xmlns:android="http://personeltest.ru/away/schemas.android.com/apk/res/android" xmlns:app="http://personeltest.ru/away/schemas.android.com/apk/res-auto" xmlns:tools="http://personeltest.ru/away/schemas.android.com/tools"> <data> <variable name="item" type="com.rasalexman.erb.models.RecyclerItemUI" /> </data> <androidx.constraintlayout.widget.ConstraintLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:background="@android:drawable/list_selector_background"> <TextView android:id="@+id/titleTV" android:layout_width="match_parent" android:layout_height="wrap_content" android:paddingStart="16dp" android:paddingTop="8dp" android:paddingEnd="16dp" android:textColor="@color/black" android:textSize="18sp" android:text="@{item.title}" app:layout_constraintEnd_toEndOf="parent" app:layout_constraintStart_toStartOf="parent" app:layout_constraintTop_toTopOf="parent" tools:text="Hello world" /> <TextView android:layout_width="match_parent" android:layout_height="wrap_content" android:paddingStart="16dp" android:paddingEnd="16dp" android:paddingBottom="8dp" android:textColor="@color/gray" android:textSize="14sp" android:text="@{item.id}" app:layout_constraintEnd_toEndOf="parent" app:layout_constraintStart_toStartOf="parent" app:layout_constraintTop_toBottomOf="@+id/titleTV" tools:text="Hello world" /> </androidx.constraintlayout.widget.ConstraintLayout></layout>
2) Во фрагменте нам нужно получить конфигурацию для адаптера и
передать её в отображение через инстанс dataBinding,
используя специальную функцию-конструктор
createRecyclerConfig<I : Any, BT :
ViewDataBinding>
, которая создаст и вернет инстанс
DataBindingRecyclerViewConfig, указав при этом id лайаута
для выбранной модели, и название свойства, к которому будет
прикреплена данная модель.
class RecyclerViewExampleFragment : BaseBindingFragment<RvExampleFragmentBinding, ExampleViewModel>() { override val layoutId: Int get() = R.layout.rv_example_fragment override val viewModel: ExampleViewModel by viewModels() override fun initBinding(binding: RvExampleFragmentBinding) { super.initBinding(binding) binding.rvConfig = createRecyclerConfig<RecyclerItemUI, ItemRecyclerBinding> { layoutId = R.layout.item_recycler itemId = BR.item } }}
Это все, что нужно сделать, чтобы связать данные из ViewModel с
отображением списка в RV. Так же при создании адаптера можно
назначить слушатели событий для байдинга вьюхолдера, такие
как onItemClick,onItemCreate, onItemBind
и другие.
А чтобы использовать вьюхолдеры с разными визуальными
лайаутами, к которым привязаны свои модели отображения данных,
необходимо имплементировать в них специальный интерфейс из
библиотеки EasyRecyclerBinding -
IBindingModel
и переопределить поле
layoutResId
, - id лайаута, который будет отображаться
для этой модели в списке.
data class RecyclerItemUI( val id: String, val title: String) : IBindingModel { override val layoutResId: Int get() = R.layout.item_recycler}data class RecyclerItemUI2( val id: String, val title: String) : IBindingModel { override val layoutResId: Int get() = R.layout.item_recycler2}
Реализация для фрагмента с разными вьюхолдерами не
сильно отличается от вышеприведенной, кроме того, используется
другая функция-конструктор createRecyclerMultiConfig
для конфигурации адаптера, в которой уже не нужно указывать тип
привязанных данных и сгенерированный класс байдинга.
class RecyclerViewExampleFragment : BaseBindingFragment<RvExampleFragmentBinding, RecyclerViewExampleViewModel>() { override val layoutId: Int get() = R.layout.rv_example_fragment override val viewModel: RecyclerViewExampleViewModel by viewModels() override fun initBinding(binding: RvExampleFragmentBinding) { super.initBinding(binding) binding.rvConfig = createRecyclerMultiConfig { itemId = BR.item } }}class RecyclerViewExampleViewModel : BasePagesViewModel() { open val items: MutableLiveData<MutableList<IBindingModel>> = MutableLiveData()}
Таким образом, создание адаптеров для отображения данных в RV, превратилось в простую задачу состоящую из пары строчек кода, где разработчику уже не надо думать о том, как поддерживать, фактически, не нужную часть presentation слоя. И даже, если модель данных изменится, достаточно будет поменять только её отображение, и связать его с новыми данными, не заботясь о поддержке адаптеров.
Аналогичный процесс создания адаптеров для ViewPager и ViewPager2,
представлен в примере на github вместе с открытым кодом, ссылку на
который, я разместил в конце статьи. В настоящий момент библиотека
еще дорабатывается, и хочется получить адекватный фидбек, и
пожелания по дальнейшему ее развитию. Так же в неё вошли
вспомогательные функции для удобного создания байдинга, в том числе
в связке с ViewModel. (LayoutInflater.createBinding,
Fragment.createBindingWithViewModel, etc)
Спасибо, что дочитали до конца. Приятного кодинга и хорошего настроения)