Android recyclerview custom adapter

Очень удобный абстрактный адаптер для RecyclerView своими руками

Когда-то, на заре моей карьеры Android-разработчиком, я просматривал примеры уже имеющихся приложений и в прекрасном, словно солнышко весной, U2020 я нашел пример очень удобного адаптера. Имя его BindableAdapter. Долгое время я использовал его как основу своих адаптеров для ListView и GridView, но их эра приходит к своему закату и наступает эра RecyclerView. Этой эре нужен новый удобный адаптер, и я попытался его сделать.

Для начала я решил спросить у Google «Где ж моя любимая?» «RecyclerBindableAdapter», и ответа он мне не дал. Я честно попытался найти адаптер, с которым мне было бы удобно работать, но все было тщетно. Все найденные мной примеры реализовывали лишь конкретный функционал и не старались быть абстрактными. Да и, честно говоря, многие моменты в них меня смущали, к примеру: во многих из них в конструктор зачем-то передавались Context и LayoutManager. Хотя у RecyclerView.Adapter есть прекрасный метод onAttachedToRecyclerView(RecyclerView recyclerView), а из полученного recyclerView можно без лишнего шума и пыли получить и Context и LayoutManager.

Все это наводило меня на мысли, что они написаны скорее на скорую руку, чем вдумчиво. Так как RecyclerView использую повсеместно и каждый раз плодить кучу похожего кода как-то не комильфо, то я решил исправить ситуацию и написать удобный абстрактный адаптер.

А что вообще собственно нужно?

Портировать тот самый BindableAdapter под RecyclerView, при этом постараться максимально использовать все новые возможности RecyclerView. Как всегда есть одно «но»: RecyclerView по умолчанию не имеет Header’ов и Footer’ов. Следовательно когда будущий пользователь постарается исправить эту проблему создав новый тип элемента, из-за этого номер позиции сместится на количество Header’ов. Это плохо. Значит нужно заранее сделать возможность работы с Header’ами и Footer’ами, а также предусмотреть их наличие в методах работы с данными.

Потом я подумал, что неплохо бы было реализовать и другие возможности RecyclerView которыми я часто пользуюсь, а именно: фильтрация элементов и параллакс Header’а. Тут тоже не все так гладко.

Адаптер предусматривающий фильтрацию вынужден хранить два списка объектов (общий список и список тех элементов, что сейчас отображаются). Следовательно он занимает больше памяти, да и методы для работы с элементами будут работать медленнее. Незачем заранее забивать память лишними данными, да и фильтрация нужна не так уж часто. Поэтому было принято решение сделать его отдельным классом расширяющим наш основной адаптер. Таким образом мы будем использовать этот адаптер только тогда, когда нам необходима фильтрация, а в остальных случаях будем использовать основной адаптер.

Похожая ситуация сложилась и с параллаксом Header’a. Основной адаптер может иметь множество Header’ов и Footer’ов. Реализовать параллакс сразу нескольких элементов синхронно скорее всего будет проблематично, да и выглядеть будет некрасиво, так что не смысла даже пытаться. Делаем его так же отдельным классом.

На этом этапе я подумал, что неплохо было бы иметь некий аналог SimpleAdapter. Такой, чтоб его можно было объявить одной строкой, просто подсунув в него Layout ID и ViewHolder. Ведь зачем плодить кучу кода для простого списка.

В итоге задача сводилась к созданию 4 адаптеров:

1. RecyclerBindableAdapter — наш основной адаптер
2. FilterBindableAdapter — адаптер с возможностью фильтрации
3. ParallaxBindableAdapter — адаптер с возможностью параллакса Header’а
4. SimpleBindableAdapter — простой адаптер

Приступаем

RecyclerBindableAdapter

Для начала сделаем возможным добавление Header’ов и Footer’ов, подобную реализацию я когда-то встретил на просторах StackOverflow и подкорректировал по нужды нашего адаптера. Я думаю подобную реализацию видели или делали большинство людей работающих с Android, поэтому подробно останавливаться на ней не буду.

Теперь нужно сделать методы для работы с данными, названия для них возьмем из BindableAdapter для ListView/GridView.

Ну вот в принципе мы и закончили наш RecyclerBindableAdapter. Полный текст можно посмотреть тут или под спойлером.

Теперь создадим какой-нибудь пример:

Вот так вот, все теперь просто. Работа с адаптером упростилась в разы. Здесь вы можете найти этот пример, а вот здесь пример для нескольких типов.

FilterBindableAdapter

Давайте теперь создадим адаптер с возможностью фильтрации. Расширяем RecyclerBindableAdapter и первым делом создаем два списка объектов: все объекты и те, что сейчас отображены. Переопределим часть методов, что бы теперь они работали с двумя списками.

Теперь сделаем фильтрацию.

Пример адаптера полностью аналогичен примеру RecyclerBindableAdapter за исключением одного метода. Этот метод для конвертации элемента в строку, что бы мы потом могли отфильтровать элементы.

Полный текст можно посмотреть тут или под спойлером.

Пример можно посмотреть тут.

ParallaxBindableAdapter

Теперь приступим к созданию эффекта параллакса. Изначально я планировал сделать параллакс только для Header’а, но потом подумал, что сделать параллакс и для Footer’а будет весьма интересным опытом. Для начала переопределим методы для добавления Header’ов и Footer’ов так, чтобы наш адаптер мог иметь только по одному их экземпляру.

Теперь давайте сделаем методы для сдвигания контейнера при скролле. Для этого в методе onAttachedToRecyclerView() повесим на RecyclerView OnScrollListener. Внутри него будем вызывать метод для сдвигания. Ну и естественно нужно создать методы для того, чтобы включать/отключать эффект параллакса.

Полный текст можно посмотреть тут или под спойлером.

Пример по сути точно такой же как и для RecyclerBindableAdapter, просто нужно изменить что расширять. Пример смотреть тут.

SimpleBindableAdapter

Для того, чтобы сделать такой адаптер, для начала нам понадобится создать свой ViewHolder. Это делается для того, что бы мы затем точно знали какие методы нам вызывать. Так же нужно сделать свой интерфейс от которого мы в дальнейшем будем наследоваться.

Теперь приступим к созданию нашего адаптера. Просто окончательно переопределим все методы из RecyclerBindableAdapter и будет создавать новый экземпляр нашего ViewHolder через Java Reflection.

Теперь о том, как им пользоваться. Все очень и очень просто.

Вот и все, очень просто, не правда ли. Конечно нам еще нужен ViewHolder.

Вот и вся инициализация. Вот здесь можно найти пример.

Вот ссылка на репозиторий, в нем вы найдете все примеры и адаптеры, а также больше документации на кривом английском.

PS. Проект еще не завершен на все 100% поэтому буду признателен за помощь, конструктивную критику и предложения по улучшению. Так же возможно к тому моменту когда вы прочтете эту статью, появится что-то новое.

PSS. На одном из проектов в которых я участвовал, мой коллега начал создание BindableAdapter для RecyclerView, но так и не закончил, сделав реализацию лишь под конкретный проект. В любом случае, если ты это читаешь, большее спасибо за толчок и за идею.

Источник

Android recyclerview custom adapter

Note: In some cases, adding the RecyclerView dependency library can lead to version incompatibility errors. This is a known issue. If you experience errors after adding the RecyclerView library, see the Addressing Version Incompatibility section at the end of this lesson.

So far, we only used Android’s built-in ArrayAdapters to display lists of information in an activity. We’ve altered those ArrayAdapters to be able to pass additional data, and we have made a simple custom adapter to work with a simple layout. Often though, we’ll want to display more than just a single string, and we’ll want to use our own layout. Because the objects we are passing around and parsing into custom layouts are about to get more complex, we will spend some time learning about a powerful new tool to process information into a repeating layout: A RecyclerView.

Required Reading

Begin by reading CodePath’s article Using the Recycler View.

RecyclerView

The RecyclerView is a newer Android ViewGroup object meant to render any adapter-based View . It’s similar to a ListView , but with many updated features, including the ability to implement both horizontal and vertical lists. (This will come in handy later, when we add functionality to display content horizontally or vertically depending on the device orientation).

RecyclerView Requirements

• To use a RecyclerView widget, you must also include its corresponding RecyclerView.Adapter and LayoutManager .
  • A LayoutManager is responsible for positioning individual item views inside the RecyclerView . The LayoutManager knows the size of the layout, and can compute how much space needs to be reserved to show the optimum amount of entries.

There are three built-in LayoutManager options: * LinearLayoutManager : Displays items in a vertical or horizontal scrolling list. * GridLayoutManager : Displays items in a grid. * StaggeredGridLayoutManager : Displays items in a more staggered grid. * Every RecyclerView must also be backed by a model — this means that it can parse or lay out a specific Object .

RecyclerView.Adapter

The RecyclerView.Adapter , much like the built-in Android ArrayAdapter , will populate the data into the RecyclerView . It also converts a Java object into an individual list item View to be inserted and displayed to the user.

Let’s look at this image one more time, as we are about to build something very similar:

To be able to bring the above sketch to life, we’ll need the following code pieces.

Requirements

• The RecyclerView.Adapter requires a ViewHolder . A ViewHolder is an object that stores multiple Views inside the tag field of the Layout so they can be immediately loaded, and you don’t have to find them by id repeatedly. This also improves application performance.
• The RecyclerView.Adapter has three primary methods: onCreateViewHolder() , onBindViewHolder() , and getItemCount() .
  • onCreateViewHolder() inflates an XML layout and returns a ViewHolder .
  • onBindViewHolder() sets the various information in the list item View through the ViewHolder . This is the moment when the data from our model gets associated, aka «bound» to our view.
  • getItemCount() simply returns the number of items the RecyclerView will be responsible for listing, so that it knows how many list item views it will need to recycle.

Consider this visual depictions of how the RecyclerView works:

Enough theory. Let’s get coding.

Adding RecyclerView to MyRestaurants

First, we’ll add the RecyclerView support library:

We’ll then add the RecyclerView widget to our activity_restaurants.xml:

Next we’ll create a layout to define the appearance of each restaurant list item. Create a new layout resource file called restaurant_list_item.xml and add the following code to create our list item placeholder:

We wrap the ratingTextView in a RelativeLayout inside of it’s containing vertical LinearLayout so that it will display nicely on the bottom right corner of the list item.

To do this, we must specify that the relative layout’s height and width match the remaining space allotted after the restaurant and cuisine type TextViews using the match_parent value.

Note: Feel free to use any placeholder image you want. Here, we are using an image in our Drawable folder called «waffles».

Creating Custom Adapters

Next, we’ll create our custom adapter. Create a new package called adapters. Inside it, make a new Java class called RestaurantListAdapter.

Our custom RestaurantListAdapter class will need to extend the RecyclerView.Adapter class. We’ll also include a constructor:

We will need mContext to create our ViewHolder , and mRestaurants to calculate the item count, which informs the RecyclerView how many individual list item Views it will need to recycle.

RecyclerView View Holders

We also know our RecyclerView adapter will require a ViewHolder . We can create this as an inner-class here within our RestaurantListAdapter class. An inner-class, also sometimes referred to as a nested class is simply a class that resides within another class. They have all functionality of a non-nested class, but with limited scope. They also have full access to the class in which they are nested.

Our RestaurantViewHolder inner class will extend the RecyclerView.ViewHolder class, use ButterKnife to bind all views in the layout, and include a method called bindRestaurant() that will set the contents of the layout’s TextViews to the attributes of a specific restaurant:

Now that we have the necessary ViewHolder, we can add the remaining three methods required by the RecyclerView.Adapter : onCreateViewHolder() , onBindViewHolder() , and getItemCount() :

The .onCreateViewHolder() method inflates the layout, and creates the ViewHolder object required from the adapter. We will revisit this momentarily.

.onBindViewHolder() updates the contents of the ItemView to reflect the restaurant in the given position.

.getItemCount() sets the number of items the adapter will display.

Finally, we set up our ViewHolder . We find the views and set their values for the item in the list.

Using Custom Adapters with RecyclerView

Now, we are ready to use our RestaurantListAdapter in our RestaurantsActivity. Similar to the way we previously used ListViews in conjunction with ArrayAdapters , we’ll call the .setAdapter() method on our new RecyclerView to set RestaurantListAdapter as its new adapter.

Additionally, we’ll need to create and set an instance of the LayoutManager the RecyclerView requires. We’ll use the LinearLayoutManager .

First, we’ll replace these two lines of code near the top of the file:

..with these two lines:

Because we’re now depending on our RecyclerView and corresponding adapter to display information in our UI, instead of our old LocationText and List views.

We can also remove the following line completely:

Because we’re not longer using the mLocationTextView it refers to.

Next, we’ll add code to instantiate the adapter, associate it with our RecyclerVIew, and assign a layout manager to our overriden run() method in the onResponse() callback of getRestaurants() :

The line mRecyclerView.setHasFixedSize(true); informs mRecyclerView that its width and height should always remain the same. Otherwise, as individual list item views are continually recycled, it may attempt to reset its own size to best fit the content.

If each list item was a different size, the RecyclerView might need to resize as we scrolled to best fit content, but our list items are pretty uniform. So, we can avoid wasting precious processing power by setting a fixed size.

The entire updated file should now look like this:

We now have a customized list of restaurants using a RecyclerView . Nice work!

Video Version of this Lesson

Here is the slightly outdated, optional video for this lesson if you would like to review it for reference.

Addressing Version Incompatibility

Sometimes, depending on the specific dependencies of your project, students may receive a build errors at this point in the curriculum. This is due to a version incompatibiity issue with the RecyclerView dependency library. If you experience this issue, attempt the following:

In your build.gradle file, change your compileSdkVersion value to read 25 , like so:

Then, update the version numbers of any Android dependencies to 25.3.1 . (If you’ve been following along with the curriculum exactly, the only other Android dependencies your project should have are com.android.support:recyclerview-v7 and com.android.support:appcompat ). The updated dependencies section of your build.gradle should look like this:

At this point, make sure to sync Gradle. If you still experience issues, try cleaning and rebuilding your project.

Terminology

RecyclerView`: A newer Android ViewGroup object meant to render any adapter-based View . It’s similar to a ListView , but with many updated features, including the ability to implement both horizontal and vertical lists.

• LayoutManager : Responsible for positioning individual item views inside the RecyclerView . There are three built-in LayoutManager options:
• LinearLayoutManager : Displays items in a vertical or horizontal scrolling list.
• GridLayoutManager : Displays items in a grid.
• StaggeredGridLayoutManager : Displays items in a more staggered grid.

RecyclerView.Adapter : Similar to the built-in Android ArrayAdapter . It will populate the data into the RecyclerView . It also converts a Java object into an individual list item View to be inserted and displayed to the user.

ViewHolder : An object that stores multiple Views inside the tag field of the Layout so they can be immediately loaded, and you don’t have to find them by id repeatedly. A ViewHolder is required by the RecyclerView.Adapter .

Inner-class: Also sometimes referred to as a nested class. A class that resides within another class. They have all functionality of a non-nested class, but with limited scope. They also have full access to the class in which they are nested.

Examples

Creating a custom RecyclerView.Adapter :

Instantiating and setting RecyclerView.Adapter :

Lesson 10 of 21
Last updated more than 3 months ago.

Источник