MapStruct for automatic mapping in Spring Boot

Introduction

MapStruct helps you copy data between objects easily without writing boring code. It saves time and avoids mistakes.

When you want to convert data from one object type to another, like from a database model to a web response.

When you have many similar objects and need to copy data between them often.

When you want to keep your code clean and avoid writing repetitive copying code.

When you want your data conversions to be fast and checked at compile time.

When you want to reduce bugs caused by manual copying of fields.

Syntax

Spring Boot

@Mapper
public interface YourMapper {
    TargetObject toTarget(SourceObject source);
}

@Mapper tells MapStruct to create the mapping code automatically.

The method defines how to convert from one object to another.

Examples

This maps a User object to a UserDTO object automatically.

Spring Boot

@Mapper
public interface UserMapper {
    UserDTO toUserDTO(User user);
}

This shows mapping both ways: from Car to CarDTO and back.

Spring Boot

@Mapper
public interface CarMapper {
    CarDTO toCarDTO(Car car);
    Car toCar(CarDTO carDTO);
}

Using componentModel = "spring" lets Spring manage the mapper as a bean.

Spring Boot

@Mapper(componentModel = "spring")
public interface EmployeeMapper {
    EmployeeDTO toEmployeeDTO(Employee employee);
}

Sample Program

This Spring Boot example shows how MapStruct automatically copies data from a User object to a UserDTO object. The mapper is injected by Spring and used in the main application.

Spring Boot

package com.example.demo.mapper;

import org.mapstruct.Mapper;
import com.example.demo.model.User;
import com.example.demo.dto.UserDTO;

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserDTO toUserDTO(User user);
}

// User.java
package com.example.demo.model;

public class User {
    private String name;
    private int age;

    public User() {}

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() { return name; }
    public int getAge() { return age; }

    public void setName(String name) { this.name = name; }
    public void setAge(int age) { this.age = age; }
}

// UserDTO.java
package com.example.demo.dto;

public class UserDTO {
    private String name;
    private int age;

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

// DemoApplication.java
package com.example.demo;

import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.beans.factory.annotation.Autowired;
import com.example.demo.mapper.UserMapper;
import com.example.demo.model.User;
import com.example.demo.dto.UserDTO;

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    @Autowired
    private UserMapper userMapper;

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        User user = new User("Alice", 30);
        UserDTO userDTO = userMapper.toUserDTO(user);
        System.out.println("UserDTO name: " + userDTO.getName());
        System.out.println("UserDTO age: " + userDTO.getAge());
    }
}

Important Notes

MapStruct generates code at compile time, so your app runs fast.

Make sure your source and target objects have matching field names or use annotations to customize.

Use componentModel = "spring" to let Spring inject the mapper easily.

Summary

MapStruct automatically copies data between objects to save time and avoid errors.

It works by defining interfaces with @Mapper and methods for conversion.

Spring Boot can manage mappers as beans for easy use in your app.

Practice

1. What is the main purpose of using MapStruct in a Spring Boot application?

easy

A. To create user interface components

B. To manage database connections

C. To automatically map data between different object types

D. To handle HTTP requests and responses

Solution

1. Step 1: Understand MapStruct's role

   MapStruct is a tool designed to copy data between objects automatically, reducing manual coding.

2. Step 2: Compare with other options

   Options A, B, and C relate to other parts of Spring Boot, not object mapping.

3. Final Answer:

   To automatically map data between different object types -> Option C

4. Quick Check:

   MapStruct = automatic object mapping [OK]

Hint: MapStruct = automatic copying between objects [OK]

Common Mistakes:

• Confusing MapStruct with database or web handling
• Thinking MapStruct creates UI components
• Assuming MapStruct manages HTTP requests

2. Which annotation is used to define a MapStruct mapper interface in Spring Boot?

easy

A. @Component

B. @Mapper

C. @Service

D. @Repository

Solution

1. Step 1: Identify the correct MapStruct annotation

   MapStruct uses @Mapper to mark interfaces for automatic mapping generation.

2. Step 2: Understand Spring stereotypes

   @Component, @Service, and @Repository are Spring annotations for beans but not for MapStruct mapping.

3. Final Answer:

   @Mapper -> Option B

4. Quick Check:

   MapStruct interface = @Mapper [OK]

Hint: MapStruct interfaces use @Mapper annotation [OK]

Common Mistakes:

• Using @Component instead of @Mapper
• Confusing Spring stereotypes with MapStruct annotations
• Omitting the @Mapper annotation

3. Given the following mapper interface:

@Mapper(componentModel = "spring")
public interface UserMapper {
    UserDto toDto(User user);
}

What happens when you inject UserMapper in a Spring Boot service and call toDto(user)?

medium

A. It converts the User object to a UserDto automatically

B. It throws a NullPointerException because no implementation exists

C. It returns the original User object without changes

D. It requires manual implementation to work

Solution

1. Step 1: Understand componentModel = "spring"

   This setting tells MapStruct to generate a Spring bean implementation automatically.

2. Step 2: Effect of calling toDto(user)

   The generated implementation copies matching fields from User to UserDto automatically.

3. Final Answer:

   It converts the User object to a UserDto automatically -> Option A

4. Quick Check:

   componentModel spring = auto bean + mapping [OK]

Hint: componentModel spring means auto Spring bean mapper [OK]

Common Mistakes:

• Thinking manual implementation is needed
• Assuming it returns original object
• Expecting runtime errors without implementation

4. Consider this mapper interface:

@Mapper
public interface ProductMapper {
    ProductDto toDto(Product product);
}

When you try to inject ProductMapper in a Spring Boot service, you get an error. What is the likely cause?

medium

A. Missing componentModel = "spring" to register mapper as a Spring bean

B. The method name toDto is invalid

C. MapStruct does not support mapping Product to ProductDto

D. The interface must be a class, not an interface

Solution

1. Step 1: Check mapper registration in Spring context

   Without componentModel = "spring", MapStruct does not create a Spring bean for the mapper.

2. Step 2: Understand injection failure

   Spring cannot inject the mapper because it is not registered as a bean, causing an error.

3. Final Answer:

   Missing componentModel = "spring" to register mapper as a Spring bean -> Option A

4. Quick Check:

   Missing spring componentModel = no bean injection [OK]

Hint: Add componentModel spring to enable Spring bean injection [OK]

Common Mistakes:

• Thinking method name causes error
• Believing MapStruct can't map certain classes
• Confusing interface with class requirement

5. You have two classes:

public class Employee {
    private String name;
    private int age;
    private String department;
    // getters and setters
}

public class EmployeeDto {
    private String name;
    private int age;
    // getters and setters
}

You want to map Employee to EmployeeDto using MapStruct but ignore the department field. Which mapper method signature and annotation is correct?

hard

A. @Mapper
public interface EmployeeMapper {
EmployeeDto toDto(Employee employee);
}

B. @Mapper(componentModel = "spring")
public interface EmployeeMapper {
EmployeeDto toDto(Employee employee);
}

C. @Mapper
public interface EmployeeMapper {
@Mapping(source = "department", target = "department")
EmployeeDto toDto(Employee employee);
}

D. @Mapper(componentModel = "spring")
public interface EmployeeMapper {
@Mapping(target = "department", ignore = true)
EmployeeDto toDto(Employee employee);
}

Solution

1. Step 1: Identify ignoring a field in MapStruct

   To ignore a field during mapping, use @Mapping(target = "fieldName", ignore = true) on the method.

2. Step 2: Check componentModel for Spring bean

   Using componentModel = "spring" allows Spring to manage the mapper bean automatically.

3. Final Answer:

   @Mapper(componentModel = "spring") public interface EmployeeMapper { @Mapping(target = "department", ignore = true) EmployeeDto toDto(Employee employee); } -> Option D

4. Quick Check:

   Ignore field with @Mapping(target, ignore=true) + spring bean [OK]

Hint: Use @Mapping(target, ignore=true) to skip fields [OK]

Common Mistakes:

• Not using @Mapping to ignore fields
• Forgetting componentModel = "spring" for bean
• Incorrectly mapping ignored fields