Why DTOs matter in Spring Boot

Introduction

DTOs help move only the needed data between parts of an app. They keep things simple and safe.

When sending data from a server to a client in a web app.

When you want to hide sensitive info from users.

When you need to combine data from different sources into one object.

When you want to avoid sending large or unnecessary data over the network.

When you want to keep your internal data models separate from what external users see.

Syntax

Spring Boot

public class UserDTO {
    private String name;
    private String email;

    // Constructor
    public UserDTO(String name, String email) {
        this.name = name;
        this.email = email;
    }

    // Getters and setters
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public String getEmail() { return email; }
    public void setEmail(String email) { this.email = email; }
}

A DTO is a simple class with only fields and getters/setters.

It does not contain business logic or database code.

Examples

Using Java 17 records makes DTOs shorter and immutable.

Spring Boot

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

A DTO can have any fields you want to send or receive.

Spring Boot

public class ProductDTO {
    private String id;
    private String title;
    private double price;

    // getters and setters
}

Sample Program

This Spring Boot controller returns a UserDTO with only name and email. It hides the password field from the client.

Spring Boot

package com.example.demo.dto;

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

package com.example.demo.controller;

import com.example.demo.dto.UserDTO;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    @GetMapping("/user")
    public UserDTO getUser() {
        // Imagine this data comes from a database entity
        String fullName = "Alice Johnson";
        String email = "[e-mail]";
        String password = "secret"; // We don't want to send this

        // We create a DTO with only the safe data
        return new UserDTO(fullName, email);
    }
}

Important Notes

DTOs improve security by not exposing sensitive fields.

They make your API responses smaller and faster.

Using records for DTOs reduces boilerplate code.

Summary

DTOs carry only the data you want to share.

They protect your app by hiding internal details.

DTOs keep your code clean and easy to maintain.

Practice

1. Why do we use DTOs (Data Transfer Objects) in a Spring Boot application?

easy

A. To make the application slower by adding extra layers

B. To increase the size of data sent over the network

C. To replace the database entities completely

D. To carry only the data we want to share and hide internal details

Solution

1. Step 1: Understand the purpose of DTOs

   DTOs are designed to carry only the necessary data between processes or layers, avoiding exposure of internal details.

2. Step 2: Analyze the options

   To carry only the data we want to share and hide internal details correctly states the purpose of DTOs. The other options describe incorrect or harmful uses.

3. Final Answer:

   To carry only the data we want to share and hide internal details -> Option D

4. Quick Check:

   DTOs protect and simplify data transfer = D [OK]

Hint: DTOs share only needed data, hiding internals [OK]

Common Mistakes:

• Thinking DTOs replace entities fully
• Assuming DTOs increase data size
• Believing DTOs slow down the app

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

easy

A. public class UserDTO { private String name; private int age; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }

B. @Entity public class UserDTO { private String name; private int age; }

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

D. @Repository public class UserDTO { private String name; private int age; }

Solution

1. Step 1: Identify correct DTO structure

   A DTO is a simple class with private fields and public getters/setters, without annotations like @Entity or @Repository.

2. Step 2: Evaluate each option

   public class UserDTO { private String name; private int age; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } } correctly defines a DTO class with fields and accessors. @Entity public class UserDTO { private String name; private int age; } wrongly uses @Entity, which is for database entities. public interface UserDTO { String getName(); int getAge(); } defines an interface, not a DTO class. @Repository public class UserDTO { private String name; private int age; } wrongly uses @Repository, which is for data access layers.

3. Final Answer:

   public class UserDTO { private String name; private int age; public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } } -> Option A

4. Quick Check:

   DTO = simple class with getters/setters = B [OK]

Hint: DTOs are plain classes with getters/setters, no @Entity [OK]

Common Mistakes:

• Adding @Entity annotation to DTO
• Using interfaces instead of classes for DTO
• Marking DTO as @Repository

3. Given this Spring Boot controller method, what will be the output JSON when calling /user?

@GetMapping("/user")
public UserDTO getUser() {
    UserDTO dto = new UserDTO();
    dto.setName("Alice");
    dto.setAge(30);
    return dto;
}

medium

A. {"name":"Alice"}

B. {"UserDTO":{"name":"Alice","age":30}}

C. {"name":"Alice","age":30}

D. Error: Cannot serialize UserDTO

Solution

1. Step 1: Understand default JSON serialization in Spring Boot

   Spring Boot uses Jackson to convert returned objects to JSON, serializing all public getters by default.

2. Step 2: Analyze the returned UserDTO object

   UserDTO has name and age fields with getters, so JSON will include both as simple key-value pairs.

3. Final Answer:

   {"name":"Alice","age":30} -> Option C

4. Quick Check:

   DTO fields serialize as JSON keys = A [OK]

Hint: Returned DTO converts to JSON with all getters [OK]

Common Mistakes:

• Expecting nested JSON with class name
• Assuming partial fields serialize
• Thinking serialization causes error

4. What is wrong with this DTO class that causes a runtime error when Spring Boot tries to deserialize it?

public class ProductDTO {
    private String name;
    private int price;
    public ProductDTO(String name, int price) {
        this.name = name;
        this.price = price;
    }
}

medium

A. Fields should be public, not private

B. Missing default no-argument constructor

C. Constructor parameters should be annotated with @Autowired

D. Class should be annotated with @Entity

Solution

1. Step 1: Identify deserialization requirements

   Jackson requires a default no-argument constructor to create an instance before setting fields via setters or reflection.

2. Step 2: Check the DTO class

   This class only has a parameterized constructor and no default constructor, causing Jackson to fail during deserialization.

3. Final Answer:

   Missing default no-argument constructor -> Option B

4. Quick Check:

   Jackson needs no-arg constructor = A [OK]

Hint: DTOs need no-arg constructor for JSON serialization [OK]

Common Mistakes:

• Thinking fields must be public
• Adding @Autowired to constructor parameters
• Confusing DTO with entity needing @Entity

5. You have an entity class User with many fields, but you want to expose only id and email in your API response. How should you use a DTO to achieve this cleanly?

hard

A. Create a UserDTO with only id and email fields, map User to UserDTO before returning

B. Return the User entity directly and ignore unwanted fields in the frontend

C. Add @JsonIgnore to all unwanted fields in the User entity

D. Use the User entity but rename unwanted fields to empty strings

Solution

1. Step 1: Understand data exposure risks

   Returning the full User entity exposes all fields, risking sensitive data leaks.

2. Step 2: Use DTO to control data

   Creating a UserDTO with only id and email fields and mapping User to UserDTO ensures only desired data is sent.

3. Step 3: Evaluate other options

   Return the User entity directly and ignore unwanted fields in the frontend risks exposing all data. Add @JsonIgnore to all unwanted fields in the User entity mixes entity with serialization concerns and can be error-prone. Use the User entity but rename unwanted fields to empty strings is a bad practice and confusing.

4. Final Answer:

   Create a UserDTO with only id and email fields, map User to UserDTO before returning -> Option A

5. Quick Check:

   DTOs control exposed data = C [OK]

Hint: Use DTO to expose only needed fields safely [OK]

Common Mistakes:

• Returning full entity directly
• Using @JsonIgnore on entity fields
• Modifying entity fields to hide data