DTO pattern for data transfer in Spring Boot - Mini Project: Build & Apply

DTO pattern for data transfer in Spring Boot

📖 Scenario: You are building a simple Spring Boot application to manage books in a library. You want to separate the data sent to clients from the internal data model by using a Data Transfer Object (DTO).

🎯 Goal: Create a Book DTO class and use it to transfer book data from the service layer to the controller layer in a Spring Boot application.

📋 What You'll Learn

Create a Book entity class with fields id, title, and author

Create a BookDTO class with fields title and author

Write a method to convert a Book entity to a BookDTO

Use the BookDTO in the controller to return book data

💡 Why This Matters

🌍 Real World

DTOs are used in real applications to control what data is sent over the network, improving security and flexibility.

💼 Career

Understanding DTOs is important for backend developers working with APIs and data transfer in Java Spring Boot projects.

1

Create the Book entity class

Create a class called Book with private fields Long id, String title, and String author. Include public getters and setters for each field.

Spring Boot

// Your code here

Hint

Define a simple Java class with private fields and public getter and setter methods.

2

Create the BookDTO class

Create a class called BookDTO with private fields String title and String author. Include public getters and setters for each field.

Spring Boot

public class Book {
    private Long id;
    private String title;
    private String author;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
}

// Your code here

Hint

Create a simple Java class with only the fields you want to expose to clients.

3

Add a method to convert Book to BookDTO

Inside the BookDTO class, add a public static method called fromEntity that takes a Book object as a parameter and returns a new BookDTO with the title and author copied from the Book.

Spring Boot

public class Book {
    private Long id;
    private String title;
    private String author;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
}

public class BookDTO {
    private String title;
    private String author;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    // Add the fromEntity method below
}

Hint

Create a static method that creates a new BookDTO and copies the title and author from the Book parameter.

4

Use BookDTO in the controller

In a Spring Boot controller class, write a method called getBookDTO that returns a BookDTO. Inside the method, create a Book object with id = 1L, title = "Spring Boot Guide", and author = "John Doe". Then return the result of BookDTO.fromEntity(book).

Spring Boot

public class Book {
    private Long id;
    private String title;
    private String author;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
}

public class BookDTO {
    private String title;
    private String author;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public static BookDTO fromEntity(Book book) {
        BookDTO dto = new BookDTO();
        dto.setTitle(book.getTitle());
        dto.setAuthor(book.getAuthor());
        return dto;
    }
}

// Add the controller method below

Hint

Create a Spring Boot controller method that builds a Book and returns a BookDTO using the conversion method.

Practice

1. What is the main purpose of using a DTO (Data Transfer Object) in a Spring Boot application?

easy

A. To manage application configuration settings

B. To store data permanently in the database

C. To handle user authentication and authorization

D. To safely transfer only necessary data between different parts of the application

Solution

1. Step 1: Understand the role of DTOs

   DTOs are simple objects designed to carry data between layers or parts of an application without exposing sensitive or unnecessary details.

2. Step 2: Identify the correct purpose

   Unlike entities or configuration classes, DTOs focus on safe and clean data transfer, not storage or security management.

3. Final Answer:

   To safely transfer only necessary data between different parts of the application -> Option D

4. Quick Check:

   DTO purpose = safe data transfer [OK]

Hint: DTOs move data safely without exposing all details [OK]

Common Mistakes:

• Confusing DTOs with database entities
• Thinking DTOs handle security
• Assuming DTOs store data permanently

2. Which of the following is the correct way to define a simple DTO class in Spring Boot using Java records?

easy

A. public record UserDTO(String name, String email) {}

B. public class UserDTO { private String name; private String email; }

C. public interface UserDTO { String getName(); String getEmail(); }

D. public enum UserDTO { NAME, EMAIL }

Solution

1. Step 1: Recognize Java record syntax

   Java records provide a concise way to create immutable data carriers with automatic getters and constructors.

2. Step 2: Match the correct syntax

   public record UserDTO(String name, String email) {} uses the correct record declaration with fields inside parentheses and empty body braces.

3. Final Answer:

   public record UserDTO(String name, String email) {} -> Option A

4. Quick Check:

   Java record syntax = public record UserDTO(String name, String email) {} [OK]

Hint: Java records use 'record Name(fields) {}' syntax [OK]

Common Mistakes:

• Using class without constructors/getters
• Confusing interface with DTO class
• Using enum for data transfer

3. Given this Spring Boot code snippet, what will be the output when the getUserDTO() method is called?

public record UserDTO(String name, int age) {}

public UserDTO getUserDTO() {
    UserDTO user = new UserDTO("Alice", 30);
    return new UserDTO(user.name(), user.age() + 5);
}

medium

A. UserDTO[name=Alice, age=5]

B. UserDTO[name=Alice, age=35]

C. UserDTO[name=Alice, age=30]

D. Compilation error due to missing constructor

Solution

1. Step 1: Understand record instantiation and methods

   The record UserDTO has fields name and age with automatic accessor methods name() and age().

2. Step 2: Analyze the returned object

   The method creates a UserDTO with name "Alice" and age 30, then returns a new UserDTO with the same name and age increased by 5 (30 + 5 = 35).

3. Final Answer:

   UserDTO[name=Alice, age=35] -> Option B

4. Quick Check:

   Age incremented by 5 = 35 [OK]

Hint: Records have automatic getters like name() and age() [OK]

Common Mistakes:

• Forgetting to add 5 to age
• Confusing method calls with field access
• Assuming default toString format

4. Identify the error in this DTO usage code snippet:

public record ProductDTO(String name, double price) {}

public ProductDTO createProduct() {
    ProductDTO product = new ProductDTO("Book");
    return product;
}

medium

A. Missing second argument for price in ProductDTO constructor

B. Records cannot be used as DTOs

C. Method createProduct should return void

D. ProductDTO fields must be private

Solution

1. Step 1: Check record constructor parameters

   The ProductDTO record requires two parameters: a String name and a double price.

2. Step 2: Identify constructor call mistake

   The constructor call provides only one argument "Book", missing the price argument, causing a compile-time error.

3. Final Answer:

   Missing second argument for price in ProductDTO constructor -> Option A

4. Quick Check:

   Constructor args must match record fields [OK]

Hint: Record constructors need all fields in order [OK]

Common Mistakes:

• Passing fewer arguments than fields
• Thinking records can't be DTOs
• Ignoring method return types

5. You want to create a DTO that hides the user's password when sending data to the client. Given the entity:

public class User {
    private String username;
    private String password;
    private String email;
    // getters and setters
}

Which DTO definition best achieves this goal?

hard

A. public class UserDTO { private String password; }

B. public record UserDTO(String username, String password, String email) {}

C. public record UserDTO(String username, String email) {}

D. public record UserDTO(String password) {}

Solution

1. Step 1: Understand the goal to hide password

   The DTO should exclude the password field to avoid exposing it to clients.

2. Step 2: Choose DTO fields accordingly

   public record UserDTO(String username, String email) {} includes only username and email, omitting password, which meets the requirement.

3. Final Answer:

   public record UserDTO(String username, String email) {} -> Option C

4. Quick Check:

   Exclude sensitive fields in DTO [OK]

Hint: Exclude sensitive fields from DTO to hide them [OK]

Common Mistakes:

• Including password in DTO fields
• Using DTO with only password
• Confusing entity with DTO