введение

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

у меня есть рабочий пример всего, о чем я говорю здесь в этом Репозиторий GitHub.
Если вы хотите узнать больше о пример проекта посетите Домашняя страница проекта.

в любом случае результат должен выглядеть примерно так:

если вы сначала хотите поиграть с демо-приложением, вы можете установить его из Play Store:

в любом случае, давайте начнем.

---

настройка SearchView

в папке res/menu создать новый файл называется main_menu.xml. В нем добавьте элемент и установите actionViewClass до android.support.v7.widget.SearchView. Поскольку вы используете библиотеку поддержки, вы должны использовать пространство имен библиотеки поддержки, чтобы установить . Ваш XML-файл должен выглядеть примерно так:

<menu xmlns:android="http://schemas.android.com/apk/res/android"
      xmlns:app="http://schemas.android.com/apk/res-auto">

    <item android:id="@+id/action_search"
          android:title="@string/action_search"
          app:actionViewClass="android.support.v7.widget.SearchView"
          app:showAsAction="always"/>

</menu>

в своем Fragment или Activity вы должны раздуть это меню xml, как обычно, то вы можете искать MenuItem, которая содержит SearchView и реализовать OnQueryTextListener, который мы будем использовать для отслеживания изменений в введенный текст в SearchView:

@Override
public boolean onCreateOptionsMenu(Menu menu) {
    getMenuInflater().inflate(R.menu.menu_main, menu);

    final MenuItem searchItem = menu.findItem(R.id.action_search);
    final SearchView searchView = (SearchView) MenuItemCompat.getActionView(searchItem);
    searchView.setOnQueryTextListener(this);

    return true;
}

@Override
public boolean onQueryTextChange(String query) {
    // Here is where we are going to implement the filter logic
    return false;
}

@Override
public boolean onQueryTextSubmit(String query) {
    return false;
}

и теперь SearchView готов к использованию. Мы реализуем логику фильтра позже в onQueryTextChange() как только мы закончим реализацию Adapter.

---

настройка Adapter

в первую очередь это класс модели, который я собираюсь использовать для этого примера:

public class ExampleModel {

    private final long mId;
    private final String mText;

    public ExampleModel(long id, String text) {
        mId = id;
        mText = text;
    }

    public long getId() {
        return mId;
    }

    public String getText() {
        return mText;
    }
}

это просто ваша базовая модель, которая будет отображать текст в RecyclerView. Это макет I собираюсь использовать для отображения текста:

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

    <data>

        <variable
            name="model"
            type="com.github.wrdlbrnft.searchablerecyclerviewdemo.ui.models.ExampleModel"/>

    </data>

    <FrameLayout
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:background="?attr/selectableItemBackground"
        android:clickable="true">

        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:padding="8dp"
            android:text="@{model.text}"/>

    </FrameLayout>

</layout>

как вы можете видеть, я использую привязку данных. Если вы никогда раньше не работали с привязкой данных, не расстраивайтесь! Это очень простой и мощный, однако я не могу объяснить, как это работает в рамках этого ответа.

это ViewHolder на ExampleModel класс:

public class ExampleViewHolder extends RecyclerView.ViewHolder {

    private final ItemExampleBinding mBinding;

    public ExampleViewHolder(ItemExampleBinding binding) {
        super(binding.getRoot());
        mBinding = binding;
    }

    public void bind(ExampleModel item) {
        mBinding.setModel(item);
    }
}

опять ничего особенного. Он просто использует привязку данных для привязки класса модели к этому макету, как мы определили в xml-файле макета выше.

теперь мы можем, наконец, перейти к действительно интересной части: написание адаптера. Я собираюсь пропустить основную реализацию Adapter и вместо этого я собираюсь сосредоточиться на частях, которые имеют отношение к этому ответу.

но Сначала мы должны поговорить об одном:SortedList класса.

---

SortedList

The SortedList - это совершенно удивительный инструмент который является частью RecyclerView библиотека. Он заботится о уведомлении Adapter об изменениях в наборе данных и делает это очень эффективным способом. Единственное, что вам нужно сделать, это указать порядок элементов. Вам нужно сделать это, реализовав compare() метод, который сравнивает два элемента в SortedList как Comparator. Но вместо сортировки List используется для сортировки элементов в RecyclerView!

The SortedList взаимодействует с Adapter через Callback класс, который вы должны реализовать:

private final SortedList.Callback<ExampleModel> mCallback = new SortedList.Callback<ExampleModel>() {

    @Override
    public void onInserted(int position, int count) {
         mAdapter.notifyItemRangeInserted(position, count);
    }

    @Override
    public void onRemoved(int position, int count) {
        mAdapter.notifyItemRangeRemoved(position, count);
    }

    @Override
    public void onMoved(int fromPosition, int toPosition) {
        mAdapter.notifyItemMoved(fromPosition, toPosition);
    }

    @Override
    public void onChanged(int position, int count) {
        mAdapter.notifyItemRangeChanged(position, count);
    }

    @Override
    public int compare(ExampleModel a, ExampleModel b) {
        return mComparator.compare(a, b);
    }

    @Override
    public boolean areContentsTheSame(ExampleModel oldItem, ExampleModel newItem) {
        return oldItem.equals(newItem);
    }

    @Override
    public boolean areItemsTheSame(ExampleModel item1, ExampleModel item2) {
        return item1.getId() == item2.getId();
    }
}

в методах в верхней части обратного вызова, как onMoved,onInserted и т. д. вы должны вызвать эквивалентный метод notify вашего Adapter. Три метода внизу compare,areContentsTheSame и areItemsTheSame вы должны реализовать в соответствии с тем, какие объекты вы хотите отобразить и в каком порядке эти объекты должны появиться на экране.

давайте рассмотрим эти методы по один:

@Override
public int compare(ExampleModel a, ExampleModel b) {
    return mComparator.compare(a, b);
}

это compare() метод, о котором я говорил ранее. В этом примере я просто передаю вызов Comparator, который сравнивает две модели. Если вы хотите, чтобы элементы отображались в алфавитном порядке на экране. Этот компаратор может выглядеть так:

private static final Comparator<ExampleModel> ALPHABETICAL_COMPARATOR = new Comparator<ExampleModel>() {
    @Override
    public int compare(ExampleModel a, ExampleModel b) {
        return a.getText().compareTo(b.getText());
    }
};

теперь давайте посмотрим на следующий метод:

@Override
public boolean areContentsTheSame(ExampleModel oldItem, ExampleModel newItem) {
    return oldItem.equals(newItem);
}

цель этого метода-определить, изменилось ли содержимое модели. Элемент SortedList использует это, чтобы определите, нужно ли вызывать событие изменения - другими словами, если RecyclerView должен пересекать старую и новую версию. Если вы моделируете классы имеют правильный equals() и hashCode() реализация вы обычно можете просто реализовать его, как показано выше. Если мы добавим equals() и hashCode() реализации ExampleModel класс это должно выглядеть примерно так:

public class ExampleModel implements SortedListAdapter.ViewModel {

    private final long mId;
    private final String mText;

    public ExampleModel(long id, String text) {
        mId = id;
        mText = text;
    }

    public long getId() {
        return mId;
    }

    public String getText() {
        return mText;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        ExampleModel model = (ExampleModel) o;

        if (mId != model.mId) return false;
        return mText != null ? mText.equals(model.mText) : model.mText == null;

    }

    @Override
    public int hashCode() {
        int result = (int) (mId ^ (mId >>> 32));
        result = 31 * result + (mText != null ? mText.hashCode() : 0);
        return result;
    }
}

быстрая сторона Примечание: большинство IDE, как Android Studio, IntelliJ и Eclipse имеют функциональность для создания equals() и hashCode() реализации для вас одним нажатием кнопки! Так что вам не придется реализовывать их самостоятельно. Посмотрите в интернете, как это работает в вашей среде IDE!

теперь давайте посмотрим на последний метод:

@Override
public boolean areItemsTheSame(ExampleModel item1, ExampleModel item2) {
    return item1.getId() == item2.getId();
}

The SortedList использует этот метод, чтобы проверить, если два элемента относятся к одной и той же вещи. В самых простых выражениях (не объясняя, как SortedList работает) это используется, чтобы определить, если объект уже содержится в List и если добавить, перемещение или изменение анимации должны быть воспроизведены. Если ваши модели имеют идентификатор, вы обычно сравниваете только идентификатор в этом методе. Если они этого не делают, вам нужно выяснить какой-то другой способ проверить это, но в конечном итоге вы реализуете это зависит от вашего конкретного приложения. Как правило, это самый простой вариант, чтобы дать всем моделям идентификатор - это может быть, например, поле первичного ключа, если вы запрашиваете данные из базы данных.

с SortedList.Callback правильно реализовано мы можем создать экземпляр SortedList:

final SortedList<ExampleModel> list = new SortedList<>(ExampleModel.class, mCallback);

как первый параметр в конструкторе SortedList вам нужно пройти класс ваших моделей. Другой параметр-это просто SortedList.Callback мы определили выше.

теперь давайте перейдем к делу: если мы реализуем Adapter С SortedList это должно выглядеть примерно так:

public class ExampleAdapter extends RecyclerView.Adapter<ExampleViewHolder> {

    private final SortedList<ExampleModel> mSortedList = new SortedList<>(ExampleModel.class, new SortedList.Callback<ExampleModel>() {
        @Override
        public int compare(ExampleModel a, ExampleModel b) {
            return mComparator.compare(a, b);
        }

        @Override
        public void onInserted(int position, int count) {
            notifyItemRangeInserted(position, count);
        }

        @Override
        public void onRemoved(int position, int count) {
            notifyItemRangeRemoved(position, count);
        }

        @Override
        public void onMoved(int fromPosition, int toPosition) {
            notifyItemMoved(fromPosition, toPosition);
        }

        @Override
        public void onChanged(int position, int count) {
            notifyItemRangeChanged(position, count);
        }

        @Override
        public boolean areContentsTheSame(ExampleModel oldItem, ExampleModel newItem) {
            return oldItem.equals(newItem);
        }

        @Override
        public boolean areItemsTheSame(ExampleModel item1, ExampleModel item2) {
            return item1.getId() == item2.getId();
        }
    });

    private final LayoutInflater mInflater;
    private final Comparator<ExampleModel> mComparator;

    public ExampleAdapter(Context context, Comparator<ExampleModel> comparator) {
        mInflater = LayoutInflater.from(context);
        mComparator = comparator;
    }

    @Override
    public ExampleViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        final ItemExampleBinding binding = ItemExampleBinding.inflate(inflater, parent, false);
        return new ExampleViewHolder(binding);
    }

    @Override
    public void onBindViewHolder(ExampleViewHolder holder, int position) {
        final ExampleModel model = mSortedList.get(position);
        holder.bind(model);
    }

    @Override
    public int getItemCount() {
        return mSortedList.size();
    }
}

The Comparator используется для сортировки элемента передается через конструктор, так что мы можем использовать тот же Adapter даже если элементы должны отображаться в другом порядке.

теперь мы почти закончили! Но Сначала нам нужен способ добавить или удалить элементы в Adapter. Для этого мы можем добавить методы к Adapter, которые позволяют добавлять и удалять элементы SortedList:

public void add(ExampleModel model) {
    mSortedList.add(model);
}

public void remove(ExampleModel model) {
    mSortedList.remove(model);
}

public void add(List<ExampleModel> models) {
    mSortedList.addAll(models);
}

public void remove(List<ExampleModel> models) {
    mSortedList.beginBatchedUpdates();
    for (ExampleModel model : models) {
        mSortedList.remove(model);
    }
    mSortedList.endBatchedUpdates();
}

нам не нужно вызывать какие-либо методы уведомления здесь, потому что SortedList уже делает это через SortedList.Callback! Кроме того, реализация этих методов довольно прямо вперед, с одним исключением: метод remove, который удаляет List моделей. Так как SortedList имеет только один метод удаления, который может удалить один объект, который нам нужно перебрать по списку и удалить модели по одному. Звоню beginBatchedUpdates() в начале партии все изменения, которые мы собираемся сделать на SortedList вместе и повышает производительность. Когда мы зовем endBatchedUpdates() the RecyclerView уведомления обо всех изменениях сразу.

кроме того, что у вас есть нужно понять, что если вы добавляете объект в SortedList и это уже в SortedList он не будет заново добавлен. Вместо этого SortedList использует areContentsTheSame() метод, чтобы выяснить, если объект изменился - и если он имеет элемент в RecyclerView будет обновляться.

в любом случае, я обычно предпочитаю один метод, который позволяет мне заменить все элементы в RecyclerView сразу. Удалите все, что не находится в List и добавить все элементы, которые отсутствуют в SortedList:

public void replaceAll(List<ExampleModel> models) {
    mSortedList.beginBatchedUpdates();
    for (int i = mSortedList.size() - 1; i >= 0; i--) {
        final ExampleModel model = mSortedList.get(i);
        if (!models.contains(model)) {
            mSortedList.remove(model);
        }
    }
    mSortedList.addAll(models);
    mSortedList.endBatchedUpdates();
}

этот метод снова пакеты обновлений для повышения производительности. Первый цикл находится в обратном порядке, так как удаление элемента в начале испортило бы индексы всех элементов, которые появляются после него, и это может привести в некоторых случаях к таким проблемам, как несогласованность данных. После этого мы просто добавляем List до SortedList используя addAll() чтобы добавить все элементы, которые еще не находятся в SortedList и-так же, как я описал выше-обновить все элементы которые уже находятся в SortedList но изменились.

и Adapter завершено. Все это должно выглядеть примерно так:

public class ExampleAdapter extends RecyclerView.Adapter<ExampleViewHolder> {

    private final SortedList<ExampleModel> mSortedList = new SortedList<>(ExampleModel.class, new SortedList.Callback<ExampleModel>() {
        @Override
        public int compare(ExampleModel a, ExampleModel b) {
            return mComparator.compare(a, b);
        }

        @Override
        public void onInserted(int position, int count) {
            notifyItemRangeInserted(position, count);
        }

        @Override
        public void onRemoved(int position, int count) {
            notifyItemRangeRemoved(position, count);
        }

        @Override
        public void onMoved(int fromPosition, int toPosition) {
            notifyItemMoved(fromPosition, toPosition);
        }

        @Override
        public void onChanged(int position, int count) {
            notifyItemRangeChanged(position, count);
        }

        @Override
        public boolean areContentsTheSame(ExampleModel oldItem, ExampleModel newItem) {
            return oldItem.equals(newItem);
        }

        @Override
        public boolean areItemsTheSame(ExampleModel item1, ExampleModel item2) {
            return item1 == item2;
        }
    });

    private final Comparator<ExampleModel> mComparator;
    private final LayoutInflater mInflater;

    public ExampleAdapter(Context context, Comparator<ExampleModel> comparator) {
        mInflater = LayoutInflater.from(context);
        mComparator = comparator;
    }

    @Override
    public ExampleViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
        final ItemExampleBinding binding = ItemExampleBinding.inflate(mInflater, parent, false);
        return new ExampleViewHolder(binding);
    }

    @Override
    public void onBindViewHolder(ExampleViewHolder holder, int position) {
        final ExampleModel model = mSortedList.get(position);
        holder.bind(model);
    }

    public void add(ExampleModel model) {
        mSortedList.add(model);
    }

    public void remove(ExampleModel model) {
        mSortedList.remove(model);
    }

    public void add(List<ExampleModel> models) {
        mSortedList.addAll(models);
    }

    public void remove(List<ExampleModel> models) {
        mSortedList.beginBatchedUpdates();
        for (ExampleModel model : models) {
            mSortedList.remove(model);
        }
        mSortedList.endBatchedUpdates();
    }

    public void replaceAll(List<ExampleModel> models) {
        mSortedList.beginBatchedUpdates();
        for (int i = mSortedList.size() - 1; i >= 0; i--) {
            final ExampleModel model = mSortedList.get(i);
            if (!models.contains(model)) {
                mSortedList.remove(model);
            }
        }
        mSortedList.addAll(models);
        mSortedList.endBatchedUpdates();
    }

    @Override
    public int getItemCount() {
        return mSortedList.size();
    }
}

единственное, чего не хватает сейчас, это реализовать фильтрацию!

---

реализация логики фильтра

для реализации логики фильтра мы сначала должны определить List всех возможных моделей. Для этого примера я создаю List на ExampleModel случаи из массив фильмов:

private static final String[] MOVIES = new String[]{
        ...
};

private static final Comparator<ExampleModel> ALPHABETICAL_COMPARATOR = new Comparator<ExampleModel>() {
    @Override
    public int compare(ExampleModel a, ExampleModel b) {
        return a.getText().compareTo(b.getText());
    }
};

private ExampleAdapter mAdapter;
private List<ExampleModel> mModels;
private RecyclerView mRecyclerView;

    @Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    mBinding = DataBindingUtil.setContentView(this, R.layout.activity_main);

    mAdapter = new ExampleAdapter(this, ALPHABETICAL_COMPARATOR);

    mBinding.recyclerView.setLayoutManager(new LinearLayoutManager(this));
    mBinding.recyclerView.setAdapter(mAdapter);

    mModels = new ArrayList<>();
    for (String movie : MOVIES) {
        mModels.add(new ExampleModel(movie));
    }
    mAdapter.add(mModels);
}

ничего особенного здесь не происходит, мы просто создаем экземпляр Adapter и RecyclerView. После этого мы создаем List моделей из названий фильмов в MOVIES массив. Затем мы добавляем все модели SortedList.

теперь мы можем вернуться к onQueryTextChange() который мы определили ранее и начинаем реализовывать логику фильтра:

@Override
public boolean onQueryTextChange(String query) {
    final List<ExampleModel> filteredModelList = filter(mModels, query);
    mAdapter.replaceAll(filteredModelList);
    mBinding.recyclerView.scrollToPosition(0);
    return true;
}

это снова довольно прямо вперед. Мы вызываем метод filter() и проходите в List на ExampleModels, а также строка запроса. Затем мы вызываем replaceAll() на Adapter и пройти в фильтрованный List возвращено filter(). Мы также должны позвонить scrollToPosition(0) на RecyclerView чтобы убедиться, что пользователь всегда может видеть все элементы при поиске чего-то. В противном случае RecyclerView может оставаться в прокрученном вниз положении во время фильтрации и впоследствии скрыть несколько элементов. Прокрутка вверх обеспечивает лучший пользовательский интерфейс во время испытующий.

единственное, что осталось сделать сейчас, чтобы реализовать :

private static List<ExampleModel> filter(List<ExampleModel> models, String query) {
    final String lowerCaseQuery = query.toLowerCase();

    final List<ExampleModel> filteredModelList = new ArrayList<>();
    for (ExampleModel model : models) {
        final String text = model.getText().toLowerCase();
        if (text.contains(lowerCaseQuery)) {
            filteredModelList.add(model);
        }
    }
    return filteredModelList;
}

первое, что мы делаем здесь-это вызов toLowerCase() в строке запроса. Мы не хотим, чтобы наша функция поиска учитывала регистр и вызывала toLowerCase() на всех строках мы сравниваем мы можем гарантировать, что мы возвращаем те же результаты независимо от случая. Затем он просто повторяет все модели в List мы прошли в нее и проверяет, если строка запроса содержится в текст модели. Если это так, то модель добавляется к фильтруемому List.

и это все! Приведенный выше код будет работать на уровне API 7 и выше, и начиная с уровня API 11 вы получаете анимацию элементов бесплатно!

я понимаю, что это очень подробное описание, которое, вероятно, делает все это более сложным, чем на самом деле, но есть способ обобщить всю эту проблему и сделать реализацию Adapter на основе SortedList гораздо проще.

---

обобщение проблемы и упрощение адаптера

в этом разделе я не буду вдаваться в подробности-отчасти потому, что я сталкиваюсь с ограничением символов для ответов на переполнение стека, но также и потому, что большинство из них уже объяснено выше, но чтобы суммировать изменения: мы можем реализовать базу Adapter класс, который уже заботится о решении SortedList а также привязка моделей к ViewHolder экземпляров и обеспечивает удобный способ реализации Adapter на основе SortedList. Для этого мы должны сделать две вещи:

• нам нужно создать ViewModel интерфейс, который все классы моделей должны реализовать
• нам нужно создать ViewHolder подкласс, который определяет a bind() метод Adapter можно использовать для автоматической привязки моделей.

это позволяет нам просто сосредоточиться на содержании, которое должно отображаться в RecyclerView by просто реализуя модели и там соответствующие ViewHolder реализаций. Используя этот базовый класс, нам не нужно беспокоиться о сложных деталях Adapter и SortedList.

SortedListAdapter

из-за ограничения символов для ответов на StackOverflow я не могу пройти каждый шаг реализации этого базового класса или даже добавить полный исходный код здесь, но вы можете найти полный исходный код этого базового класса - я назвал его SortedListAdapter - in это GitHub Gist.

чтобы сделать вашу жизнь простой я опубликовал библиотеку на jCenter, которая содержит SortedListAdapter! Если вы хотите использовать его, то все, что вам нужно сделать, это добавить эту зависимость для построения вашего приложения.файл gradle:

compile 'com.github.wrdlbrnft:sorted-list-adapter:0.2.0.1'

вы можете найти дополнительную информацию об этой библиотеке на главной странице библиотеки.

с помощью SortedListAdapter

использовать элемент SortedListAdapter мы должны сделать два изменения:

• изменить ViewHolder так, что он простирается SortedListAdapter.ViewHolder. Параметр type должен быть моделью, которая должна быть привязана к этому ViewHolder - в данном случае ExampleModel. Вы должны привязать данные к вашим моделям в performBind() вместо bind().

  public class ExampleViewHolder extends SortedListAdapter.ViewHolder<ExampleModel> {
  
      private final ItemExampleBinding mBinding;
  
      public ExampleViewHolder(ItemExampleBinding binding) {
          super(binding.getRoot());
          mBinding = binding;
      }
  
      @Override
      protected void performBind(ExampleModel item) {
          mBinding.setModel(item);
      }
  }
  

• убедитесь, что все ваши модели реализации ViewModel интерфейс:

  public class ExampleModel implements SortedListAdapter.ViewModel {
      ...
  }
  

после что мы просто должны обновить ExampleAdapter направить SortedListAdapter и удалить все, что нам больше не нужно. Параметр type должен быть типом модели, с которой вы работаете-в этом случае ExampleModel. Но если вы работаете с различными типами моделей, установите параметр типа ViewModel.

public class ExampleAdapter extends SortedListAdapter<ExampleModel> {

    public ExampleAdapter(Context context, Comparator<ExampleModel> comparator) {
        super(context, ExampleModel.class, comparator);
    }

    @Override
    protected ViewHolder<? extends ExampleModel> onCreateViewHolder(LayoutInflater inflater, ViewGroup parent, int viewType) {
        final ItemExampleBinding binding = ItemExampleBinding.inflate(inflater, parent, false);
        return new ExampleViewHolder(binding);
    }

    @Override
    protected boolean areItemsTheSame(ExampleModel item1, ExampleModel item2) {
        return item1.getId() == item2.getId();
    }

    @Override
    protected boolean areItemContentsTheSame(ExampleModel oldItem, ExampleModel newItem) {
        return oldItem.equals(newItem);
    }
}

после этого мы закончим! Однако последнее, что нужно отметить:SortedListAdapter не имеет то же самое add(),remove() или replaceAll() методы наши оригинальные ExampleAdapter имел. Он использует отдельный Editor объект для изменения элементов в списке, которые могут быть доступны через edit() метод. Так что если вы хотите удалить или добавить элементы, которые вы должны называть edit() затем добавить и удалить элементы на этом Editor экземпляр и как только вы закончите, позвони commit() на нем применить изменения к SortedList:

mAdapter.edit()
        .remove(modelToRemove)
        .add(listOfModelsToAdd)
        .commit();

все изменения, которые вы делаете таким образом, объединяются вместе для повышения производительности. Элемент replaceAll() метод, который мы реализовали в главах выше также присутствует на этом :

mAdapter.edit()
        .replaceAll(mModels)
        .commit();

если вы забыли назвать commit() тогда ни одно из ваших изменений не будет применено!