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

Патерн 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();

Коментарі

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

Встановлення безкоштовного 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/ Далі команди, які використовують...

Angular CLI

CLI (command-line interface) – інтерфейс командного рядка. Перед початком роботи має бути встановлений Node.js Встановлення: npm install -g @angular/cli Отримання допомоги: ng help Буде приблизно такий результат: add Adds support for an external library to your project. analytics Configures the gathering of Angular CLI usage metrics. See https://angular.io/cli/usage-analytics-gathering. build (b) Compiles an Angular app into an output directory named dist/ at the given output path. Must be executed from within a workspace directory. deploy Invokes the deploy builder for a specified project or for the default project in the workspace. config Retrieves or sets Angular configuration values in the angular.json file for the workspace. doc (d) Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword. e2e (e) Builds and serves an Angular app, then runs end-to-end tests. extract-i18n (i18n-extract, xi18n) Extracts i18n mes...

Spring Boot Actuator

Actuator в Spring Boot - це бібліотека, яке надає різноманітну інформацію про стан вашого застосунку і його компонентів. Він дозволяє легко моніторити застосунок в режимі реального часу. Основні можливості actuator включають: Стан застосунку (/actuator/health): Цей ендпоінт повертає інформацію про стан застосунку. Це може бути корисно для моніторингу системи та виявлення будь-яких проблем. Інформація про стан містить загальну інформацію про стан. Інформація про середовище (/actuator/env): Цей ендпоінт надає доступ до інформації про середовище, в якому працює ваш застосунок. Ви можете отримати доступ до системних властивостей, змінних середовища, налаштувань ініціалізації та іншої важливої інформації. Метрики (/actuator/metrics): Цей ендпоінт надає статистику про різні показники застосунку, такі як кількість HTTP-запитів, використання пам'яті, кількість з'єднань з базою даних, час відповіді тощо. Ви можете використовувати ці метрики для аналізу продуктивності вашог...

Робота SpringBoot 3 з базою даних Redis

Redis Redis (Remote Dictionary Server) — це in-memory база даних ключ-значення з відкритим вихідним кодом, що використовується для зберігання структурованих даних. Вона підтримує різні типи даних, такі як рядки, списки, множини, упорядковані множини з діапазонами, хеші, бітові масиви, потоки і т. д. Redis широко використовується для кешування, управління сесіями, систем обміну повідомленнями, черг задач та інших сценаріїв, що вимагають високої продуктивності і низької затримки. Redis з SpringBoot Розглянемо простий проєкт на SpringBoot, що використовує Redis, як базу даних. Створимо такий проєкт: Створимо entity Cat: import lombok.Data; import org.springframework.data.annotation.Id; import org.springframework.data.redis.core.RedisHash; @Data @RedisHash("cat") public class Cat { @Id private String id; private String name; private Integer age; public Cat(String name, Integer age) { this.name = name; this.age = age; } } Звер...

Встановлення 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...