Sortowanie z porównaniem i komparatorem w Javie

Programiści często muszą sortować elementy z bazy danych do kolekcji, tablicy lub mapy. W Javie możemy zaimplementować dowolny algorytm sortowania z dowolnym typem. Korzystając z Comparableinterfejsu i compareTo()metody, możemy sortować według kolejności alfabetycznej, Stringdługości, odwrotnej kolejności alfabetycznej lub liczb. ComparatorInterfejs pozwala nam zrobić to samo, ale w sposób bardziej elastyczny.

Cokolwiek chcemy zrobić, musimy tylko wiedzieć, jak zaimplementować poprawną logikę sortowania dla danego interfejsu i typu.

Pobierz kod źródłowy

Uzyskaj kod dla tego programu Java Challenger. Możesz przeprowadzić własne testy, postępując zgodnie z przykładami.

Sortowanie listy Java za pomocą obiektu niestandardowego

W naszym przykładzie użyjemy tego samego POJO, którego używaliśmy do tej pory w innych Java Challengers. W tym pierwszym przykładzie implementujemy interfejs Comparable w Simpsonklasie, używając Simpsonw typie ogólnym:

 class Simpson implements Comparable { String name; Simpson(String name) { this.name = name; } @Override public int compareTo(Simpson simpson) { return this.name.compareTo(simpson.name); } } public class SimpsonSorting { public static void main(String... sortingWithList) { List simpsons = new ArrayList(); simpsons.add(new SimpsonCharacter("Homer ")); simpsons.add(new SimpsonCharacter("Marge ")); simpsons.add(new SimpsonCharacter("Bart ")); simpsons.add(new SimpsonCharacter("Lisa ")); Collections.sort(simpsons); simpsons.stream().map(s -> s.name).forEach(System.out::print); Collections.reverse(simpsons); simpsons.stream().forEach(System.out::print); } } 

Zauważ, że nadpisaliśmy metodę compareTo () i przekazaliśmy do innego Simpsonobiektu. Zrezygnowaliśmy również z toString()metody, aby przykład był bardziej czytelny.

Te toStringmetody wykazuje wszelkie informacje od obiektu. Kiedy drukujemy obiekt, wynik będzie taki, jaki został zaimplementowany toString().

Metoda compareTo ()

compareTo()Sposób porównuje dany przedmiot albo bieżące wystąpienie z danego obiektu w celu ustalenia kolejności przedmiotów. Oto krótkie spojrzenie na to, jak to compareTo()działa:

  Jeśli porównanie zwróci

  Następnie ...

  >= 1

  this.name > simpson.name

  0

  this.name == simpson.name

  <= -1

  this.name < simpson.name

Możemy używać tylko klas porównywalnych z sort()metodą. Jeśli spróbujemy przekazać a, Simpsonktóre nie implementuje Comparable, otrzymamy błąd kompilacji.

sort()Metoda wykorzystuje polimorfizmu przepuszczając dowolny obiekt, który jest Comparable. Obiekty zostaną następnie posortowane zgodnie z oczekiwaniami.

Wynik z poprzedniego kodu wyglądałby następująco:

 Bart Homer Lisa Marge 

Gdybyśmy chcieli odwrócić kolejność, moglibyśmy wymienić sort()na reverse(); od:

 Collections.sort(simpsons); 

do:

 Collections.reverse(simpsons); 

Wdrożenie reverse()metody zmieniłoby poprzednie dane wyjściowe na:

 Marge Lisa Homer Bart 

Sortowanie tablicy Java

W Javie możemy sortować tablice dowolnego typu, o ile implementuje Comparableinterfejs. Oto przykład:

 public class ArraySorting { public static void main(String... moeTavern) { int[] moesPints = new int[] {9, 8, 7, 6, 1}; Arrays.sort(moesPints); Arrays.stream(moesPints).forEach(System.out::print); Simpson[] simpsons = new Simpson[]{new Simpson("Lisa"), new Simpson("Homer")}; Arrays.sort(simpsons); Arrays.stream(simpsons).forEach(System.out::println); } } 

W pierwszym sort()wywołaniu tablica jest sortowana do:

 1 6 7 8 9 

W drugim sort()wywołaniu jest sortowany do:

 Homer Lisa 

Keep in mind that custom objects must implement Comparable in order to be sorted, even as an array.

Can I sort objects without Comparable?

If the Simpson object wasn’t implementing Comparable, a ClassCastException would be thrown. If you run this as a test, you will see something like the following output:

 Error:(16, 20) java: no suitable method found for sort(java.util.List) method java.util.Collections.sort(java.util.List) is not applicable (inference variable T has incompatible bounds equality constraints: com.javaworld.javachallengers.sortingcomparable.Simpson lower bounds: java.lang.Comparable) method java.util.Collections.sort(java.util.List,java.util.Comparator) is not applicable (cannot infer type-variable(s) T (actual and formal argument lists differ in length)) 

This log may be confusing, but don’t worry. Just keep in mind that a ClassCastException will be thrown for any sorted object that doesn’t implement the Comparable interface.

Sorting a Map with TreeMap

The Java API includes many classes to assist with sorting, including TreeMap. In the example below, we use TreeMap to sort keys into a Map.

 public class TreeMapExample { public static void main(String... barney) { Map simpsonsCharacters = new TreeMap(); simpsonsCharacters.put(new SimpsonCharacter("Moe"), "shotgun"); simpsonsCharacters.put(new SimpsonCharacter("Lenny"), "Carl"); simpsonsCharacters.put(new SimpsonCharacter("Homer"), "television"); simpsonsCharacters.put(new SimpsonCharacter("Barney"), "beer"); System.out.println(simpsonsCharacters); } } 

TreeMap uses the compareTo() method implemented by the Comparable interface. Each element in the resulting Map is sorted by its key. In this case, the output would be:

 Barney=beer, Homer=television, Lenny=Carl, Moe=shotgun 

Remember, though: if the object doesn’t implement Comparable, a ClassCastException will be thrown.

Sorting a Set with TreeSet

The Set interface is responsible for storing unique values, but when we use the TreeSet implementation, inserted elements will be automatically sorted as we add them:

 public class TreeSetExample { public static void main(String... barney) { Set simpsonsCharacters = new TreeSet(); simpsonsCharacters.add(new SimpsonCharacter("Moe")); simpsonsCharacters.add(new SimpsonCharacter("Lenny")); simpsonsCharacters.add(new SimpsonCharacter("Homer")); simpsonsCharacters.add(new SimpsonCharacter("Barney")); System.out.println(simpsonsCharacters); } } 

The output from this code is:

 Barney, Homer, Lenny, Moe 

Again, if we use an object that is not Comparable, a ClassCastException will be thrown.

Sorting with Comparator

What if we didn’t want to use the same compareTo() method from the POJO class? Could we override the Comparable method to use a different logic? Below is an example:

 public class BadExampleOfComparable { public static void main(String... args) { List characters = new ArrayList(); SimpsonCharacter homer = new SimpsonCharacter("Homer") { @Override public int compareTo(SimpsonCharacter simpson) { return this.name.length() - (simpson.name.length()); } }; SimpsonCharacter moe = new SimpsonCharacter("Moe") { @Override public int compareTo(SimpsonCharacter simpson) { return this.name.length() - (simpson.name.length()); } }; characters.add(homer); characters.add(moe); Collections.sort(characters); System.out.println(characters); } } 

As you can see, this code is complicated and includes a lot of repetition. We had to override the compareTo() method twice for the same logic. If there were more elements we would have to replicate the logic for each object.

Fortunately, we have the Comparator interface, which lets us detach the compareTo() logic from Java classes. Consider the same example above rewritten using Comparator:

 public class GoodExampleOfComparator { public static void main(String... args) { List characters = new ArrayList(); SimpsonCharacter homer = new SimpsonCharacter("Homer"); SimpsonCharacter moe = new SimpsonCharacter("Moe"); characters.add(homer); characters.add(moe); Collections.sort(characters, (Comparator. comparingInt(character1 -> character1.name.length()) .thenComparingInt(character2 -> character2.name.length()))); System.out.println(characters); } } 

These examples demonstrate the main difference between Comparable and Comparator.

Use Comparable when there is a single, default comparison for your object. Use Comparatorwhen you need to work around an existing compareTo(), or when you need to use specific logic in a more flexible way. Comparator detaches the sorting logic from your object and contains the compareTo() logic within your sort() method.

Using Comparator with an anonymous inner class

In this next example, we use an anonymous inner class to compare the value of objects. An anonymous inner class, in this case, is any class that implements Comparator. Using it means we are not bound to instantiating a named class implementing an interface; instead, we implement the compareTo() method inside the anonymous inner class.

 public class MarvelComparator { public static void main(String... comparator) { List marvelHeroes = new ArrayList(); marvelHeroes.add("SpiderMan "); marvelHeroes.add("Wolverine "); marvelHeroes.add("Xavier "); marvelHeroes.add("Cyclops "); Collections.sort(marvelHeroes, new Comparator() { @Override public int compare(String hero1, String hero2) { return hero1.compareTo(hero2); } }); Collections.sort(marvelHeroes, (m1, m2) -> m1.compareTo(m2)); Collections.sort(marvelHeroes, Comparator.naturalOrder()); marvelHeroes.forEach(System.out::print); } } 

More about inner classes

An anonymous inner class is simply any class whose name doesn’t matter, and which implements the interface we are declaring. So in the example, the new Comparator is actually the instantiation of a class that doesn’t have a name, which implements the method with the logic we want.

Using Comparator with lambda expressions

Anonymous inner classes are verbose, which can cause problems in our code. In the Comparator interface, we can use lambda expressions to simplify and make the code easier to read. For example, we could change this:

 Collections.sort(marvel, new Comparator() { @Override public int compare(String hero1, String hero2) { return hero1.compareTo(hero2); } }); 

to this:

 Collections.sort(marvel, (m1, m2) -> m1.compareTo(m2)); 

Less code and the same result!

The output of this code would be:

 Cyclops SpiderMan Wolverine Xavier 

We could make the code even simpler by changing this:

 Collections.sort(marvel, (m1, m2) -> m1.compareTo(m2)); 

to this:

 Collections.sort(marvel, Comparator.naturalOrder()); 

Lambda expressions in Java

Learn more about lambda expressions and other functional programming techniques in Java.

Are the core Java classes Comparable?

Many core Java classes and objects implement the Comparable interface, which means we don’t have to implement the compareTo() logic for those classes. Here are a few familiar examples:

String

 public final class String implements java.io.Serializable, Comparable, CharSequence { ... 

Integer

 public final class Integer extends Number implements Comparable { … 

Double

 public final class Double extends Number implements Comparable {... 

There are many others. I encourage you to explore the Java core classes to learn their important patterns and concepts.

Podejmij wyzwanie porównywalnego interfejsu!

Sprawdź, czego się nauczyłeś, obliczając wynik poniższego kodu. Pamiętaj, że najlepiej się nauczysz, jeśli sam rozwiążesz to wyzwanie, studiując je. Po uzyskaniu odpowiedzi możesz sprawdzić odpowiedź poniżej. Możesz także przeprowadzić własne testy, aby w pełni przyswoić sobie koncepcje.

 public class SortComparableChallenge { public static void main(String... doYourBest) { Set set = new TreeSet(); set.add(new Simpson("Homer")); set.add(new Simpson("Marge")); set.add(new Simpson("Lisa")); set.add(new Simpson("Bart")); set.add(new Simpson("Maggie")); List list = new ArrayList(); list.addAll(set); Collections.reverse(list); list.forEach(System.out::println); } static class Simpson implements Comparable { String name; public Simpson(String name) { this.name = name; } public int compareTo(Simpson simpson) { return simpson.name.compareTo(this.name); } public String toString() { return this.name; } } } 

Jaki jest wynik tego kodu?

 A) Bart Homer Lisa Maggie Marge B) Maggie Bart Lisa Marge Homer C) Marge Maggie Lisa Homer Bart D) Indeterminate