Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Java

Budowniczy etapowy z użyciem interfejsów

Budowniczy etapowy z użyciem interfejsów dzieli tworzenie obiektu na etapy opisane typami. Każda metoda przejścia zwraca interfejs następnego etapu, dlatego w zwykłym łańcuchu wywołań `build()` jest dostępna dopiero po podaniu wymaganych danych. Nie zastępuje to walidacji wartości w czasie wykonania.

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

Składnia

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

Budowniczy etapowy z użyciem interfejsów to wzorzec projektowy, a nie osobna konstrukcja języka Java. Interfejsy opisują dostępne operacje poszczególnych etapów. Typ zwracany przez metodę kieruje użytkownika do kolejnego etapu; implementacja może być jednym obiektem realizującym wszystkie interfejsy.

W przykładzie builder() zwraca Start, host(String) zwraca PortStep, a port(int) zwraca Ready. Tylko Ready deklaruje build(). Dlatego builder().build() nie kompiluje się, natomiast builder().host("localhost").port(8080).build() tworzy Endpoint. Zwykły budowniczy z interfejsem płynnym umożliwia łączenie wywołań w łańcuch, ale samo zwracanie this nie wymusza takiej kolejności.

Typy wymuszają tutaj kolejność wywołań, nie poprawność argumentów. Metody nadal sprawdzają pusty host i zakres port. Ochrona dotyczy korzystania z zadeklarowanych typów etapów: jawne rzutowanie może ominąć zamierzoną ścieżkę, ponieważ obiekt implementuje wszystkie etapy. Dlatego build() dodatkowo sprawdza obecność wymaganych wartości.

Prywatna implementacja ukrywa szczegóły, lecz mutowalny budowniczy nie jest przeznaczony do współdzielenia między wątkami. Zachowane referencje do wcześniejszych etapów nadal pozwalają go modyfikować; z etapów można korzystać wielokrotnie. Wynikowy Endpoint przechowuje własne pola final. Wzorzec warto stosować dla kilku istotnych kroków; wiele kombinacji wymaganych pól może znacząco zwiększyć liczbę interfejsów.

Przykłady

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

Wynik

localhost:8080

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła