MapStruct 使用教程

### ### MapStruct 使用教程及对象映射方法 MapStruct 是一种基于注解的 Java Bean 映射工具，它通过在编译时生成类型安全的映射代码，避免了运行时使用反射所带来的性能开销。这种方式不仅提高了映射效率，还增强了代码的可维护性，特别适用于 DTO（数据传输对象）与 Entity（实体）之间的转换[^1]。 #### 引入依赖 在使用 MapStruct 之前，需要在项目中引入其依赖。Maven 项目可以通过以下方式添加依赖： ```xml <dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct</artifactId> <version>1.5.2.Final</version> </dependency> ``` 此外，还需要确保项目中包含了 MapStruct 的编译插件，以便在编译阶段生成映射实现类。 #### 定义 Mapper 接口 MapStruct 的核心在于通过接口定义映射关系，开发者只需声明接口和方法，具体的实现类将由 MapStruct 自动生成。以下是一个典型的 Mapper 接口示例： ```java import org.mapstruct.Mapper; import org.mapstruct.Mapping; import org.mapstruct.factory.Mappers; @Mapper public interface CarMapper { CarMapper INSTANCE = Mappers.getMapper(CarMapper.class); @Mapping(source = "numberOfSeats", target = "seatCount") CarDto carToCarDto(Car car); @Mapping(target = "id", ignore = true) @Mapping(source = "seatCount", target = "numberOfSeats") Car carDtoToCar(CarDto carDto); } ``` 在这个例子中，`@Mapper` 注解表明这是一个 MapStruct 的映射接口。`@Mapping` 注解用于定义源对象和目标对象之间的字段映射关系。例如，`numberOfSeats` 字段映射到目标对象的 `seatCount` 字段。此外，`ignore = true` 表示忽略某些字段的映射[^4]。 #### 使用 @BeforeMapping 和 @AfterMapping 注解 在某些情况下，映射前后可能需要执行一些自定义逻辑。MapStruct 提供了 `@BeforeMapping` 和 `@AfterMapping` 注解来满足这一需求。以下是一个示例： ```java @Mapper public abstract class CarMapper { @BeforeMapping protected void enrichCar(Car car) { car.setMake(car.getMake().toUpperCase()); } @Mapping(source = "numberOfSeats", target = "seatCount") public abstract CarDto carToCarDto(Car car); @AfterMapping protected void enrichDto(Car car, @MappingTarget CarDto carDto) { carDto.setSeatCount(car.getNumberOfSeats()); } } ``` 在 `@BeforeMapping` 中，可以对源对象进行预处理，例如将字段值转换为大写。而在 `@AfterMapping` 中，则可以对目标对象进行后处理，例如设置额外的字段值。 #### 性能优势 MapStruct 的最大优势在于其性能。由于映射代码是在编译时生成的，因此避免了运行时反射带来的性能损耗。相比之下，其他基于反射的映射工具（如 BeanUtils）在性能上通常不如 MapStruct[^2]。 #### 适用场景 MapStruct 适用于 Java Bean 之间的转换，尤其适合在 DTO 与 Entity 之间进行映射。这种场景下，对象结构通常较为复杂，手动编写映射代码不仅繁琐，而且容易出错。MapStruct 通过注解驱动的方式，简化了映射过程，提高了开发效率[^3]。 ---