映射的快速指南

@mapper公共界面SimplesourceDestinationMapper {SimpleStination Sourcetodestination（SimpleSource Source）;SimpleSource DestinationToSource（SimpleStinal Destination）;｝

public class SimpleSourceDestinationMapperImpl implements SimpleSourceDestinationMapper {@Override public simplesdestination sourceToDestination(SimpleSource source) {if (source == null) {return null;} SimpleDestination SimpleDestination = new SimpleDestination();simpleDestination。setName (source.getName ());simpleDestination。setDescription (source.getDescription ());返回simpleDestination;} @Override public SimpleSource destinationToSource(SimpleDestination destination){if (destination == null){return null;} SimpleSource SimpleSource = new SimpleSource();simpleSource。setName( destination.getName() ); simpleSource.setDescription( destination.getDescription() ); return simpleSource; } }

@Test public void givenEmployeeDTOwithDiffNametoEmployee_whenMaps_thenCorrect() {EmployeeDTO dto = new EmployeeDTO();dto.setEmployeeId (1);dto.setEmployeeName(“约翰”);Employee entity = mapper.employeeDTOtoEmployee(dto);entity.getId assertequal (dto.getEmployeeId () ());entity.getName assertequal (dto.getEmployeeName () ());｝

private static final String DATE_FORMAT = "dd-MM-yyyy HH:mm:ss";@Test public void givenEmpStartDtMappingToEmpDTO_whenMaps_thenCorrect() throws ParseException{雇员实体=新雇员();实体。setStartDt(新日期());EmployeeDTO = mapper.employeeToEmployeeDTO(实体);SimpleDateFormat format = new SimpleDateFormat(DATE_FORMAT);assertequal (format.parse (dto.getEmployeeStartDt ()) .toString (), entity.getStartDt () .toString ());} @Test public void givenEmpDTOStartDtMappingToEmp_whenMaps_thenCorrect() throws ParseException {EmployeeDTO dto = new EmployeeDTO();dto。setEmployeeStartDt(“01-04-2016 01:00:00”); Employee entity = mapper.employeeDTOtoEmployee(dto); SimpleDateFormat format = new SimpleDateFormat(DATE_FORMAT); assertEquals(format.parse(dto.getEmployeeStartDt()).toString(), entity.getStartDt().toString()); }

9.使用抽象类进行映射

有时，我们可能想要以超出@Mapping功能的方式定制映射器。

例如，除了类型转换外，我们可能还希望以下面示例中的某种方式转换值。

在这种情况下，我们可以创建一个抽象类和实现我们想要定制的方法，并留下映射生成的方法。

9.1。基本模型

在此示例中，我们将使用以下类：

public class Transaction {private Long id;private String uuid = uuid . randomuuid ().toString();私人BigDecimal总;/ /标准getter}

和匹配的DTO:

公共类TransactionDto {私有字符串UUID;私人长的总体;//标准getters和setter}

这里的难点是转换大二世全部的数额的美元变成长totalInCents．

9.2。定义一个映射器

我们可以通过创造我们的映射器作为抽象类：

@Mapper抽象类TransactionMapper {public TransactionDTO toTransactionDTO(Transaction Transaction) {TransactionDTO TransactionDTO = new TransactionDTO();transactionDTO.setUuid (transaction.getUuid ());transactionDTO.setTotalInCents (transaction.getTotal () .multiply(新BigDecimal (" 100 ")) .longValue ());返回transactionDTO;}公共抽象列表 toTransactionDTO(集合<事务>事务);｝

在这里，我们已经为单个对象转换实现了完全定制的映射方法。

另一方面，我们离开了该方法，这意味着映射收藏到A.列表抽象的,所以映射将为我们实施。

9.3。生成的结果

由于我们已经实现了映射单个的方法交易进入A.TransactionDTO,我们预计映射在第二种方法中使用它。

将生成以下文件:

@ created class TransactionMapperImpl extends TransactionMapper {@Override public List toTransactionDTO(Collection transactions) {if (transactions == null) {return null;} List List = new ArrayList<>();for (Transaction Transaction: transactions) {list。add(toTransactionDTO(transaction));}返回列表;}}

正如我们在第12行看到的，映射在它生成的方法中使用我们的实现。

10.映射前标注和映射后标注

这是自定义的另一种方法@Mapping通过使用功能@BeforeMapping和@AfterMapping注释。注释用于标记在映射逻辑之前和之后调用的方法。

他们在我们可能想要的情况下非常有用应用于所有映射超类型的行为。

让我们看一个映射的子类型的示例车电子车和BioDieselCar来CarDTO．

在映射时，我们希望将类型的概念映射到FuelTypeDTO中的枚举字段。然后，在完成映射之后，我们希望将DTO的名称更改为大写。

10.1。基本模型

我们将使用以下类:

public class Car {private int id;私人字符串名称;｝

的子类型车：

public class BioDieselCar extends Car {}

public class ElectricCar extends Car {}

的CarDTO枚举现场类型FuelType：

public class CarDTO {private int id;私人字符串名称;私人FuelType FuelType;｝

Public Enum Fueltype {Electric，Bio_diesel}

10.2。定义映射器

现在让我们继续编写用于映射的抽象mapper类车来CarDTO：

@Mapper public抽象类CarsMapper {@BeforeMapping protected void fuldtowithfueltype (Car Car， @MappingTarget CarDTO CarDTO) {if (Car instanceof ElectricCar) {CarDTO . setfueltype (FuelType.ELECTRIC);} if (car instanceof BioDieselCar) {carDto.setFuelType(FuelType.BIO_DIESEL);}} @AfterMapping protected void convertNameToUpperCase(@MappingTarget CarDTO CarDTO) {CarDTO . setname (CarDTO . getname ().toUpperCase());} public abstract CarDTO toCarDto(Car Car);｝

@MappingTarget参数注释是这样的吗在执行映射逻辑之前填充目标映射DTO在的情况下@BeforeMapping和就在之后以防@AfterMapping注释方法。

10.3。结果

的Carsmapper.上面定义的生成的执行：

@Generated public class CarsMapperImpl extends CarsMapper {@Override public CarDTO toCarDto(Car Car) {if (Car == null) {return null;} CarDTO CarDTO = new CarDTO();enrichDTOWithFuelType(汽车,carDTO);carDTO.setId (car.getId ());carDTO.setName (car.getName ());convertNameToUpperCase (carDTO);返回carDTO;}}

注意带注释的方法调用围绕着映射逻辑在实施中。

11.支持龙目岛

在最近的Mapstruct版本中，龙目岛支持已宣布。因此，我们可以轻松地使用Lombok映射源实体和目的地。

要启用Lombok支持，我们需要添加依赖在注释处理器路径中。现在我们有MapStruct-Processor以及Maven Compiler插件中的龙眼洛克：

  org.apache.maven.plugins   Maven-Compiler-Plugin   3.5.1    1.8  1.8     org.mapstruct   Mapstruct-Processor   1.3.1.final   org.projectlombok lombok 1.18.4