Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / Java

Stupňovitý builder cez rozhrania

Stupňovitý builder cez rozhrania rozdeľuje vytváranie objektu na typované kroky. Každá metóda na prechod do ďalšej fázy vracia rozhranie tejto fázy, takže v bežnom reťazci volaní je `build()` dostupná až po zadaní požadovaných vstupov. To nenahrádza kontrolu týchto vstupov za behu.

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

Syntax

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

Stupňovitý builder cez rozhrania je návrhový vzor, nie samostatná konštrukcia jazyka Java. Rozhrania opisujú dostupné operácie v jednotlivých fázach. Návratový typ metódy vedie volajúceho k nasledujúcej fáze; implementáciou môže byť jediný objekt, ktorý implementuje všetky rozhrania fáz.

V príklade vracia builder() typ Start, host(String) vracia PortStep a port(int) vracia Ready. Iba Ready deklaruje build(). Preto sa builder().build() nepreloží, zatiaľ čo builder().host("localhost").port(8080).build() vytvorí Endpoint. Bežný fluent builder umožňuje reťaziť volania, ale samotné vracanie this toto poradie nevynucuje.

Typy tu vynucujú poradie volaní, nie platnosť argumentov. Metódy naďalej kontrolujú, či host nie je prázdny a či je port v povolenom rozsahu. Ochrana platí pri používaní deklarovaných typov fáz: explicitné pretypovanie môže zamýšľanú cestu obísť, pretože objekt implementuje každú fázu. Preto build() tiež overuje, či sú požadované hodnoty prítomné.

Súkromná implementácia skrýva podrobnosti, ale meniteľný builder nie je určený na zdieľanie medzi vláknami. Zachované referencie na predchádzajúce fázy ho stále môžu meniť; fázy sa nespotrebujú práve raz. Výsledný Endpoint ukladá vlastné polia final. Tento vzor použite pre niekoľko zmysluplných krokov; veľa kombinácií požadovaných polí môže výrazne zvýšiť počet rozhraní.

Príklady

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().
    }
}

Výsledok

localhost:8080

Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.

Zdroje