Сортировка списков в Java
Для возможности сортировки объектов в коллекциях наследниках List в Java существует статический метод класса java.util.Collections .
Это значит вы можете сортировать элементы таких классов как ArrayList, LinkedList, CopyOnWriteArrayList и других классов, имплементирующих интерфейс List .
В общем виде, если у вас есть список из строк:
то после сортировки получите в списке порядок:
Простое использование метода sort() #
Если у нас в списке находятся объекты классов, которые известно как сравнить, то достаточно просто вызвать метод sort() и передать туда список. Таким образом в списке элементы поменяют порядок и будут отсортированы в порядке возрастания
//создание списка на основе массива var stringList = Arrays.asList("z", "b", "c", "a", "k", "z"); System.out.println(stringList); //сортировка списка в порядке возрастания Collections.sort(stringList); System.out.println(stringList); Так мы можем сортировать множество стандартных классов, таких как String, Integer, Double, Character и множество других.
Если более точно выразиться, то без дополнительных параметров возможно отсортировать список из любых элементов, классы которых имплементируют интерфейс сравнения Comparable .
Сортировка в обратном порядке #
Если мы хотим сортировать элементы в обратном порядке. То для этого передадим дополнительный аргумент в метод сортировки:
//создание списка на основе массива var stringList = Arrays.asList("z", "b", "c", "a", "k", "z"); System.out.println(stringList); //сортировка списка в обратном направлении Collections.sort(stringList, Collections.reverseOrder()); System.out.println(stringList); Добавляем возможность сортировки своих классов #
Если стандартные классы уже готовы к сортировке, то если мы напишем свой класс, то Java не знает как есть сравнивать с объектами этого же класса.
Чтобы научить сравнивать объекты есть два варианта:
- создать класс на основе Comparator и там прописать правила сравнения в методе int compare(T o1, T o2) . Полученный объект из класса использовать всегда, когда нам надо сортировать объекты. Такой вариант отлично подходит, когда нам надо сортировать объекты по разным правилам и можем использовать нужный нам класс Comparator.
- добавить в класс (являющимся, элементом списка) имплементацию интерфейса Comparable и прописать правила сравнения в методе int compareTo(T o) . Тогда не потребуется указывать каждый раз компаратор, данное правило сравнение будет по-умолчанию для этого объекта.
Оба метода возвращают целое число, которое обычно интерпретируется так:
- число больше 0 -> объект с которым сравнивают больше текущего
- число равно 0 -> объекты одинаковые
- число меньше 0 -> объект с которым сравнивают меньше текущего
Создадим свой класс, например для студента:
class Student private final String name; private final double avgMark; public Student(String name, double avgMark) this.name = name; this.avgMark = avgMark; > @Override public String toString() return " + name + '\'' + ", m=" + avgMark + '>'; > > Класс специально минимально простой: все параметры задаются в конструкторе, и используются значения только для печати данных при вызове toString, что поможет нам в визуализации результата.
Для начала, посмотрим, что будет если мы попробуем отсортировать список из студентов:
var ivan = new Student("Иван", 4.3); var olga = new Student("Ольга", 3.8); var eugene = new Student("Женя", 4.9); var studentList = Arrays.asList(ivan, olga, eugene); System.out.println(studentList); //сортировка списка Collections.sort(studentList); System.out.println(studentList); Такой код не скомпилируется, так как метод sort() не просто ожидает список, но еще важно, чтобы элемент списка был наследником Comparable:
public static T extends Comparable super T>> void sort(ListT> list) list.sort(null); > Использование Comparable #
Для создания возможности сортировки, нам необходимо научить сравнить объекты с другими такого-же типа. И такая реализация будет использоваться по-умолчанию при сравнении объектов одного класса.
Имплементируем Comparable интерфейс, и реализуем метод compareTo:
class Student implements ComparableStudent> private final String name; private final double avgMark; public Student(String name, double avgMark) this.name = name; this.avgMark = avgMark; > @Override public String toString() return " + name + '\'' + ", m=" + avgMark + '>'; > @Override public int compareTo(Student o) return name.compareTo(o.name); > > Обратите внимание, внутри метод мы решили сравнить две строки, а так как у String есть реализация Comparable — мы можем ее использовать.
В данном коде опущены части, с проверкой на null объектов o и полей класса.
Давайте проверим, как это будет работать:
var ivan = new Student("Иван", 4.3); var olga = new Student("Ольга", 3.8); var eugene = new Student("Женя", 4.9); var studentList = Arrays.asList(ivan, olga, eugene); System.out.println(studentList); //сортировка списка Collections.sort(studentList); System.out.println(studentList); Все отлично, список отсортирован по полю name .
Вы можете делать более сложные условия сравнения, только не забывайте учитывать требование для успешной сортировки — два объекта, сколько бы мы их не сравнивали — должны всегда давать одинаковый результат.
Использование Comparator #
А что если нам надо сортировать студентов не по имени, а по средней оценке? И при этом оставить возможность сортировать по имени, которое должна использоваться по умолчанию для создания различных документов.
Нам на помощь придет отдельный класс Comparator , которые хранит в себе логику сравнения объектов и при сортировке, мы можем использовать нужное правило, то есть нужный объект класса Comparator .
Для начала добавим в класс Student геттеры, так как нам уже необходимо использовать данные класса в классе компаратора.
class Student implements ComparableStudent> private final String name; private final double avgMark; public Student(String name, double avgMark) this.name = name; this.avgMark = avgMark; > @Override public String toString() return " + name + '\'' + ", m=" + avgMark + '>'; > @Override public int compareTo(Student o) return name.compareTo(o.name); > public String getName() return name; > public double getAvgMark() return avgMark; > > и теперь создадим класс Comparator , тип для сравнения Student :
class ComparatorByAvgMark implements ComparatorStudent> @Override public int compare(Student o1, Student o2) return Double.compare(o1.getAvgMark(), o2.getAvgMark()); > > Мы снова использовали готовый метод для сравнения стандартного класса Double , это помогает не выдумывать свои реализации, а использовать уже существующие.
Также снова опущены проверки на null объектов o1, o2.
Теперь можно использовать данный класс, и в этот раз нам пригодится перегруженный метод Collections.sort() , который принимает компаратор:
var ivan = new Student("Иван", 4.3); var olga = new Student("Ольга", 3.8); var eugene = new Student("Женя", 4.9); var studentList = Arrays.asList(ivan, olga, eugene); System.out.println(studentList); //сортировка списка c использованием компаратора Collections.sort(studentList, new ComparatorByAvgMark()); System.out.println(studentList); И мы видим — сортировка по возрастанию средней оценки студента.
Хорошо, давайте сделаем обратную сортировку, высокие оценки должны быть в начале списка. Для этого нам потребуется изменить поведение компаратора, и для этого у компаратора есть метод reversed() :
Collections.sort(studentList, new ComparatorByAvgMark().reversed()); и в итоге получим нужный результат:
Но это еще не все что может компаратор, можно создавать цепочки. Например, сначала сортируем по оценкам, а если оценки одинаковые, то по имени.
Это можно реализовать не создавая отдельного класса, а воспользоваться функцией:
Collections.sort(studentList, new ComparatorByAvgMark().reversed() .thenComparing(Student::getName)); При такой сортировки, оценки будут в порядке убывания, а внутри одной средней оценки, студенты будут по имени в порядке возрастания.
Метод sort() у самого списка #
Кроме использования метода Collections.sort() , можно вызывать похожий метод у самого списка List.sort() . Метод принимает один аргумент — компаратор.
На примере списка студентов:
studentList.sort(new ComparatorByAvgMark()); Пример сортировки с помощью Java Comparable и Comparator
Java предоставляет встроенные методы для сортировки массива примитивных типов, объектов, массивов и списков. В этой статье мы разберем различные способы сортировки используя java.lang.Comparable и java.util.Comparator .
Для начала давайте посмотрим пример сортировки примитивных типов и пример сортировки массива объектом в программе ниже:
В результате получим следующий вывод в консоль:
Так, а теперь давайте попробуем отсортировать массив объектов нашего собственного класса:
Ниже показан фрагмент кода для сортировки массива объектов Employee:
System . out . println ( «Стандартная сортировка для массива объектов Employee:\n» + Arrays . toString ( empArr ) ) ;
Теперь запустим программу и получим ошибку:
Exception in thread «main» java . lang . ClassCastException : ua . com . prologistic . Employee cannot be cast to java . lang . Comparable
В чем причина? Дело в том, что если пользовательский класс в Java хочет использовать встроенные методы сортировки классов Arrays или Collections , то он должен реализовать интерфейс Comparable. Этот интерфейс предоставляет метод compareTo(T obj) , который используется методами сортировки. Вы можете убедиться в этом сами, просто посмотрев на реализацию классов String или Date .
Для того, чтобы избежать этой ошибки мы должны переопределить метод compareTo(T obj) таким образом, чтобы он возвращал отрицательное число, ноль или положительное целое число, если «этот» объект меньше, равен или больше объекта, переданного в качестве аргумента.
После реализации интерфейса Comparable класс Employee изменится следующим образом:
return «[id crayon-h»> + this . id + «, name crayon-h»> + this . name + «, age crayon-h»> + this . age + «, salary crayon-h»> + this . salary + «]» ;
Теперь, когда мы запустим этот код, то получим в консоль вывод отсортированного массива в читабельном виде:
[ [ id = 1 , name = Alex , age = 32 , salary = 50000 ] , [ id = 5 , name = Viktor , age = 35 , salary = 5000 ] , [ id = 10 , name = Andrew , age = 25 , salary = 10000 ] , [ id = 20 , name = Dmitriy , age = 29 , salary = 20000 ] ]Как видно из вывода в консоль, массив объектов Employee отсортирован по id в порядке возрастания.
Но в большинстве реальных проектов нужно несколько вариантов сортировки с различными параметрами, а не только id. Например можно отсортировать служащих по уровню заработной платы или по возрасту.
С помощью метода Comparable.compareTo(Object o) можно отсортировать объекты только по одному полю. Вот для таких вот ситуаций лучше всего использовать компаратор.
Метод компаратора compare(Object o1, Object o2) принимает два объекта в качестве аргумента и должен быть реализован таким образом, чтобы возвращать отрицательное число — если первый аргумент меньше второго, ноль — если они равны и положительное число, если первый аргумент больше, чем второй.
Оба интерфейса Comparable и Comparator использует дженерики.
Давайте посмотрим на реализацию компаратора в классе Employee: