Java bean mappings, the easy way!

Get started Download

What is it?

MapStruct is a code generator that greatly simplifies the implementation of mappings between Java bean types based on a convention over configuration approach.

The generated mapping code uses plain method invocations and thus is fast, type-safe and easy to understand.


Multi-layered applications often require to map between different object models (e.g. entities and DTOs). Writing such mapping code is a tedious and error-prone task. MapStruct aims at simplifying this work by automating it as much as possible.

In contrast to other mapping frameworks MapStruct generates bean mappings at compile-time which ensures a high performance, allows for fast developer feedback and thorough error checking.


MapStruct is an annotation processor which is plugged into the Java compiler and can be used in command-line builds (Maven, Gradle etc.) as well as from within your preferred IDE.

MapStruct uses sensible defaults but steps out of your way when it comes to configuring or implementing special behavior.

Latest News

MapStruct 1.2.0.Beta3 is out

The summer is nearly there, and so is MapStruct 1.2. Today it’s my pleasure to announce another release on our way to the Final: MapStruct 1.2 Beta 3!

This release continues to improve and stabilize the new feature of automatically creating sub-mapping methods. By default, no sub-mapping methods are generated for any types of the JDK (as those are typically no bean types which one would like to step into in the course of mapping). If more fine-grained control is needed, there is an SPI now which lets you define for which types sub-mapping methods should be created. Eventually, you also can turn off automatic sub-mappings completely if you prefer to have full control by explicitly defining all required bean mapping methods.

Besides that, several bugs were fixed:

  • The generated mappers were missing import statements in some cases (#1215, #1164)
  • Field mappings didn’t work for nested target properties (#1155)
  • Accessing a non-existent nested target property wasn’t handled gracefully (#1153)


MapStruct 1.2.0.Beta2 released

Just shy of a month after the first Beta release of MapStruct 1.2, the team is happy to announce the second Beta, fixing a couple of bugs that sneaked in with the many new features offered by the new 1.2 release line.

We fixed 16 issues, most of them reported by users. The most infamous bugs reported and fixed are:

Plus, the newly introduced automapping feature now also creates Enum mapping methods.


Support for Lombok, direct field access and much more: MapStruct 1.2.0.Beta1 is out

It’ my pleasure to announce the first Beta release of MapStruct 1.2.

The new release comes with a whole lot of new functionality, e.g.:

  • MapStruct can now be used together with Project Lombok
  • Support for Java 8 streams
  • Mappings based on public fields (i.e. you can write DTOs without getters and setters)
  • Automatic creation of sub-mapping methods
  • Mapping methods can take “pass-through” context parameters, addressing different use cases like
    • Passing a locale, timezone or similar to custom mapping methods
    • Keeping track of processed nodes in circular object graphs
  • Target bean factory methods can access a mapping’s source parameter(s)


MapStruct in 2 Minutes

The following shows how map two objects using MapStruct.

Let's assume we have a class representing cars (e.g. a JPA entity) and an accompanying data transfer object (DTO).

Both types are rather similar, only the seat count attributes have different names and the type attribute is of a special enum type in the Car class but is a plain string in the DTO.

  • public class Car {
        private String make;
        private int numberOfSeats;
        private CarType type;
        //constructor, getters, setters etc.
  • public class CarDto {
        private String make;
        private int seatCount;
        private String type;
        //constructor, getters, setters etc.

The mapper interface

To generate a mapper for creating a CarDto object out of a Car object, a mapper interface needs to be defined:

    1. @Mapper 1
    2. public interface CarMapper {
    4. CarMapper INSTANCE = Mappers.getMapper( CarMapper.class ); 3
    6. @Mapping(source = "numberOfSeats", target = "seatCount")
    7. CarDto carToCarDto(Car car); 2
    8. }

The @Mapper annotation 1 marks the interface as mapping interface and lets the MapStruct processor kick in during compilation.

The actual mapping method 2 expects the source object as parameter and returns the target object. Its name can be freely chosen.

For attributes with different names in source and target object, the @Mapping annotation can be used to configure the names.

Where required and possible a type conversion will be executed for attributes with different types in source and target, e.g. the type attribute will be converted from the enumeration type into a string.

Of course there can be multiple mapping methods in one interface, for all of which an implementation will be generated by MapStruct.

An instance of the interface implementation can be retrieved from the Mappers class. By convention, the interface declares a member INSTANCE 3, providing clients access to the mapper implementation.

Using the mapper

Based on the mapper interface, clients can perform object mappings in a very easy and type-safe manner:

  • @Test
    public void shouldMapCarToDto() {
        Car car = new Car( "Morris", 5, CarType.SEDAN );
        CarDto carDto = CarMapper.INSTANCE.carToCarDto( car );
        assertThat( carDto ).isNotNull();
        assertThat( carDto.getMake() ).isEqualTo( "Morris" );
        assertThat( carDto.getSeatCount() ).isEqualTo( 5 );
        assertThat( carDto.getType() ).isEqualTo( "SEDAN" );

Tell me more!

You like what you see? Then check out the reference documentation to learn how to get started with MapStruct and which advanced features there are. In case you need help or want to propose a new feature just drop by on the mapstruct-users group.

You want to contribute to the development of MapStruct? That's great, this page has all the information you need.