Что такое dto java
Перейти к содержимому

Что такое dto java

  • автор:

Что такое DTO в Java?

Допустим вы пишите игру шашки. И у вас есть класс Checker. У этого класса будут только поля(цвет, дамка, и т.п.) и геттеры/сеттеры. Вот вам и DTO. Ну и конструктор.

12 дек 2018 в 7:20

Тогда какой смысл в слове Transfer? Он же должен передавать данные по объектам? Как это написано тут DTO

12 дек 2018 в 7:20

@Teemitze DTO переводится как «объект, передающий данные». Данные, которые он передает — это и есть поля.

12 дек 2018 в 7:21

1 ответ 1

Сортировка: Сброс на вариант по умолчанию

Объект Customer — DTO.

DTO объект — объект, который не содержит методы. Он может содержать только поля, геттеры/сеттеры, и конструкторы.

Data Transfer Object — объект, передающий данные. Данные — это и есть поля в классе.

Реальный пример — игра шашки. У вас должен быть объект Checker (шашка). У него не должно быть методов, только поля.

public class Checker < private COLOR checkerColor; private Coordinate coordinate; //show checker coordinate private boolean isQueen; //show is the checker queen public Checker(COLOR checkerColor, int xCoordinate, int yCoordinate) < this.checkerColor = checkerColor; coordinate = new Coordinate(xCoordinate, yCoordinate); isQueen = false; >public Checker() <> public COLOR getColor() < return checkerColor; >public Coordinate getCoordinate() < return coordinate; >public boolean isQueen() < return isQueen; >public void setCoordinate(Coordinate coordinate) < this.coordinate.setCoordinates(coordinate.getX(), coordinate.getY()); >public void setQueen() < isQueen = true; >> 

Или класс Cell (шашечное поле).

public class Cell < private boolean isBusy; //shows does the field is occupied with the checker private Coordinate coordinate; //show field coordinate public Cell(boolean isBusy, int x, int y) < coordinate = new Coordinate(x, y); this.isBusy = isBusy; >public Cell() <> public boolean isBusy() < return isBusy; >public void setBusy(boolean isBusy) < this.isBusy = isBusy; >public Coordinate getCoordinate() < return coordinate; >> 

Или класс Board (доска):

public class Board < private Listcells; //list with 64 Fields() private List checkers; //list with Checkers(), whose number falls from 24 to 0 public Board() < cells = new LinkedList<>(); checkers = new LinkedList<>(); > public List getCells() < return cells; >public List getCheckers() < return checkers; >> 

Или класс Coordinate . Хотя у него есть методы(переопределенный equals и compare ), но это методы из Object и он тоже может считаться DTO объектом, т.к. он сделан только для того, что бы хранить данные(координаты).

public class Coordinate < private int x; //x coordinate private int y; //y coordinate public Coordinate(int x, int y) < this.x = x; this.y = y; >public int getX() < return x; >public void setX(int x) < this.x = x; >public int getY() < return y; >public void setY(int y) < this.y = y; >public void setCoordinates(int x, int y) < this.x = x; this.y = y; >@Override public boolean equals(Object o) < if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; Coordinate that = (Coordinate) o; return x == that.x && y == that.y; >public boolean compare(Coordinate that, int xMove, int yMove)

Data Transfer Object (Объект передачи данных)

Fork me on GitHub

Объект, который пересылает данные между процессами для уменьшения количества вызовов методов.

При работе с удалённым интерфейсом, таким как, например, Remote Facade, каждый запрос к нему достаточно затратен. В результате, приходится уменьшать количество вызовов, что означает необходимость передачи большего количества данных за один вызов. Чтобы реализовать это, как вариант, можно использовать множество параметров. Однако, при этом зачастую код получается неуклюжим и неудобным. Также это часто невозможно в таких языках, как Java, которые возвращают лишь одно значение.

Решением здесь является паттерн Data Transfer Object , который может хранить всю необходимую для вызова информацию. Он должен быть сериализуемым для удобной передачи по сети. Обычно используется объект-сборщик для передачи данных между DTO и объектами в приложении.

В сообществе Sun многие используют термин «Value Object» для обозначения этого паттерна. Мартин Фаулер подразумевает под этим термином ( Value Object ) несколько иной паттерн. Обсуждение этого можно прочесть в его книге P of EEA на странице 487.

Использована иллюстрация с сайта Мартина Фаулера.

  • Главная
  • Список паттернов
  • Сайт создан и поддерживается Василием Кулаковым.

Шаблон DTO (объект передачи данных)

В этом руководстве мы обсудим шаблон DTO , что это такое, как и когда его использовать. К концу мы будем знать, как правильно его использовать.

2. Узор​

DTO или объекты передачи данных — это объекты, которые переносят данные между процессами, чтобы уменьшить количество вызовов методов. Паттерн был впервые представлен Мартином Фаулером в его книге EAA .

Фаулер объяснил, что основная цель шаблона — сократить количество обращений к серверу за счет группирования нескольких параметров в одном вызове. Это снижает нагрузку на сеть при таких удаленных операциях.

Еще одним преимуществом является инкапсуляция логики сериализации (механизм, который переводит структуру объекта и данные в определенный формат, который можно хранить и передавать). Он обеспечивает единую точку изменения нюансов сериализации. Он также отделяет модели предметной области от уровня представления, позволяя им изменяться независимо друг от друга.

3. Как его использовать?​

DTO обычно создаются как POJO . Это плоские структуры данных, не содержащие бизнес-логики. Они содержат только хранилище, средства доступа и, в конечном итоге, методы, связанные с сериализацией или синтаксическим анализом.

Данные сопоставляются из моделей предметной области с DTO, как правило, через компонент сопоставления на уровне представления или фасада.

Изображение ниже иллюстрирует взаимодействие между компонентами:

4. Когда его использовать?​

DTO пригодятся в системах с удаленными вызовами, так как помогают уменьшить их количество.

DTO также помогают, когда модель предметной области состоит из множества различных объектов, а модели представления нужны все их данные одновременно, или они могут даже сократить круговой обмен между клиентом и сервером.

С помощью DTO мы можем создавать различные представления из наших моделей предметной области , что позволяет нам создавать другие представления той же предметной области, но оптимизировать их в соответствии с потребностями клиентов, не влияя на дизайн нашей предметной области. Такая гибкость является мощным инструментом для решения сложных задач.

5. Вариант использования​

Чтобы продемонстрировать реализацию шаблона, мы будем использовать простое приложение с двумя основными моделями предметной области, в данном случае User и Role . Чтобы сосредоточиться на шаблоне, давайте рассмотрим два примера функциональности — поиск пользователей и создание новых пользователей.

5.1. DTO против домена​

Ниже приводится определение обеих моделей:

 public class User     private String id;   private String name;   private String password;   private ListRole> roles;    public User(String name, String password, ListRole> roles)    this.name = Objects.requireNonNull(name);   this.password = this.encrypt(password);   this.roles = Objects.requireNonNull(roles);   >    // Getters and Setters    String encrypt(String password)    // encryption logic   >   > 
 public class Role     private String id;   private String name;    // Constructors, getters and setters   > 

Теперь давайте посмотрим на DTO, чтобы мы могли сравнить их с моделями предметной области.

На данный момент важно отметить, что DTO представляет собой модель, отправляемую от или к клиенту API.

Следовательно, небольшие различия заключаются либо в том, чтобы упаковать вместе запрос, отправленный на сервер, либо в оптимизации ответа клиента:

 public class UserDTO    private String name;   private ListString> roles;    // standard getters and setters   > 

Вышеупомянутый DTO предоставляет клиенту только необходимую информацию, скрывая пароль, например, из соображений безопасности.

Следующий DTO группирует все данные, необходимые для создания пользователя, и отправляет их на сервер в одном запросе, что оптимизирует взаимодействие с API:

 public class UserCreationDTO     private String name;   private String password;   private ListString> roles;    // standard getters and setters   > 

5.2. Подключение обеих сторон​

Затем слой, который связывает оба класса, использует компонент сопоставления для передачи данных с одной стороны на другую и наоборот.

Обычно это происходит на уровне представления:

 @RestController   @RequestMapping("/users")   class UserController     private UserService userService;   private RoleService roleService;   private Mapper mapper;    // Constructor    @GetMapping   @ResponseBody   public ListUserDTO> getUsers()    return userService.getAll()   .stream()   .map(mapper::toDto)   .collect(toList());   >     @PostMapping   @ResponseBody   public UserIdDTO create(@RequestBody UserCreationDTO userDTO)    User user = mapper.toUser(userDTO);    userDTO.getRoles()   .stream()   .map(role -> roleService.getOrCreate(role))   .forEach(user::addRole);    userService.save(user);    return new UserIdDTO(user.getId());   >    > 

Наконец, у нас есть компонент Mapper , который передает данные, гарантируя, что и DTO, и модель домена не должны знать друг о друге :

 @Component   class Mapper    public UserDTO toDto(User user)    String name = user.getName();   ListString> roles = user  .getRoles()   .stream()   .map(Role::getName)   .collect(toList());    return new UserDTO(name, roles);   >    public User toUser(UserCreationDTO userDTO)    return new User(userDTO.getName(), userDTO.getPassword(), new ArrayList>());   >   > 

6. Распространенные ошибки​

Хотя шаблон DTO является простым шаблоном проектирования, мы можем допустить несколько ошибок в приложениях, реализующих этот метод.

Первая ошибка — создавать разные DTO для каждого случая. Это увеличит количество классов и картографов, которые нам нужно поддерживать. Постарайтесь сделать их краткими и оцените компромиссы между добавлением одного или повторным использованием существующего.

Мы также хотим избежать попыток использовать один класс для многих сценариев. Эта практика может привести к большим контрактам, в которых многие атрибуты часто не используются.

Еще одна распространенная ошибка — добавлять в эти классы бизнес-логику, чего не должно происходить. Цель шаблона — оптимизировать передачу данных и структуру контрактов. Следовательно, вся бизнес-логика должна находиться на уровне предметной области.

Наконец, у нас есть так называемые LocalDTO , где DTO передают данные между доменами. Проблема еще раз заключается в стоимости обслуживания всего отображения.

Одним из наиболее распространенных аргументов в пользу такого подхода является инкапсуляция модели предметной области. Но проблема здесь в том, чтобы наша модель предметной области сочеталась с моделью постоянства. При их разделении риск раскрытия модели предметной области почти исчезает.

Другие шаблоны достигают аналогичного результата, но обычно они используются в более сложных сценариях, таких как CQRS , Data Mappers , CommandQuerySeparation и т. д.

7. Заключение​

В этой статье мы увидели определение паттерна DTO , почему он существует и как его реализовать.

Мы также увидели некоторые распространенные ошибки, связанные с его реализацией, и способы их избежать.

Как обычно, исходный код примера доступен на GitHub .

  • 1. Обзор
  • 2. Узор
  • 3. Как его использовать?
  • 4. Когда его использовать?
  • 5. Вариант использования
    • 5.1. DTO против домена
    • 5.2. Подключение обеих сторон

    Основы проектирования и дизайна

    Данный модуль является чисто теоретическим. Практическое задание в него не включено.

    Возможно вы заметили, что приложения прошлых практик имеют схожую структуру. В этом разделе мы попытаемся объяснить, почему и для чего это сделано, попутно проанализировав их составные части.

    Любое приложение работает с какими-либо данными: одни обрабатывают платежи, другие показывают доступные товары в интернет-магазине, а третьи выполняют поисковые запросы, составленные пользователем.
    Во всех этих случаях у нас есть бизнес-домен — банк, интернет-магазин или поисковая система.

    Бизнес-домен — набор объектов и отношений между ними, которые характеризуют какую-либо предметную область из реального мира.

    Пример: Банковская система (упрощенно).
    Сущности: Пользователь, организация, счет, платеж, депозит, карта.
    Связи: Пользователь принадлежит организации. У пользователя может быть много счетов. Организация делает платеж другой организации. Пользователь открывает депозит. Пользователь заводит карту.

    Entity

    Сущности в контексте приложения обычно называются Entity.

    Entity — сущность из бизнес-домена, представленная в нашей программе как класс, в котором есть только поля, геттеры и сеттеры. Никакая логика не должна содержаться в этом классе.

    Пример Entity — сущность ипотечного займа.
    Она используется при сохранении и получении данных из базы через слой Repository. Пример:

    package ru.bank.abc.entity; /** * Ипотечный займ (упрощенный вариант) */ public class Mortgage  /** * Продукт (например Семейная ипотека) */ private Product product; /** * Размер заемных средств */ private BigDecimal amount; /** * Размер ипотечной ставки */ private BigDecimal interestRate; /** * Срок кредитования */ private Integer period; /** * Список продавцов */ private ListSeller> sellers; /** * Список заявителей */ private ListApplicant> applicants; /** * Объект недвижимости */ private Realty realty; public Product getProduct()  return product; > public void setProduct(Product product)  this.product = product; > public BigDecimal getAmount()  return amount; > //. геттеры и сеттеры для полей public Realty getRealty()  return realty; > public void setRealty(Realty realty)  this.realty = realty; > > 

    DTO

    Также в приложениях выделяют сущности DTO (Data-transfer object).

    Data Transfer Object (DTO) — один из шаблонов проектирования, который используется для передачи данных между подсистемами приложения.

    Технически, это то же самое, что и Entity, но с точки зрения бизнес-домена, эти объекты никак не связаны с ней.

    Например, несколько полей, объединенных в одну сущность (DTO) для отправки в сервис расчета графика платежей. Пример:

    package ru.bank.abc.dto; /** * Запрос для расчета графика платежей */ public class PaymentScheduleCalculationRequest  /** * Размер заемных средств */ private BigDecimal amount; /** * Размер ипотечной ставки */ private BigDecimal interestRate; /** * Срок кредитования */ private Integer period; public BigDecimal getAmount()  return amount; > public void setAmount(BigDecimal amount)  this.amount = amount; > public BigDecimal getInterestRate()  return interestRate; > public void setInterestRate(BigDecimal interestRate)  this.interestRate = interestRate; > public Integer getPeriod()  return period; > public void setPeriod(Integer period)  this.period = period; > > 

    Также DTO могут использоваться для слоя отображения.
    То есть, это сущность, которая будет возвращаться пользователю в браузер (или в любое другое приложение-клиент) для отображения.

    Как правило, нет необходимости в отображении полной сущности со всеми данными одновременно на стороне клиента. Поэтому данные возвращаются в урезанном виде, который ровно совпадает с тем, что пользователь должен увидеть в текущий момент на своем экране.

    Например, если пользователь открыл форму для просмотра данных об участниках сделки, нет необходимости возвращать всю сущность ипотеки целиком, достаточно лишь вернуть DTO сущность, содержащую поля со списками продавцов List sellers и заявителей List applicants .

    Service

    Какие же сущности отвечают за выполнение бизнес логики в нашем приложении?

    Такие классы именуются как Service (Сервис).

    Service — класс, который отвечает за бизнес-логику при работе с конкретным Entity или DTO.

    Как правило для каждой сущности Entity создается свой Service.
    Через него может проходить логика создания\получения\обновления\удаления сущностей (CRUD операции), если такая предусмотрена в приложении.

    Например для сущности Mortgage это будет MortgageService .
    Он будет содержать CRUD методы, в рамках которых может выполняться дополнительная логика, например проверка корректности данных при создании нового ипотечного займа.

    С уровня Service мы также можем обращаться к другим классам Service уровня.

    Например при создании новой сущности Mortgage у нас возникает необходимость в расчете процентной ставки BigDecimal interestRate .
    Для этого мы должны обратиться из класса MortgageService в другой класс-сервис — ExternalEvaluationService который в свою очередь сформирует специальную DTO, которую отправит (через сеть) в совершенно другое приложение, которое произведет расчет и вернет нам обратно результат через ExternalEvaluationService в MortgageService и который мы запишем в нашу сущность Mortgage в поле BigDecimal interestRate .

    public interface MortgageService  boolean isUserFits(User user); boolean createMortgageRequest(Mortgage mortgage); Mortgage changeRate(Mortgage old); > 

    Repository (DAO)

    Также с уровня Service мы можем обращаться на уровень Repository (Репозиторий).
    Данный слой необходим для того, чтобы сохранять в базу или получать из базы какие-либо данные.

    Repository — класс, который взаимодействует с каким-либо физическим хранилищем (например База данных) для наших объектов.

    Здесь опять же используется аналогичный подход — для каждой сущности Entity создается свой Repository.

    Например для сущности Mortgage это будет MortgageRepository .

    В чем же разница? Приведем пример из реальной жизни: мы пришли в банк и хотим положить 10 рублей на наш счет. Мы подходим к кассе и говорим операционисту наш счет, ФИО и деньги. Она пересчитывает деньги, сверяет данные и кладет деньги в кассу. С точки зрения бизнесс-домена, оператор это сервис, а касса, с которой она взаимодействует это репозиторий. Заметим следующие особенности:

    • Сервис выполняет валидацию данных и, если воникла ошибка, говорит её.
    • Сервис обращается к репозиторию, у которого есть свой интерфейс и внутренняя логика, скрытая от сервиса.
    • Если мы захотим поменять репозиторий (способ работы с деньгами), то логика работы сервиса для конечного пользователя (нас) останется неизменной, что придает гибкости нашей программе.
    • Сервис может выполнять какие-то дополнительные функции, которые нужны для нашего бизнес-процесса. Например, при успешном зачислении денег операционист выдает чек-квитанцию.

    Так

    Важно понимать, что при переносе такой модели в программный код, все реалзации классов должны лежать в своих пакетах, которые соответствуют их сущности: entity , dto , service , repostory . Например:

    Иногда слой хранения данных делят на 2 паттерна:

    • DAO (Data Access Object)
    • рассмотренный выше Repository

    Они оба отвечают за взаимодействие с каким-то хранилищем сущностей. В чем же тогда заключается разница между ними?

    Представим ситуацию, что мы реализуем хранение сущности User . В случае с UserRepository у нас был бы следующий интерфейс:

    public interface UserRepository  User get(String userName); void create(User user); void update(User user); void delete(String userName); ListUser> query(UserSpecification specification); // Один метод что правит всеми запросами поиска > 

    А в случае с UserDAO такой:

    public interface UserDAO  void create(User user); void update(User user); void delete(User user); ListUser> getUserByLastName(String lastName); User getUserByAgeRange(int minAge, int maxAge); // Еще миллион методов поиска с разными параметрами > 

    Наверное, вы уже уловили суть. Самое главное отличие Repository от DAO в том, что он инкапсулируют всевозможные варианты поиска сущности в какой-то объект UserSpecification. В нем могут содержаться различные комбинации полей, по которым идет поиск, сколько страниц сущностей мы хотим увидеть и в каком порядке (сортировка).

    Так

    В общем случае наша программа будет выглядеть следующим образом (Разве что у нас нет базы данных):

    Чистый код

    Для того чтобы хорошо написать программу, недостаточно просто знать, на какие классы разделить функционал. Важно знать и понимать, как писать качественный, красивый и легкий в поддержке код.

    Принцип S.O.L.I.D.

    Принцип S.O.L.I.D. — это акроним из 5 основных принципов проектирования программ:

    1. Single Responsibility (Принцип единственной ответственности ) — Каждый класс должен иметь одну и только одну причину для изменений. С нарушением SRP система с трудом поддается изменениям, поскольку любое минимальное изменение вызывает эффект «снежного кома», затрагивающего другие компоненты системы.
    2. Open Closed Principle (Принцип открытости/закрытости) — Программные сущности должны быть:
      • открыты для расширения(наследования)
      • закрыты для изменения
        Идея в том, что однажды разработанная реализация класса в дальнейшем требует только исправления ошибок, а новые или изменённые функции требуют создания нового класса. Этот новый класс может переиспользовать код исходного класса через механизм наследования. Производный подкласс может реализовывать или не реализовывать интерфейс исходного класса.
    3. Liskov Substitution Principle (Принцип подстановки Барбары Лисков) — объекты в программе должны быть заменяемыми на экземпляры их подтипов без изменения правильности выполнения программы. Проще говоря, если у вас в проекте повсеместно используется экземпляры класса Collection , то вы вольны заменить их на List , Set или Queue .
    4. Interface Segregation Principle (Принцип разделения интерфейса) — много интерфейсов, специально предназначенных для клиентов, лучше, чем один интерфейс общего назначения.
    5. Dependency Inversion Principle (Принцип инверсии зависимостей) — Абстракции не должны зависеть от деталей. Детали должны зависеть от абстракций. Сюда входя следующие кейсы:
      • Все типы переменных должны быть объявлены интерфейсом или абстрактным классом.
      • Все классы должны быть зависимыми только от интерфейсов других классов. ? Все инициализации переменных должны происходить через паттерн Inversion of Control — например с помощью Factory method или механизмом Dependency injection

    Принцип DRY

    Принцип, нацеленный на снижение повторения информации различного рода. Нацелен на уменьшение кода и упрошения связей между сущностями.

    Принцип YAGNI

    Принцип, при котором в качестве основной цели и/или ценности декларируется отказ от избыточной функциональности. Цель этого принципа в уменьшении количества фич, и, как следствие, количества кода, модулей и зависимостей.

    Принцип KISS

    Принцип, запрещающий использование более сложных решений, чем это необходимо. Он происходит от похожих концепций, таких как бритва Оккама , который гласит Не следует множить сущее без необходимости .

    Основные материалы

    1. Видео: Learn — Clean Code
    2. Стиль кода Java
    3. Три ключевых принципа ПО, которые вы должны понимать

    Дополнительные материалы

    1. Stackoverflow: DTO vs entity
    2. Stackoverflow: Repository vs service
    3. Habr: DAO vs Repository
    4. Книга: Роберт Мартин — Чистый код

    Вопросы для самоконтроля

    Java Program Structure

    1. Что такое Entity?
    2. Что такое DTO? Как расшифровывается?
    3. В чем разница между Entity и DTO?
    4. За что отвечает слой Service?
    5. За что отвечает слой Repository?
    6. Для чего нужно делить наше приложение на слои?

    Java — Programming Principles

    1. Что такое принцип DRY? Как вы его понимаете?
    2. Что такое принцип KISS? Как вы его понимаете?
    3. Что такое принцип YAGNI? Как вы его понимаете?
    4. Что такое SOLID? Из каких составляющих принципов он состоит?
    5. Приведите пример нарушения принципа Liskov Substitution
    6. В чем основная цель приципа Dependency Inversion ?

    Developed by Timur Sokolov and Ilia Isakhin.

    We believe that knowledge is the most powerful tool you can use to change your life for better.

    © 2019-2020 EPAM Systems, Izhevsk.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *