База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / Java

Поетапен builder чрез интерфейси

Поетапният builder чрез интерфейси разделя създаването на обект на типизирани стъпки. Всеки метод за преход към следващия етап връща интерфейса на този етап, така че в обикновена верига от извиквания `build()` е достъпен едва след задаване на необходимите входни данни. Това не заменя проверката им по време на изпълнение.

Версия: Java SE 21; repository runtime, production runtime not attested

Синтаксис

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

Поетапният builder чрез интерфейси е шаблон за проектиране, а не отделна конструкция на езика Java. Интерфейсите описват наличните операции на всеки етап. Типът на връщане на метода насочва извикващия към следващия етап; реализацията може да бъде един обект, който реализира всички интерфейси на етапите.

В примера builder() връща Start, host(String) връща PortStep, а port(int) връща Ready. Само Ready декларира build(). Затова builder().build() не се компилира, докато builder().host("localhost").port(8080).build() създава Endpoint. Обикновеният fluent builder позволява верижни извиквания, но самото връщане на this не налага този ред.

Тук типовете налагат реда на извикванията, а не валидността на аргументите. Методите продължават да проверяват дали host не е празен и дали port е в допустимия диапазон. Защитата важи при използване на декларираните типове на етапите: явните преобразувания могат да заобиколят предвидения път, защото обектът реализира всеки етап. Затова build() също проверява дали необходимите стойности са зададени.

Частната реализация скрива подробностите, но променливият builder не е предназначен за споделяне между нишки. Запазени препратки към предишни етапи все още могат да го променят; етапите не се използват точно веднъж. Полученият Endpoint съхранява собствени полета final. Използвайте този шаблон за няколко важни стъпки; многото комбинации от задължителни полета могат значително да увеличат броя на интерфейсите.

Примери

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

Резултат

localhost:8080

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници