MapStruct for automatic mapping in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is MapStruct in Spring Boot?

MapStruct is a code generator that simplifies mapping between Java objects, especially between DTOs and entities, by generating type-safe mappers at compile time.

beginner

How does MapStruct improve mapping compared to manual mapping?

MapStruct generates mapping code automatically, reducing boilerplate, avoiding runtime errors, and improving performance by doing mapping at compile time instead of reflection.

beginner

What annotation do you use to define a MapStruct mapper interface?

You use the @Mapper annotation on an interface to tell MapStruct to generate the implementation for mapping methods defined inside.

intermediate

How do you get an instance of a MapStruct mapper in your Spring Boot application?

You can add componentModel = "spring" in @Mapper to make MapStruct generate a Spring bean, then inject it with @Autowired or constructor injection.

intermediate

What happens if source and target fields have different names in MapStruct?

You can use @Mapping annotation on the method to specify how fields with different names map to each other, by defining source and target explicitly.

What does MapStruct generate for you?

A Database schema migration scripts

B XML configuration files for mapping

C Runtime reflection-based mappers

D Java code for mapping between objects at compile time

MapStruct generates Java code at compile time to map between objects, avoiding runtime reflection.

Which annotation marks an interface as a MapStruct mapper?

A @Mapper

B @Entity

C @Component

D @Service

The @Mapper annotation tells MapStruct to generate the implementation for the interface.

How do you make a MapStruct mapper a Spring bean?

A Add @Component on the interface

B Add componentModel = "spring" in @Mapper

C Use @Autowired on the interface

D Add @Service on the implementation

Setting componentModel = "spring" in @Mapper makes MapStruct generate a Spring bean.

If source and target fields have different names, how do you map them?

A Use @Mapping annotation with source and target attributes

B MapStruct maps them automatically

C Rename fields manually in both classes

D Use @Autowired to inject mapping

You specify field mappings explicitly with @Mapping(source = ..., target = ...).

What is a main benefit of MapStruct over manual mapping?

A It requires no annotations

B It uses reflection at runtime

C It generates mapping code at compile time for better performance

D It only works with XML files

MapStruct generates code at compile time, improving performance and safety.

Explain how MapStruct helps in mapping between DTOs and entities in Spring Boot.

Think about how MapStruct reduces manual coding and errors.

Describe how you handle mapping fields with different names using MapStruct.

Focus on the annotation that lets you define explicit field mappings.

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