WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Java

Etappenweiser Builder mit Interfaces

Ein etappenweiser Builder mit Interfaces teilt die Objekterstellung in typisierte Schritte auf. Jede Methode, die zur nächsten Etappe überleitet, gibt deren Interface zurück. Dadurch ist `build()` in einer gewöhnlichen Aufrufkette erst verfügbar, nachdem die erforderlichen Eingaben gemacht wurden. Das ersetzt nicht die Laufzeitvalidierung dieser Eingaben.

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

Syntax

Start builder() → Start.host(String) : PortStep → PortStep.port(int) : Ready → Ready.build() : Endpoint

Ein etappenweiser Builder mit Interfaces ist ein Entwurfsmuster und kein eigenes Sprachkonstrukt von Java. Interfaces beschreiben die verfügbaren Operationen der einzelnen Etappen. Der Rückgabetyp einer Methode führt den Aufrufer zur nächsten Etappe; die Implementierung kann ein einzelnes Objekt sein, das alle Etappen-Interfaces implementiert.

Im Beispiel gibt builder() ein Start zurück, host(String) gibt ein PortStep zurück und port(int) gibt ein Ready zurück. Nur Ready deklariert build(). Deshalb lässt sich builder().build() nicht kompilieren, während builder().host("localhost").port(8080).build() einen Endpoint erzeugt. Ein gewöhnlicher Fluent Builder unterstützt verkettete Aufrufe, aber die bloße Rückgabe von this erzwingt diese Reihenfolge nicht.

Die Typen erzwingen hier die Aufrufreihenfolge, nicht die Gültigkeit der Argumente. Die Methoden prüfen weiterhin, ob host nicht leer ist und ob port im zulässigen Bereich liegt. Der Schutz gilt bei Verwendung der deklarierten Etappentypen: Explizite Casts können den vorgesehenen Pfad umgehen, weil das Objekt alle Etappen implementiert. Deshalb prüft build() zusätzlich, ob die erforderlichen Werte vorhanden sind.

Die private Implementierung verbirgt Details, aber der veränderliche Builder ist nicht dafür gedacht, von mehreren Threads gemeinsam verwendet zu werden. Behaltene Referenzen auf frühere Etappen können ihn weiterhin ändern; die Etappen werden nicht genau einmal verbraucht. Der resultierende Endpoint speichert eigene final-Felder. Verwenden Sie dieses Muster für einige sinnvolle Schritte; viele Kombinationen erforderlicher Felder können die Anzahl der Interfaces erheblich erhöhen.

Beispiele

public final class Main {
    public interface Start {
        PortStep host(String host);
    }

    public interface PortStep {
        Ready port(int port);
    }

    public interface Ready {
        Endpoint build();
    }

    public static final class Endpoint {
        private final String host;
        private final int port;

        private Endpoint(String host, int port) {
            this.host = host;
            this.port = port;
        }

        @Override
        public String toString() {
            return host + ":" + port;
        }
    }

    private static final class Builder implements Start, PortStep, Ready {
        private String host;
        private int port;

        @Override
        public PortStep host(String host) {
            if (host == null || host.isBlank()) {
                throw new IllegalArgumentException("host must not be blank");
            }
            this.host = host;
            return this;
        }

        @Override
        public Ready port(int port) {
            if (port < 1 || port > 65535) {
                throw new IllegalArgumentException("port out of range");
            }
            this.port = port;
            return this;
        }

        @Override
        public Endpoint build() {
            if (host == null || port == 0) {
                throw new IllegalStateException("missing required values");
            }
            return new Endpoint(host, port);
        }
    }

    public static Start builder() {
        return new Builder();
    }

    public static void main(String[] args) {
        Endpoint endpoint = builder().host("localhost").port(8080).build();
        System.out.println(endpoint);
        // builder().build(); // Does not compile: Start has no build().
    }
}

Ergebnis

localhost:8080

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