Перейти до основного вмісту

Патерн Builder в Java

Проблема

У нас є клас, який містить велику кількість полів. Частина із цих полів є обов'язковими, а частина ні. Потрібно створити "інструменти" для створення екземплярів цього класу.

Приклад. У нас є клас Користувач (User), який містить 3 обов'язкових поля: Ім'я, Прізвище, ЕлектроннаПошта та ряд неов'язкових.


public class User {
    private String firstName;
    private String lastName;
    private String email;
    private String middleName;//optional
    private int age;//optional
    private String address;//optional
    private String comment;//optional
    private String phone;//optional
    //...
}

Розглянемо можливі рішення

Використання перевантажених конструкторів

В Java є можливість створити ряд конструкторів із різним набором параметрів.


public class User {
    private String firstName;
    private String lastName;
    private String email;
    private String middleName;//optional
    private int age;//optional
    private String address;//optional
    private String comment;//optional
    private String phone;//optional

    public User(String firstName, String lastName, String email) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
    }

    public User(String firstName, String lastName, String email, String middleName, int age, String address, String comment, String phone) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
        this.middleName = middleName;
        this.age = age;
        this.address = address;
        this.comment = comment;
        this.phone = phone;
    }

    public User(String firstName, String lastName, String email, String middleName) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
        this.middleName = middleName;
    }

    public User(String firstName, String lastName, String email, int age) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
        this.age = age;
    }
    
    //...
}

Недоліки підходу:

  • Якщо необов'язкових полів багато, то можливих варіантів конструкторів буде дуже багато.
  • Якщо поля мають однаковий тип, то важко буде (або й неможливо) створити конструктор для кожного варіанту.
  • При виклику конструктора потрібно буде враховувати порядок параметрів. А при цьому легко помилитися, особливо, коли параметри мають однаковий тип.

Використання сеттерів

Можна, наприклад, ініціалізувати обов'язкові параметри через конструктор, а інші - через сетери:


public class User {
    private String firstName;
    private String lastName;
    private String email;
    private String middleName;//optional
    private int age;//optional
    private String address;//optional
    private String comment;//optional
    private String phone;//optional

    public User(String firstName, String lastName, String email) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.email = email;
    }

    public void setMiddleName(String middleName) {
        this.middleName = middleName;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public void setAddress(String address) {
        this.address = address;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }

    //...
}

Недоліки підходу:

  • Використання сеттерів не дуже гарний стиль програмування.
  • Неможливо створити незмінні (immutable) об'єкти.

Використання патерну Будівельник

Патерн Будівельник позбавлений недоліків попередніх двох підходів.

Один із напростіших підходів реалізації цього патерна, це створення статичного вкладеного класу. Цей клас має містити такі ж поля, як і зовнішній клас. Зрозуміло, що необо'язкові поля можна ініціалізувати значеннями по замовчуванню. Вкладений клас повинен мати конструктор для обов'язкових полів. Для ініціалізації необов'язкових полів використовуються методі, схожі на сетери, але які повертають об'єкт класу будівельника.


    public static class Builder{
        private String firstName;
        private String lastName;
        private String email;
        private String middleName="";
        private int age=25;
        private String address="";
        private String comment="No comment";
        private String phone="+555555555";

        public Builder(String firstName, String lastName, String email) {
            this.firstName = firstName;
            this.lastName = lastName;
            this.email = email;
        }

        public Builder middleName(String middleName) {
            this.middleName = middleName;
            return this;
        }

        public Builder age(int age) {
            this.age = age;
            return this;
        }
        
        //...


    }

В класі User потрібно створити приватний конструктор, який в якості параметра приймає екземпляр класу Builder:


    private User(Builder builder) {
        this.firstName = builder.firstName;
        this.lastName = builder.lastName;
        this.email = builder.email;
        this.middleName = builder.middleName;
        this.age = builder.age;
        this.address = builder.address;
        this.comment = builder.comment;
        this.phone = builder.phone;
    }

В класі Builder сторити метод, що викликає цей конструктор:


        public User build(){
            return new User(this);
        }

Повний код класу User:


public class User {
    private String firstName;
    private String lastName;
    private String email;
    private String middleName;//optional
    private int age;//optional
    private String address;//optional
    private String comment;//optional
    private String phone;//optional

    private User(Builder builder) {
        this.firstName = builder.firstName;
        this.lastName = builder.lastName;
        this.email = builder.email;
        this.middleName = builder.middleName;
        this.age = builder.age;
        this.address = builder.address;
        this.comment = builder.comment;
        this.phone = builder.phone;
    }

    public static class Builder{
        private String firstName;
        private String lastName;
        private String email;
        private String middleName="";
        private int age=25;
        private String address="";
        private String comment="No comment";
        private String phone="+555555555";

        public Builder(String firstName, String lastName, String email) {
            this.firstName = firstName;
            this.lastName = lastName;
            this.email = email;
        }

        public Builder middleName(String middleName) {
            this.middleName = middleName;
            return this;
        }

        public Builder age(int age) {
            this.age = age;
            return this;
        }

        public Builder address(String address) {
            this.address = address;
            return this;
        }

        public Builder comment(String comment) {
            this.comment = comment;
            return this;
        }

        public Builder phone(String phone) {
            this.phone = phone;
            return this;
        }

        public User build(){
            return new User(this);
        }
    }

    public String getFirstName() {
        return firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public String getEmail() {
        return email;
    }

    public String getMiddleName() {
        return middleName;
    }

    public int getAge() {
        return age;
    }

    public String getAddress() {
        return address;
    }

    public String getComment() {
        return comment;
    }

    public String getPhone() {
        return phone;
    }

    //...

}

Сворення об'єкту з допомогою будівельника:


User user=new User.Builder("Петро","Іваненко","someemail@mail.com")
        .age(35)
        .build();

Коментарі

Популярні публікації

Базові команди для роботи з Git та Bitbucket

Git Будемо вважати, що git на комп'ютері вже встановлений. Якщо ні, то його неважко завантажити та встановити. Налаштування git на вашому комп'ютері можна подивитися за допомогою команди git config --list Щоб встановити ім'я та email, за яким ваші коміти будуть ідентифікуватися в репозиторії, використовуються команди: git config --global user.name "Your Name" git config --global user.email your@mail.com Bitbucket Нам потрібний акаунт на Bitbucket . Його неважко зареєструвати, це безкоштовно. Для створення нового репозиторію потрібно вибрати команду Create Repository . Далі потрібно заповнити основну інформацію про репозиторій. Обов'язковими є лише назва проєкту та назва репозиторію: Після заповнення полів потрібно натиснути кнопку Create Repository . Клонування репозиторію на комп'ютер Для того, щоб клонувати репозиторій на свій комп'ютер, потрібно виконати наступні кроки. Отримати посилання для клонування. Для цього в репозиторії...

Встановлення Jenkins на Ubuntu

Встановлення Jenkins на Ubuntu 22.04 Оновлюємо список встановлених пакетів: sudo apt-get update На машині має бути встановлена одна із актуальних версій JDK. В даному прикладі використовується JDK 17. Як встановити та переключати версії Java на Ubuntu в попередній статті Підключаємо необхідний репозиторій. Для цього спершу додаємо GPG-ключ: curl -fsSL https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key | sudo tee /usr/share/keyrings/jenkins-keyring.asc > /dev/null Додаємо репозиторій: echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] https://pkg.jenkins.io/debian-stable binary/ | sudo tee /etc/apt/sources.list.d/jenkins.list > /dev/null Для активації зроблених змін знову виконуємо команду sudo apt-get update Встановлюємо Jenkins: sudo apt install jenkins Запуск: sudo systemctl start jenkins Налаштування портів Jenkins використовує по замовчуванню порт 8080. Тому для роботи з Jenkins цей порт має бути відкритий. Перевіряємо статус ufw: sudo...

Встановлення безкоштовного SSL сертифікату від Let's Encrypt на Ubuntu-сервер

SSL-сертифікат - важливий компонент сучасного web-сайту. Let's Encrypy надає можливість отримати такий сертифікат абсолютно безкоштовно. Сертифікат реєструється на 3 місяці. Після цього його можна автоматично продовжити. Розглянемо випадок, коли домен вже зареєстрований і налаштований на відповідний сервер. На сервері встановлена операційна система Ubuntu. Apache Server Для початку не сервері має бути встановлений та запущений web-сервер. Наприклад, Apache. Якщо це не зроблено, то потрібного його встановити. Оновлюємо apt: sudo apt update Встановлення Apache: sudo apt install apache2 Корисними будуть команди Перевірити статус: sudo systemctl status apache2.service Старт: sudo systemctl start apache2.service Зупинка: sudo systemctl stop apache2.service Рестарт: sudo systemctl restart apache2.service Certbot Сертифікат найпростіше згенерувати за допомогою Certbot. Детальну інструкцію можна отримати на сайті https://certbot.eff.org/ Далі команди, які використовують...

Встановлення docker на сервер з операційною системою Ubuntu

Встановлення docker на сервер з операційною системою Ubuntu 22.04 Встановдення docker на десктопний Ubuntu розглядається тут . Оновлюємо список встановлених пакетів: sudo apt update Встановлюємо пакети, які дозволяють apt працювати через HTTPS: sudo apt install apt-transport-https ca-certificates curl software-properties-common Додаємо GPG-ключ: curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg Додаємо репозиторій Docker: echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null Знову оновлюємо пакети: sudo apt update Перевіряємо, чи зміни збереглися: apt-cache policy docker-ce Приблизний результат: docker-ce: Installed: (none) Candidate: 5:24.0.4-1~ubuntu.22.04~jammy Version table: 5:24.0.4-...

Знайомство з фреймворком Quarkus

Quarkus Quarkus - реактивний java-фреймворк, який підтримує GraalVM. Розглянемо створення стартового застосунку на Quarkus в операційній системі Ubuntu (для інших версій Linux команди будуть такими ж, для Windows можуть бути невеликі відмінності). Підготовка На машині має бути встановлений Maven. Перевірити це можна за допомогою команди: mvn --version Встановити Maven можна, використавши наступну команду: sudo apt install maven Створення стартового проєкту В потрібній директорії запустити в командному рядку код: mvn io.quarkus.platform:quarkus-maven-plugin:2.11.2.Final:create \ -DprojectGroupId=org.acme \ -DprojectArtifactId=getting-started \ -Dextensions="resteasy-reactive" cd getting-started Буде створений стартовий проєкт. Цеq проєкт можна відкрити за домогою улюбленого IDE. Не рахуючи тестів, у цьому проєкті є лише один java-клас: package org.acme; import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs...