DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Newsletter
Log In / Join
Refcards Trend Reports
Events Video Library
Refcards
Trend Reports

Events

View Events Video Library

Related

  • Implementing Low-Code Data Mapping in Java
  • IntelliJ and Java Spring Microservices: Productivity Tips With GitHub Copilot
  • Java 21 Record and Pattern Matching: Master Data-Oriented Programming[Video]
  • Comparing ModelMapper and MapStruct in Java: The Power of Automatic Mappers

Trending

  • Building a Grounded Search Agent With Foundry, Azure AI Search, and Cosmos DB, Containerized With Docker and Observed With Grafana
  • When Production Stops Moving: Running Claude Code Across a Distributed Enterprise Integration Team
  • Introduction to Error Prone: How to Catch Bugs at Compile Time
  • Microsoft Fabric Throttling: Diagnose Before You Scale

Draft This article hasn't been published, so readers can't see it.

In moderation This article is waiting for review, so readers can't see it yet.

Deleted This article has been deleted, so readers can't see it.

  1. DZone
  2. Testing, Deployment, and Maintenance
  3. Deployment
  4. My ModelMapper Cheat Sheet

My ModelMapper Cheat Sheet

Code samples of ModelMapper use cases such as adding custom mapping, saving custom mapping, and custom mapping with the builder pattern.

By 
Max Stepovyi
·
Jan. 18, 24 · Code Snippet
Post on X (opens in a new tab) Share on LinkedIn (opens in a new tab)
5.2K Views

Join the DZone community Save articles, join the discussion, and download Refcards and Trend Reports with a free account.

Join for free Already a member? Log in

As the title says, this article will list my cheat sheet for ModelMapper. It will not provide any deep-dive tutorials or fancy descriptions, just some use cases.

Models Used for This Article

Any time you see User, UserDTO, LocationDTO in the code, refer to this section.

Java
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String firstName;
    private String lastName;
    private List<String> subscriptions;
    private String country;
    private String city;
}
Java
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserDTO {
    private String firstName;
    private String secondName;
    private String subscriptions;
    private LocationDTO location;
}
Java
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class LocationDTO {
    private String country;
    private String city;
}


Basic typeMap Usage and addMapping

Use typeMap instead of createTypeMap when custom mapping is needed.

Example of how to map the lastName field to the secondName field.

Java
 
public UserDTO convert(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .addMapping(User::getLastName, UserDTO::setSecondName)
            .map(user);
}


The Actual createTypeMap and getTypeMap Usage

If you use createTypeMap, ensure to use getTypeMap. It is easy to forget, as everyone provides an example with createTypeMap, but calling it twice will throw an exception.

Java
 
public class CreateTypeMapConverter {

    private final ModelMapper modelMapper;

    public CreateTypeMapConverter(ModelMapper modelMapper) {
        this.modelMapper = modelMapper;
        // can be moved to a configuration class
        var typeMap = modelMapper.createTypeMap(User.class, UserDTO.class);
        typeMap.addMapping(User::getLastName, UserDTO::setSecondName);
    }

    public UserDTO convert(User user) {
        return modelMapper.getTypeMap(User.class, UserDTO.class).map(user);
    }
}


And it is always possible to do it lazily.

Java
 
public UserDTO convert(User user) {
    var typeMap = modelMapper.getTypeMap(User.class, UserDTO.class);
    if (typeMap == null) {
        typeMap = modelMapper.createTypeMap(User.class, UserDTO.class);
        typeMap.addMapping(User::getLastName, UserDTO::setSecondName);
    }
    return typeMap.map(user);
}


Adding Mapping for Setter With Converter or Use using

Here is an example of how to convert List to String with typeMap before we set this value to the DTOs setter. For this, we call using with our converter logic.

Java
 
public UserDTO convertWithUsing(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .addMappings(mapper -> {
                mapper.map(User::getLastName, UserDTO::setSecondName);
                mapper.using((MappingContext<List<String>, String> ctx) -> ctx.getSource() == null ? null : String.join(",", ctx.getSource()))
                        .map(User::getSubscriptions, UserDTO::setSubscriptions);
            })
            .map(user);
}


The same will work with any entity that requires custom conversion before setter.

ModelMapper Does Not Support Converting in addMapping

In the code sample, the value in the setter will be null, so we should avoid using addMapping to convert anything.

Java
 
// will throw NPE as o is null
public UserDTO addMappingWithConversion(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .addMapping(User::getLastName, UserDTO::setSecondName)
            // o is null
            .addMapping(User::getSubscriptions, (UserDTO dest, List<String> o) -> dest.setSubscriptions(String.join(",", o)))
            .map(user);
}


But ModelMapper Supports Nested Setter

Example of mapping country and city fields to the nested object LocationDTO.

Java
 
public UserDTO convertNestedSetter(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .addMapping(User::getLastName, UserDTO::setSecondName)
            .addMapping(User::getCountry, (UserDTO dest, String v) -> dest.getLocation().setCountry(v))
            .addMapping(User::getCity, (UserDTO dest, String v) -> dest.getLocation().setCity(v))
            .map(user);
}


Using preConverter and postConverter

Use when left with no choice or when conditionally needed to change the source or destination, but it’s hard or not possible with using.

Here is a super simplified example for preConverter:

Java
 
public UserDTO convertWithPreConverter(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .setPreConverter(context -> {
                context.getSource().setFirstName("Joe");
                return context.getDestination();
            })
            .addMapping(User::getLastName, UserDTO::setSecondName)
            .map(user);
}


The same logic is for postConverter.

Java
 
public UserDTO convertWithPostConverter(User user) {
    return modelMapper.typeMap(User.class, UserDTO.class)
            .setPostConverter(context -> {
                var location = new LocationDTO(context.getSource().getCountry(), context.getSource().getCity());
                context.getDestination().setLocation(location);
                return context.getDestination();
            })
            .addMapping(User::getLastName, UserDTO::setSecondName)
            .map(user);
}


Using With Builder

For immutable entities that use the builder pattern.

Model

Java
 
@Data
@Builder
public class UserWithBuilder {
    private final String firstName;
    private final String lastName;
}
Java
 
@Data
@Builder
public final class UserWithBuilderDTO {
    private final String firstName;
    private final String secondName;
}


Converter

Java
 
public class BuilderConverter {

    private final ModelMapper modelMapper;

    public BuilderConverter(ModelMapper modelMapper) {
        this.modelMapper = modelMapper;
        var config = modelMapper.getConfiguration().copy()
                .setDestinationNameTransformer(NameTransformers.builder())
                .setDestinationNamingConvention(NamingConventions.builder());
        var typeMap = modelMapper.createTypeMap(UserWithBuilder.class, UserWithBuilderDTO.UserWithBuilderDTOBuilder.class, config);
        typeMap.addMapping(UserWithBuilder::getLastName, UserWithBuilderDTO.UserWithBuilderDTOBuilder::secondName);

    }

    public UserWithBuilderDTO convert(UserWithBuilder user) {
        return modelMapper.getTypeMap(UserWithBuilder.class, UserWithBuilderDTO.UserWithBuilderDTOBuilder.class)
                .map(user).build();
    }
}


But if all entities use the builder pattern, the configuration can be set up globally.

The full source code for this article can be found on GitHub.

Builder pattern GitHub Java (programming language) Data mapping

Opinions expressed by DZone contributors are their own.

Related

  • Implementing Low-Code Data Mapping in Java
  • IntelliJ and Java Spring Microservices: Productivity Tips With GitHub Copilot
  • Java 21 Record and Pattern Matching: Master Data-Oriented Programming[Video]
  • Comparing ModelMapper and MapStruct in Java: The Power of Automatic Mappers

Partner Resources

×

Comments

Loading comments

The comments didn't load

Please try again in a moment.

Likes

Loading

The next likes didn't load. Please try again.

The likes didn't load

Please try again in a moment.

See who liked this

Log in or join DZone for free to see who liked this article.

Log in Join for free
  • RSS
  • X
  • Facebook

ABOUT US

  • About DZone
  • Support and feedback
  • Community research

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Core Program
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 3343 Perimeter Hill Drive
  • Suite 215
  • Nashville, TN 37211
  • [email protected]

Let's be friends:

  • RSS
  • X
  • Facebook