MapStruct：从入门到精通（第一部分）

后端

2023-10-09 02:13:08

作为一名技术专家，我很高兴有机会深入探究MapStruct，一个基于APT的高性能、类型安全的Java bean映射框架。本系列文章的第一部分将带你踏上MapStruct之旅，从基础概念到实际应用。

引言

在现代软件开发中，处理不同数据结构之间的转换是一个常见的挑战。传统方法往往涉及编写繁琐且容易出错的手动映射代码。MapStruct通过自动化此过程并提供类型安全的映射，彻底改变了这一局面。

基础概念

MapStruct的核心在于APT（注解处理工具），它在编译时分析带有特定注解的代码，并生成相应的映射实现。这些注解指导MapStruct如何将源对象转换为目标对象。

入门

入门MapStruct非常简单。首先，在你的项目中添加MapStruct依赖项。接下来，为要映射的类创建接口，并使用@Mapper注解进行注释。MapStruct将根据接口中的方法自动生成映射实现。

例如：

@Mapper
public interface PersonMapper {

    PersonDto toDto(Person person);

    Person fromDto(PersonDto personDto);
}

使用方法

使用MapStruct映射非常简单。只需实例化Mapper接口，然后调用相应的映射方法。例如：

PersonMapper mapper = Mappers.getMapper(PersonMapper.class);

PersonDto personDto = mapper.toDto(person);

高级用法

MapStruct提供了一系列高级功能，包括：

自定义映射： 使用@Mapping注解自定义映射规则。
属性过滤： 使用@Ignore注解排除不需要映射的属性。
条件映射： 使用@Condition注解基于特定条件进行有条件映射。

示例

为了演示MapStruct的强大功能，让我们创建一个将Person对象映射到PersonDto对象的示例：

@Entity
public class Person {

    @Id
    private Long id;

    private String name;

    private int age;
}

@Data
public class PersonDto {

    private Long id;

    private String displayName;

    private String ageGroup;
}

@Mapper(uses = { AgeGrouper.class })
public interface PersonMapper {

    @Mapping(source = "name", target = "displayName")
    @Mapping(source = "age", target = "ageGroup", qualifiedByName = "toAgeGroup")
    PersonDto toDto(Person person);

    @Mapping(source = "displayName", target = "name")
    @Mapping(source = "ageGroup", target = "age", qualifiedByName = "toAge")
    Person fromDto(PersonDto personDto);

    @Named("toAgeGroup")
    default String toAgeGroup(int age) {
        return age > 18 ? "Adult" : "Child";
    }

    @Named("toAge")
    default int toAge(String ageGroup) {
        return ageGroup.equals("Adult") ? 19 : 0;
    }
}