MapStruct 使用带参数构造函数生成 Mapper

MapStruct 默认使用无参构造函数和 setter 方法来创建目标对象。本文将介绍如何配置 MapStruct，使其使用带参数的构造函数来实例化目标对象，从而简化映射逻辑并提高代码效率。通过 @Default 注解或其他配置，可以轻松实现这一目标，优化对象映射过程。

MapStruct 与构造函数映射

MapStruct 旨在简化 Java Bean 之间的映射。通常，它会生成使用默认构造函数和 setter 方法的 mapper。然而，在某些情况下，使用带参数的构造函数可以更有效地创建目标对象。从 1.4 版本开始，MapStruct 支持使用构造函数来实例化映射目标。

配置 MapStruct 使用带参数的构造函数

以下是一些配置 MapStruct 以使用带参数的构造函数的方法：

1. 使用 @Default 注解

最简单的方法是将带参数的构造函数标记为 @Default。这告诉 MapStruct 优先使用此构造函数。

例如，假设我们有以下类：

public class FlightBooking {
    private String flight_booking_id;

    public FlightBooking() {
    }

    @Default
    public FlightBooking(String flight_booking_id) {
        this.flight_booking_id = flight_booking_id;
    }

    public String getFlight_booking_id() {
        return flight_booking_id;
    }

    public void setFlight_booking_id(String flight_booking_id) {
        this.flight_booking_id = flight_booking_id;
    }
}

和以下的 DTO 类：

public class FlightBookingPostRequestDto {
    private String booking_id;

    public String getBooking_id() {
        return booking_id;
    }

    public void setBooking_id(String booking_id) {
        this.booking_id = booking_id;
    }
}

Mapper 接口如下：

@Mapper(componentModel = "spring")
public interface FlightMapper {
    FlightBooking  flightBookingPostRequestDtoToFlightBooking(FlightBookingPostRequestDto flightBookingDto);
}

MapStruct 将生成以下代码：

@Component
public class FlightMapperImpl implements FlightMapper {

    @Override
    public FlightBooking flightBookingPostRequestDtoToFlightBooking(FlightBookingPostRequestDto flightBookingDto) {
        if ( flightBookingDto == null ) {
            return null;
        }

        String booking_id = flightBookingDto.getBooking_id();
        FlightBooking flightBooking = new FlightBooking( booking_id );

        return flightBooking;
    }
}

2. 多个构造函数的场景

如果存在多个带参数的构造函数，MapStruct 会尝试选择最合适的构造函数。 它会考虑参数类型和名称，并尝试找到与源对象属性匹配的构造函数。

3. 使用 @Mapping 注解指定构造函数参数

如果 MapStruct 无法自动确定正确的构造函数参数，可以使用 @Mapping 注解来显式指定。

例如：

@Mapper(componentModel = "spring")
public interface FlightMapper {
    @Mapping(target = "flight_booking_id", source = "booking_id")
    FlightBooking  flightBookingPostRequestDtoToFlightBooking(FlightBookingPostRequestDto flightBookingDto);
}

在这种情况下，@Mapping 注解将 FlightBooking 构造函数的 flight_booking_id 参数映射到 FlightBookingPostRequestDto 的 booking_id 属性。 虽然这个例子和第一个例子结果相同，但是更加明确的指定了映射关系。

注意事项

• 确保目标类具有带参数的构造函数。
• 如果使用 @Default 注解，请确保只在一个构造函数上使用它。
• 仔细检查生成的代码，以确保 MapStruct 选择了正确的构造函数和参数。

总结

通过使用带参数的构造函数，可以简化 MapStruct 的映射过程，并提高代码的可读性和效率。 @Default 注解和 @Mapping 注解提供了灵活的方式来配置 MapStruct，使其能够根据您的特定需求生成 mapper。 掌握这些技巧可以帮助您更有效地使用 MapStruct，并编写更简洁、更易于维护的代码。