超详细 mapstruct 简化教程

@Mapper(componentModel = "spring")

public interface CarDtoMapper{

    Car dtoToEntity(CarDto dto);

}

@Generated(

    value = "org.mapstruct.ap.MappingProcessor",

    date = "2021-04-26T11:02:50+0800",

    comments = "version: 1.4.2.Final, compiler: IncrementalProcessingEnvironment from gradle-language-java-6.8.jar, environment: Java 1.8.0_211 (Oracle Corporation)"

)

@Component

public class CarDtoMapperImpl implements CarDtoMapper {

    @Override

    public Car dtoToEntity(CarDto dto) {

        if ( dto == null ) {

            return null;

        }

        Car car = new Car();

        car.setName( dto.getName() );

        return car;

    }

}

@InheritInverseConfiguration(name = "dtoToEntity")    

CarDto entityToDto(Car dto);

Car dtoMapToEntity(CarDto dto, @MappingTarget Car car)

CarDto entityMapToDto(Car dto, @MappingTarget CarDto car);

Car car = mapper.map(dto, Car.class);

// or

Car car = new Car();

mapper.map(dto, car);

//  反向映射

CarDto dto = mapper.map(entity, CarDto.class);

// or

CarDto dto = new CarDto();

mapper.map(entity, dto);

@Mapper(config = MapperSpringConfig.class)

public interface CarMapper extends Converter<Car, CarDto> {

    @Mapping(target = "seats", source = "seatConfiguration")

    CarDto convert(Car car);

}

  @ComponentScan("org.mapstruct.extensions.spring")

  @Component

  static class AdditionalBeanConfiguration {

    @Bean

    ConfigurableConversionService getConversionService() {

      return new DefaultConversionService();

    }

  }

  @BeforeEach

  void addMappersToConversionService() {

    conversionService.addConverter(carMapper);

    conversionService.addConverter(seatConfigurationMapper);

    conversionService.addConverter(wheelMapper);

    conversionService.addConverter(wheelsMapper);

    conversionService.addConverter(wheelsDtoListMapper);

  }

  @Test

  void shouldKnowAllMappers() {

    then(conversionService.canConvert(Car.class, CarDto.class)).isTrue();

    then(conversionService.canConvert(SeatConfiguration.class, SeatConfigurationDto.class)).isTrue();

    then(conversionService.canConvert(Wheel.class, WheelDto.class)).isTrue();

    then(conversionService.canConvert(Wheels.class, List.class)).isTrue();

    then(conversionService.canConvert(List.class, Wheels.class)).isTrue();

  }

  @Test

  void shouldMapAllAttributes() {

    // Given

    final Car car = new Car();

    car.setMake(TEST_MAKE);

    car.setType(TEST_CAR_TYPE);

    final SeatConfiguration seatConfiguration = new SeatConfiguration();

    seatConfiguration.setSeatMaterial(TEST_SEAT_MATERIAL);

    seatConfiguration.setNumberOfSeats(TEST_NUMBER_OF_SEATS);

    car.setSeatConfiguration(seatConfiguration);

    final Wheels wheels = new Wheels();

    final ArrayList<Wheel> wheelsList = new ArrayList<>();

    final Wheel wheel = new Wheel();

    wheel.setDiameter(TEST_DIAMETER);

    wheel.setPosition(TEST_WHEEL_POSITION);

    wheelsList.add(wheel);

    wheels.setWheelsList(wheelsList);

    car.setWheels(wheels);

    // When

    final CarDto mappedCar = conversionService.convert(car, CarDto.class);

}

<properties>

    <org.mapstruct.version>1.4.2.Final</org.mapstruct.version>

    <io.github.zhaord.version>1.0.1.RELEASE</io.github.zhaord.version>

</properties>

...

<dependencies>

    <dependency>

        <groupId>org.mapstruct</groupId>

        <artifactId>mapstruct</artifactId>

        <version>${org.mapstruct.version}</version>

    </dependency>

    <dependency>

        <groupId>io.github.zhaord</groupId>

        <artifactId>mapstruct-spring-plus-boot-starter</artifactId>

        <version>${io.github.zhaord.version}</version>

    </dependency>

</dependencies>

...

<build>

    <plugins>

        <plugin>

            <groupId>org.apache.maven.plugins</groupId>

            <artifactId>maven-compiler-plugin</artifactId>

            <version>3.8.1</version>

            <configuration>

                <source>1.8</source>

                <target>1.8</target>

                <annotationProcessorPaths>

                    <path>

                        <groupId>org.mapstruct</groupId>

                        <artifactId>mapstruct-processor</artifactId>

                        <version>${org.mapstruct.version}</version>

                    </path>

                    <path>

                        <groupId>io.github.zhaord</groupId>

                        <artifactId>mapstruct-spring-plus-processor</artifactId>

                        <version>${io.github.zhaord.version}</version>

                    </path>

                </annotationProcessorPaths>

            </configuration>

        </plugin>

    </plugins>

</build>

dependencies {

    ...

    compile 'org.mapstruct:mapstruct:1.4.2.Final'

    compile 'io.github.zhaord:mapstruct-spring-plus-boot-starter:1.0.1.RELEASE'

    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'

    testAnnotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final' // if you are using mapstruct in test code

    annotationProcessor 'io.github.zhaord:mapstruct-spring-plus-processor:1.0.1.RELEASE'

    testAnnotationProcessor 'io.github.zhaord:mapstruct-spring-plus-processor:1.0.1.RELEASE' // if you are using mapstruct in test code

    ...

}

public enum CarType {

    SPORTS, OTHER

}

@Data

public class Car {

    private String make;

    private CarType type;

}

@Data

@AutoMap(targetType = Car.class)

public class CarDto {

    private String make;

    private String type;

}

@ExtendWith(SpringExtension.class)

@ContextConfiguration(

        classes = {AutoMapTests.AutoMapTestConfiguration.class})

public class AutoMapTests {

    @Autowired

    private IObjectMapper mapper;

    @Test

    public void testDtoToEntity() {

        var dto = new CarDto();

        dto.setMake("M1");

        dto.setType("OTHER");

        Car entity = mapper.map(dto, Car.class);

        assertThat(entity).isNotNull();

        assertThat(entity.getMake()).isEqualTo("M1");

        assertThat(entity.getCarType()).isEqualTo("OTHER");

    }

    @ComponentScan("io.github.zhaord.mapstruct.plus")

    @Configuration

    @Component

    static class AutoMapTestConfiguration {

    }

}

@Mapper(

    config = AutoMapSpringConfig.class,

    uses = {}

)

public interface CarDtoToCarMapper extends BaseAutoMapper<CarDto, Car> {

  @Override

  @Mapping(

      ignore = false

  )

  Car map(final CarDto source);

  @Override

  @Mapping(

      ignore = false

  )

  Car mapTarget(final CarDto source, @MappingTarget final Car target);

}