Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Java

Stupňovaný builder pomocí rozhraní

Stupňovaný builder pomocí rozhraní rozděluje vytváření objektu na typované kroky. Každá metoda pro přechod do další fáze vrací rozhraní této fáze, takže v běžném řetězci volání je `build()` dostupná až po zadání požadovaných vstupů. To nenahrazuje kontrolu těchto vstupů za běhu.

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

Syntaxe

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

Stupňovaný builder pomocí rozhraní je návrhový vzor, nikoli samostatná konstrukce jazyka Java. Rozhraní popisují dostupné operace v jednotlivých fázích. Návratový typ metody vede volajícího k další fázi; implementací může být jediný objekt, který implementuje všechna rozhraní fází.

V příkladu vrací builder() typ Start, host(String) vrací PortStep a port(int) vrací Ready. Pouze Ready deklaruje build(). Proto se builder().build() nepřeloží, zatímco builder().host("localhost").port(8080).build() vytvoří Endpoint. Běžný fluent builder umožňuje řetězit volání, ale samotné vracení this toto pořadí nevynucuje.

Typy zde vynucují pořadí volání, nikoli platnost argumentů. Metody stále kontrolují, zda host není prázdný a zda je port v povoleném rozsahu. Ochrana platí při používání deklarovaných typů fází: explicitní přetypování může zamýšlenou cestu obejít, protože objekt implementuje každou fázi. Proto build() také ověřuje, zda jsou požadované hodnoty přítomné.

Privátní implementace skrývá podrobnosti, ale proměnlivý builder není určen ke sdílení mezi vlákny. Zachované reference na předchozí fáze jej stále mohou měnit; fáze se nespotřebují právě jednou. Výsledný Endpoint ukládá vlastní pole final. Tento vzor použijte pro několik smysluplných kroků; mnoho kombinací požadovaných polí může výrazně zvýšit počet rozhraní.

Pří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ýsledek

localhost:8080

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje