Part 22: Add dto folder with files

Author: JcoderPaul

Spring_part_22/src/main/java/spring/oldboy/dto/CompanyReadDto.java

@@ -0,0 +1,5 @@
+package spring.oldboy.dto;
+
+public record CompanyReadDto(Integer id,
+                             String name) {
+}

Spring_part_22/src/main/java/spring/oldboy/dto/LoginDto.java

@@ -0,0 +1,9 @@
+package spring.oldboy.dto;
+
+import lombok.Value;
+
+@Value
+public class LoginDto {
+    String username;
+    String password;
+}

Spring_part_22/src/main/java/spring/oldboy/dto/PagePaginationResponse.java

@@ -0,0 +1,39 @@
+package spring.oldboy.dto;
+/*
+Lesson 88 - На запрос с разбивкой по страницам нам
+нужен ответ, который будет отображаться пользователю
+*/
+import lombok.Value;
+import org.springframework.data.domain.Page;
+
+import java.util.List;
+
+@Value
+public class PagePaginationResponse <T> {
+    /*
+    Поле параметризованное Т, в нашем конкретном случае
+    этот класс будет использоваться для класса user, хотя
+    может использоваться и для company и т.д.
+    */
+    List<T> content;
+    /*
+    Поле в котором будет храниться мета-информация:
+    - page - номер страницы;
+    - size - количество записей на одной странице;
+    - totalElements - количество страниц записями из БД;
+    см. сам класс ниже.
+    */
+    Metadata metadata;
+
+    public static <T> PagePaginationResponse<T> of(Page<T> page) {
+        Metadata metadata = new Metadata(page.getNumber(), page.getSize(), page.getTotalElements());
+        return new PagePaginationResponse<>(page.getContent(), metadata);
+    }
+
+    @Value
+    public static class Metadata {
+        int page;
+        int size;
+        long totalElements;
+    }
+}

Spring_part_22/src/main/java/spring/oldboy/dto/PersonalInfo.java

@@ -0,0 +1,8 @@
+package spring.oldboy.dto;
+
+import java.time.LocalDate;
+
+public record PersonalInfo(String firstname,
+                           String lastname,
+                           LocalDate birthDate) {
+}

Spring_part_22/src/main/java/spring/oldboy/dto/PersonalInfoTwo.java

@@ -0,0 +1,27 @@
+package spring.oldboy.dto;
+
+import org.springframework.beans.factory.annotation.Value;
+
+public interface PersonalInfoTwo {
+
+    String getFirstname();
+
+    String getLastname();
+
+    String getBirthDate();
+
+    /*
+    Особенность применения интерфейсов в проекциях сущностей в том, что
+    мы можем запрашивать синтегрированные из полей данные с применением
+    синтаксиса SpEL и аннотации @Value, которую мы используем для внедрения
+    свойств.
+
+    В данном случае, terget - это текущая сущность PersonalInfoTwo и мы
+    обращаемся к ней, хотя, тут, могли использоваться любые bean-ы из
+    нашего приложения.
+
+    См. DOC/ArticleAboutProjection/SpringDataJPAProjections.txt
+    */
+    @Value("#{target.firstname + ' ' + target.lastname}")
+    String getFullName();
+}

Spring_part_22/src/main/java/spring/oldboy/dto/PersonalRole.java

@@ -0,0 +1,8 @@
+package spring.oldboy.dto;
+
+import spring.oldboy.database.entity.Role;
+
+public record PersonalRole(String firstname,
+                           String lastname,
+                           Role role) {
+}

Spring_part_22/src/main/java/spring/oldboy/dto/UserCreateEditDto.java

@@ -0,0 +1,85 @@
+package spring.oldboy.dto;
+/*
+Lesson 89 - Применяем аннотации из пакета jakarta.validation к полям класса.
+*/
+import jakarta.validation.constraints.Email;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.Size;
+import lombok.Value;
+import lombok.experimental.FieldNameConstants;
+import org.springframework.format.annotation.DateTimeFormat;
+import org.springframework.web.multipart.MultipartFile;
+import spring.oldboy.database.entity.Role;
+import spring.oldboy.validation.UserInfo;
+import spring.oldboy.validation.group.CreateAction;
+
+import java.time.LocalDate;
+
+@Value
+/*
+Немного упростим себе жизнь на этапе тестирования. Данная аннотация создает внутренний тип,
+содержащий строковые константы, содержащие имя поля для каждого поля. В качестве альтернативы
+генерирует внутреннее перечисление со значениями перечисления, соответствующими каждому имени
+поля.
+*/
+@FieldNameConstants
+/*
+Применим нашу самописную аннотацию для валидации полей firstname
+и lastname, теперь аннотация @NotNull над этими полями не нужна.
+*/
+@UserInfo(groups = CreateAction.class)
+public class UserCreateEditDto {
+
+    /*
+    Данная аннотация 'валидирует' - проверяет поле на
+    правильность в ходе заполнения формы регистрации,
+    а точнее в момент передачи данных в БД.
+
+    см. DOC/JakartaBeanValidation
+    */
+    @Email
+    String username;
+
+    /*
+    Lesson 105: Добавляем поле пароля. Аннотация показывает, что элемент
+    не должен быть нулевым и должен содержать хотя бы один символ без
+    пробелов. В нашем случае с параметром уточнения - на этапе создания.
+    Т.к. на изменение - UPDATE - пароля мы будем использовать другой
+    функционал, изменяющий не всего USER-a, а только пароль.
+    */
+    @NotBlank(groups = CreateAction.class)
+    String rawPassword;
+
+    @DateTimeFormat(pattern = "yyyy-MM-dd")
+    LocalDate birthDate;
+
+    /*
+    Lesson 89: Проверяем чтобы сведения из поля формы не было пустым,
+    а также длинна заполненной строки лежала в диапазоне от 3-х до 64
+    символов. Хотя в данном случае лучше бы подошла аннотация - @NotEmpty,
+    как и для поля ниже.
+
+    Lesson 90: Как только мы применим нашу кастомную аннотацию @UserInfo,
+    текущая @NotNull уже не нужна.
+    */
+    // @NotNull
+    @Size(min = 3, max = 64)
+    String firstname;
+
+    /*
+    Lesson 90: Как только мы применим нашу кастомную аннотацию @UserInfo,
+    текущая @NotNull уже не нужна.
+    */
+    // @NotNull
+    String lastname;
+
+    Role role;
+    Integer companyId;
+    /*
+    Параметр нашей аватарки, имя поля в данном классе, должно совпадать
+    с параметром name="image" в теге <input> наших форм регистрации
+    (registration.html) и обновления-отображения (user.html) в
+    resources/templates/user
+    */
+    MultipartFile image;
+}

Spring_part_22/src/main/java/spring/oldboy/dto/UserFilterDto.java

@@ -0,0 +1,19 @@
+package spring.oldboy.dto;
+
+import java.time.LocalDate;
+
+/*
+Lesson 88:
+Каждый учитель городит свои заборы в уме студента! Если с фильтрацией User-ов
+было все более или менее понятно, то с постраничным выводом возникли вопросы,
+которые показали, что и с фильтрацией не все так гладко выглядит. Иногда
+название класса все поправляет. Например, текущее название этого record-a,
+намекает на то, что параметры оного - есть критерии фильтрации и как это не
+странно они же критерии поиска. Мы же ищем записи в БД удовлетворяющие неким
+условиям - "критериям". Отсюда название класса было бы уместнее задать как -
+UserSearchCriteria.
+*/
+public record UserFilterDto(String firstname,
+                            String lastname,
+                            LocalDate birthDate) {
+}

Spring_part_22/src/main/java/spring/oldboy/dto/UserReadDto.java

@@ -0,0 +1,18 @@
+package spring.oldboy.dto;
+
+import lombok.Value;
+import spring.oldboy.database.entity.Role;
+
+import java.time.LocalDate;
+
+@Value
+public class UserReadDto {
+    Long id;
+    String username;
+    LocalDate birthDate;
+    String firstname;
+    String lastname;
+    String image;
+    Role role;
+    CompanyReadDto company;
+}