Java 8: potente comparación con Lambdas

1. Información general

En este tutorial, vamos a echar un primer vistazo al soporte de Lambda en Java 8, específicamente a cómo aprovecharlo para escribir el Comparador y ordenar una Colección .

Este artículo es parte de la serie "Java - Back to Basic" aquí en Baeldung.

Primero, definamos una clase de entidad simple:

public class Human { private String name; private int age; // standard constructors, getters/setters, equals and hashcode } 

2. Orden básico sin lambdas

Antes de Java 8, ordenar una colección implicaría crear una clase interna anónima para el Comparador usado en la ordenación:

new Comparator() { @Override public int compare(Human h1, Human h2) { return h1.getName().compareTo(h2.getName()); } }

Esto simplemente se usaría para ordenar la Lista de entidades humanas :

@Test public void givenPreLambda_whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); Collections.sort(humans, new Comparator() { @Override public int compare(Human h1, Human h2) { return h1.getName().compareTo(h2.getName()); } }); Assert.assertThat(humans.get(0), equalTo(new Human("Jack", 12))); }

3. Orden básico con compatibilidad con Lambda

Con la introducción de Lambdas, ahora podemos omitir la clase interna anónima y lograr el mismo resultado con una semántica simple y funcional :

(final Human h1, final Human h2) -> h1.getName().compareTo(h2.getName());

De manera similar, ahora podemos probar el comportamiento como antes:

@Test public void whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); humans.sort( (Human h1, Human h2) -> h1.getName().compareTo(h2.getName())); assertThat(humans.get(0), equalTo(new Human("Jack", 12))); }

Tenga en cuenta que también estamos usando la nueva API de clasificación agregada a java.util.List en Java 8 , en lugar de la antigua API Collections.sort .

4. Clasificación básica sin definiciones de tipo

Podemos simplificar aún más la expresión al no especificar las definiciones de tipo; el compilador es capaz de inferirlas por sí mismo:

(h1, h2) -> h1.getName().compareTo(h2.getName())

Y nuevamente, la prueba sigue siendo muy similar:

@Test public void givenLambdaShortForm_whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); humans.sort((h1, h2) -> h1.getName().compareTo(h2.getName())); assertThat(humans.get(0), equalTo(new Human("Jack", 12))); }

5. Ordenar usando referencia al método estático

A continuación, realizaremos la ordenación utilizando una expresión Lambda con una referencia a un método estático.

Primero, vamos a definir el método compareByNameThenAge , con la misma firma exacta que el método de comparación en un objeto Comparator :

public static int compareByNameThenAge(Human lhs, Human rhs) { if (lhs.name.equals(rhs.name)) { return Integer.compare(lhs.age, rhs.age); } else { return lhs.name.compareTo(rhs.name); } }

Ahora, vamos a llamar al método humans.sort con esta referencia:

humans.sort(Human::compareByNameThenAge);

El resultado final es una clasificación funcional de la colección utilizando el método estático como Comparador :

@Test public void givenMethodDefinition_whenSortingEntitiesByNameThenAge_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); humans.sort(Human::compareByNameThenAge); Assert.assertThat(humans.get(0), equalTo(new Human("Jack", 12))); }

6. Clasifique los comparadores extraídos

También podemos evitar definir incluso la lógica de comparación mediante el uso de una referencia de método de instancia y el método de comparación Comparator.comparing , que extrae y crea un Comparable basado en esa función.

Vamos a utilizar el getter getName () para construir la expresión Lambda y ordenar la lista por nombre:

@Test public void givenInstanceMethod_whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); Collections.sort( humans, Comparator.comparing(Human::getName)); assertThat(humans.get(0), equalTo(new Human("Jack", 12))); }

7. Orden inverso

JDK 8 también ha introducido un método auxiliar para revertir el comparador ; podemos hacer un uso rápido de eso para revertir nuestra clasificación:

@Test public void whenSortingEntitiesByNameReversed_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 10), new Human("Jack", 12) ); Comparator comparator = (h1, h2) -> h1.getName().compareTo(h2.getName()); humans.sort(comparator.reversed()); Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10))); }

8. Ordenar con múltiples condiciones

Las expresiones lambda de comparación no necesitan ser tan simples; también podemos escribir expresiones más complejas , por ejemplo, ordenando las entidades primero por nombre y luego por edad:

@Test public void whenSortingEntitiesByNameThenAge_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 12), new Human("Sarah", 10), new Human("Zack", 12) ); humans.sort((lhs, rhs) -> { if (lhs.getName().equals(rhs.getName())) { return Integer.compare(lhs.getAge(), rhs.getAge()); } else { return lhs.getName().compareTo(rhs.getName()); } }); Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10))); }

9. Ordenar con varias condiciones: composición

La misma lógica de comparación, primero ordenar por nombre y luego, en segundo lugar, por edad, también puede implementarse mediante el nuevo soporte de composición para Comparator .

Comenzando con JDK 8, ahora podemos encadenar múltiples comparadores para construir una lógica de comparación más compleja:

@Test public void givenComposition_whenSortingEntitiesByNameThenAge_thenCorrectlySorted() { List humans = Lists.newArrayList( new Human("Sarah", 12), new Human("Sarah", 10), new Human("Zack", 12) ); humans.sort( Comparator.comparing(Human::getName).thenComparing(Human::getAge) ); Assert.assertThat(humans.get(0), equalTo(new Human("Sarah", 10))); }

10. Ordenar una lista con Stream.sorted ()

También podemos ordenar una colección usando la API Stream sorted () de Java 8 .

Podemos clasificar la secuencia utilizando el orden natural, así como el orden proporcionado por un Comparador. Para esto, tenemos dos variantes sobrecargadas de la API sorted () :

  • sort ed () : ordena los elementos de una secuencia usando el orden natural; la clase de elemento debe implementar la interfaz Comparable .
  • sorted(Comparator super T> comparator) – sorts the elements based on a Comparator instance

Let's see an example of how to use the sorted() method with natural ordering:

@Test public final void givenStreamNaturalOrdering_whenSortingEntitiesByName_thenCorrectlySorted() { List letters = Lists.newArrayList("B", "A", "C"); List sortedLetters = letters.stream().sorted().collect(Collectors.toList()); assertThat(sortedLetters.get(0), equalTo("A")); }

Now let's see how we can use a custom Comparator with the sorted() API:

@Test public final void givenStreamCustomOrdering_whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12)); Comparator nameComparator = (h1, h2) -> h1.getName().compareTo(h2.getName()); List sortedHumans = humans.stream().sorted(nameComparator).collect(Collectors.toList()); assertThat(sortedHumans.get(0), equalTo(new Human("Jack", 12))); }

We can simplify the above example even further if we use the Comparator.comparing() method:

@Test public final void givenStreamComparatorOrdering_whenSortingEntitiesByName_thenCorrectlySorted() { List humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12)); List sortedHumans = humans.stream() .sorted(Comparator.comparing(Human::getName)) .collect(Collectors.toList()); assertThat(sortedHumans.get(0), equalTo(new Human("Jack", 12))); }

11. Sorting a List in Reverse With Stream.sorted()

We can also use Stream.sorted() to sort a collection in reverse.

First, let's see an example of how to combine the sorted() method with Comparator.reverseOrder() to sort a list in the reverse natural order:

@Test public final void givenStreamNaturalOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() { List letters = Lists.newArrayList("B", "A", "C"); List reverseSortedLetters = letters.stream() .sorted(Comparator.reverseOrder()) .collect(Collectors.toList()); assertThat(reverseSortedLetters.get(0), equalTo("C")); }

Now, let's see how we can use the sorted() method and a custom Comparator:

@Test public final void givenStreamCustomOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() { List humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12)); Comparator reverseNameComparator = (h1, h2) -> h2.getName().compareTo(h1.getName()); List reverseSortedHumans = humans.stream().sorted(reverseNameComparator) .collect(Collectors.toList()); assertThat(reverseSortedHumans.get(0), equalTo(new Human("Sarah", 10))); }

Note that the invocation of compareTo is flipped, which is what is doing the reversing.

Finally, let's simplify the above example by using the Comparator.comparing() method:

@Test public final void givenStreamComparatorOrdering_whenSortingEntitiesByNameReversed_thenCorrectlySorted() { List humans = Lists.newArrayList(new Human("Sarah", 10), new Human("Jack", 12)); List reverseSortedHumans = humans.stream() .sorted(Comparator.comparing(Human::getName, Comparator.reverseOrder())) .collect(Collectors.toList()); assertThat(reverseSortedHumans.get(0), equalTo(new Human("Sarah", 10))); }

12. Null Values

So far, we implemented our Comparators in a way that they can't sort collections containing null values. That is, if the collection contains at least one null element, then the sort method throws a NullPointerException:

@Test(expected = NullPointerException.class) public void givenANullElement_whenSortingEntitiesByName_thenThrowsNPE() { List humans = Lists.newArrayList(null, new Human("Jack", 12)); humans.sort((h1, h2) -> h1.getName().compareTo(h2.getName())); }

The simplest solution is to handle the null values manually in our Comparator implementation:

@Test public void givenANullElement_whenSortingEntitiesByNameManually_thenMovesTheNullToLast() { List humans = Lists.newArrayList(null, new Human("Jack", 12), null); humans.sort((h1, h2) -> { if (h1 == null) { return h2 == null ? 0 : 1; } else if (h2 == null) { return -1; } return h1.getName().compareTo(h2.getName()); }); Assert.assertNotNull(humans.get(0)); Assert.assertNull(humans.get(1)); Assert.assertNull(humans.get(2)); }

Here we're pushing all null elements towards the end of the collection. To do that, the comparator considers null to be greater than non-null values. When both are null, they are considered equal.

Additionally, we can pass any Comparator that is not null-safe into the Comparator.nullsLast() method and achieve the same result:

@Test public void givenANullElement_whenSortingEntitiesByName_thenMovesTheNullToLast() { List humans = Lists.newArrayList(null, new Human("Jack", 12), null); humans.sort(Comparator.nullsLast(Comparator.comparing(Human::getName))); Assert.assertNotNull(humans.get(0)); Assert.assertNull(humans.get(1)); Assert.assertNull(humans.get(2)); }

Similarly, we can use Comparator.nullsFirst() to move the null elements towards the start of the collection:

@Test public void givenANullElement_whenSortingEntitiesByName_thenMovesTheNullToStart() { List humans = Lists.newArrayList(null, new Human("Jack", 12), null); humans.sort(Comparator.nullsFirst(Comparator.comparing(Human::getName))); Assert.assertNull(humans.get(0)); Assert.assertNull(humans.get(1)); Assert.assertNotNull(humans.get(2)); } 

It's highly recommended to use the nullsFirst() or nullsLast() decorators, as they're more flexible and, above all, more readable.

13. Conclusion

This article illustrated the various and exciting ways that a List can be sorted using Java 8 Lambda Expressions – moving right past syntactic sugar and into real and powerful functional semantics.

The implementation of all these examples and code snippets can be found over on GitHub.