WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Comparator.comparing — Objekte anhand eines Schlüssels vergleichen

Erzeuge einen Komparator für Objekte anhand eines Schlüssels. Verwende die natürliche Schlüsselreihenfolge oder gib einen eigenen Komparator an, der auch die Position von `null`-Schlüsseln festlegt.

Version: Java SE 21

Syntax

import java.util.Comparator;
import java.util.function.Function;

// Static method signatures on java.util.Comparator (Java SE 21)
static <T, U extends Comparable<? super U>> Comparator<T> comparing(Function<? super T, ? extends U> keyExtractor)
static <T, U> Comparator<T> comparing(Function<? super T, ? extends U> keyExtractor, Comparator<? super U> keyComparator)

In Java SE 21 ist Comparator.comparing eine statische Methode der Schnittstelle java.util.Comparator. Comparator.comparing() ist im Text eine Kurzschreibweise für den Methodennamen, kein gültiger Aufruf ohne Argumente. Die Methode liefert einen Comparator<T> zurück und sortiert selbst nichts. Wenn der zurückgegebene Komparator zwei Objekte vom Typ T vergleicht, ermittelt er aus jedem einen Schlüssel vom Typ U und vergleicht diese Schlüssel.

Die Überladung mit einem Argument verwendet die natürliche Reihenfolge der Schlüssel. Daher muss U Comparable<? super U> implementieren. Die Methodenreferenz Ticket::getId dient zur Schlüsselextraktion: Für ein Ticket liefert sie dessen ID vom Typ String. Die natürliche Reihenfolge von String ist lexikografisch, nicht numerisch. Deshalb steht T10 vor T2.

Die Überladung mit zwei Argumenten vergleicht die Schlüssel mit dem übergebenen Komparator. U muss dabei nicht Comparable implementieren. Bei beiden Überladungen führt null als Methodenargument zu einer NullPointerException. Ein Schlüssel, den die Extraktionsfunktion zurückgibt, ist etwas anderes: Die Variante mit einem Argument unterstützt keine null-Schlüssel. Bei der Variante mit zwei Argumenten ordnet Comparator.nullsLast(Comparator.naturalOrder()) null-Schlüssel hinter allen anderen ein. Das schützt nicht vor einem null-Element in der Liste: Ticket::getId würde weiterhin versuchen, eine Methode auf null aufzurufen. Können auch Elemente null sein, umschließe den gesamten Ticket-Komparator mit Comparator.nullsLast.

Beispiele

import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.StringJoiner;

public class Main {
    static final class Ticket {
        private final String id;

        Ticket(String id) {
            this.id = id;
        }

        String getId() {
            return id;
        }
    }

    private static void printIds(List<Ticket> tickets) {
        StringJoiner ids = new StringJoiner(", ", "[", "]");
        for (Ticket ticket : tickets) {
            ids.add(String.valueOf(ticket.getId()));
        }
        System.out.println(ids.toString());
    }

    public static void main(String[] args) {
        List<Ticket> tickets = new ArrayList<>(List.of(
                new Ticket("T2"), new Ticket("T10")));

        Comparator<Ticket> byId = Comparator.comparing(Ticket::getId);
        tickets.sort(byId);
        printIds(tickets);

        tickets.add(0, new Ticket(null));
        Comparator<Ticket> byIdNullsLast = Comparator.comparing(
                Ticket::getId, Comparator.nullsLast(Comparator.naturalOrder()));
        tickets.sort(byIdNullsLast);
        printIds(tickets);
    }
}

Ergebnis

[T10, T2]
[T10, T2, null]

`List.sort` ändert die Reihenfolge der Listenelemente. Die erste Sortierung verwendet die natürliche Reihenfolge der IDs vom Typ `String`. Vor der zweiten Sortierung wird ein `Ticket` mit der ID `null` am Anfang eingefügt; die zweite Sortierung verschiebt es ans Ende.

Zugehörige Lektionen

  • Java · Lektion 42 · Grundlagen · Version: 2
  • Java · Lektion 48 · Grundlagen · Version: 2
  • Java · Lektion 35 · Mittlere Stufe · Version: 2

Quellen