WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

@SafeVarargs — sichere varargs-Verarbeitung deklarieren

`@SafeVarargs` ist die Zusicherung des Autors, dass eine Methode oder ein Konstruktor seinen varargs-Parameter sicher verarbeitet. Die Annotation unterdrückt bestimmte unchecked-Warnungen an der Deklaration und den Aufrufstellen, prüft oder repariert die Typsicherheit jedoch nicht.

Version: Java SE 21; repository runtime, production runtime not attested

Syntax

@SafeVarargs
static <T> void inspect(T... values) { /* safe handling of values */ }

SafeVarargs ist eine Annotation aus java.lang. Ein varargs-Parameter wird als Array verarbeitet. Ist sein Elementtyp nicht reifizierbar, zum Beispiel List<String>, stehen zur Laufzeit nicht alle Typinformationen zur Verfügung. Dadurch besteht das Risiko einer Heap Pollution: Werte entsprechen möglicherweise nicht ihren deklarierten generischen Typen.

@SafeVarargs unterdrückt die unchecked-Warnung zu einer solchen Deklaration sowie zur Erzeugung parametrisierter Arrays an Aufrufstellen. Anders als @SuppressWarnings("unchecked") an einer Methodendeklaration wirkt sie sich auch auf Aufrufe dieser Methode aus. Sie unterdrückt nicht jede Warnung im Methodenrumpf.

In Java SE 21 kann die Annotation bei varargs-Konstruktoren und bei varargs-Methoden verwendet werden, die als static, final oder private gekennzeichnet sind. Ihre Verwendung bei einer Deklaration ohne varargs oder bei einer Methode, die diese Bedingungen nicht erfüllt, ist ein Kompilierfehler. Bei reifizierbaren Elementtypen wie String ist sie unnötig, und der Compiler kann eine Warnung ausgeben.

Dies ist ein Versprechen des Autors, kein Sicherheitsbeweis. Ein unsicherer Schreibzugriff über einen Array-Alias kann weiterhin eine ClassCastException verursachen. Im Beispiel liest totalSize das Array groups nur, schreibt weder hinein noch gibt es weiter. Das rechtfertigt das Versprechen.

Beispiele

import java.util.List;

public class Main {
    @SafeVarargs
    static int totalSize(List<String>... groups) {
        int total = 0;
        for (List<String> group : groups) {
            total += group.size();
        }
        return total;
    }

    public static void main(String[] args) {
        System.out.println(totalSize(List.of("A", "B"), List.of("C")));
    }
}

Ergebnis

3

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen