WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Defensives Kopieren von Collections

Kopiere eine Liste im Konstruktor und in `getRoles()`, damit Aufrufer die im DTO gespeicherte Liste nicht verändern können. `final` allein reicht nicht aus.

Version: Java SE 21

Syntax

private final List<String> roles;

RolesDto(List<String> roles) {
    this.roles = new ArrayList<>(roles);
}

public List<String> getRoles() {
    return new ArrayList<>(roles);
}

Defensives Kopieren von Collections schützt den Zustand eines Objekts vor Änderungen über eine gemeinsam genutzte Referenz. Der Konstruktor eines Datentransferobjekts (DTO) speichert new ArrayList<>(roles), statt die übergebene Liste zu behalten. Jeder Aufruf von getRoles() liefert eine neue, veränderbare Liste. Beide Kopien behalten die Reihenfolge der Elemente bei. final verhindert, dass dem Feld eine andere Liste zugewiesen wird, aber nicht, dass jemand die Liste selbst mit add oder set ändert.

new ArrayList<>(roles) erstellt eine flache Kopie: Die Listen sind eigenständige Objekte, verweisen aber auf dieselben Elemente. Bei String reicht das aus, weil Zeichenketten unveränderlich sind. Bei veränderlichen Elementen kann eine Zustandsänderung über beide Listen sichtbar sein. Muss auch dieser Zustand geschützt werden, kopiere ihn bei der Übergabe und bei der Rückgabe oder verwende unveränderliche Elementtypen.

Wenn Aufrufer das Ergebnis nicht bearbeiten müssen und null ausgeschlossen ist, kannst du im Konstruktor List.copyOf(roles) speichern und diese Liste direkt zurückgeben. Spätere Änderungen an der Quellliste erscheinen nicht im Ergebnis, und copyOf muss keine neue Instanz erzeugen. Änderungsmethoden des Ergebnisses werfen UnsupportedOperationException; bei einer Quelle oder einem Element mit dem Wert null tritt NullPointerException auf. Das Ergebnis bleibt flach. Dagegen liefert Collections.unmodifiableList(roles) eine nicht modifizierbare Sicht, keine Kopie: Änderungen an der Quellliste bleiben darüber sichtbar.

Beispiele

import java.util.ArrayList;
import java.util.List;

public class Main {
    static final class RolesDto {
        private final List<String> roles;

        RolesDto(List<String> roles) {
            this.roles = new ArrayList<>(roles);
        }

        public List<String> getRoles() {
            return new ArrayList<>(roles);
        }
    }

    public static void main(String[] args) {
        List<String> input = new ArrayList<>(List.of("reader"));
        RolesDto dto = new RolesDto(input);
        input.add("admin");

        List<String> returned = dto.getRoles();
        returned.set(0, "owner");

        System.out.println(input);
        System.out.println(returned);
        System.out.println(dto.getRoles());
    }
}

Ergebnis

[reader, admin]
[owner]
[reader]

`input.add("admin")` ändert nur die Eingabeliste, `returned.set(0, "owner")` nur die Kopie aus dem ersten Aufruf von `getRoles()`. Der zweite Aufruf liefert weiterhin `[reader]`.

Zugehörige Lektionen

  • Java · Lektion 10 · Fortgeschritten · Version: 2

Quellen