关于MapStruct的使用教程

2025-02-08 15:28:10 作者：wujiada001

MapStruct 是一个用于 Java Bean 映射的代码生成器,通过注解处理器自动生成映射代码,以下是 MapStruct 的基本使用方法：添加依赖、定义映射接口、使用映射方法、定义自定义映射方法、处理复杂映射、集成 Spring 等

MapStruct的使用

MapStruct 是一个代码生成器，它使用注解处理器来实现 Java bean 之间的映射。

MapStruct 通过在编译时自动生成映射代码，减少了手动编写映射代码的工作量，并帮助保持代码的一致性和准确性。

以下是 MapStruct 的基本使用方法：

1. 添加依赖

首先，你需要在项目的构建配置中添加 MapStruct 的依赖。对于 Maven 和 Gradle，添加如下依赖：

Maven:

<dependencies>
    <dependency>
        <groupId>org.mapstruct</groupId>
        <artifactId>mapstruct</artifactId>
        <version>1.4.2.Final</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>1.4.2.Final</version>
                    </path>
                </annotationProcessorPaths>
            </configuration>
        </plugin>
    </plugins>
</build>

Gradle:

dependencies {
    implementation 'org.mapstruct:mapstruct:1.4.2.Final'
    annotationProcessor 'org.mapstruct:mapstruct-processor:1.4.2.Final'
}

2. 定义映射接口

创建一个接口，并使用 @Mapper 注解标注，这个接口将定义源对象和目标对象之间的映射规则。

import org.mapstruct.Mapper;
import org.mapstruct.factory.Mappers;

@Mapper
public interface MyMapper {
    MyMapper INSTANCE = Mappers.getMapper(MyMapper.class);

    // 定义从源对象到目标对象的映射方法
    TargetObject map(SourceObject source);
}

3. 使用映射方法

在业务逻辑中，你可以使用定义的映射接口来转换对象。

public class MyService {
    public TargetObject convert(SourceObject source) {
        return MyMapper.INSTANCE.map(source);
    }
}

4. 定义自定义映射方法

如果需要自定义映射逻辑，可以定义一个带有 @Mapping 注解的方法，并在其中指定映射规则。

@Mapper
public interface MyMapper {
    @Mapping(target = "targetProperty", source = "sourceProperty")
    @Mapping(target = "targetProperty2", expression = "java(String.valueOf(source.getSourceProperty2()))")
    TargetObject map(SourceObject source);
}

5. 处理复杂映射

在这个例子中，@Mapping注解用于指定源对象和目标对象之间的属性映射关系。source属性指定源对象的属性名，target属性指定目标对象的属性名。

@Mapper
public interface MyMapper {
    @Mapping(target = "dateOfBirth", source = "birthYear", qualifiedByName = "yearToCalendar")
    TargetObject map(SourceObject source);

    @Named("yearToCalendar")
    default Date yearToCalendar(int year) {
        Calendar calendar = Calendar.getInstance();
        calendar.set(year, Calendar.JANUARY, 1);
        return calendar.getTime();
    }
}

对于更复杂的映射场景，比如需要转换数据类型或者调用方法，MapStruct 也提供了相应的注解来支持。

自定义映射：可以使用@Mapping注解的expression或qualifiedByName属性来自定义映射逻辑。
集合映射：可以使用@IterableMapping和@MapMapping注解来处理集合类型的映射。
枚举映射：可以直接映射枚举类型，或者通过@Mapping注解的enumNamed属性来指定枚举的映射规则。
使用构造函数映射：如果目标类有构造函数，可以使用@Mapping注解的constructor属性来指定使用构造函数进行映射。
嵌套属性映射：可以映射嵌套的对象属性。
反向映射：可以定义一个反向映射方法，并使用@Mapping注解的inverse属性来引用正向映射方法。
使用装饰器增强Mapper：可以使用@DecoratedWith注解来装饰Mapper接口，以实现更复杂的映射逻辑。
映射继承：可以通过继承来共享映射配置。
使用@BeforeMapping和@AfterMapping进行预处理和后处理：可以在映射方法执行前后执行自定义的逻辑。
使用@Context传递上下文参数：可以在映射方法中传递额外的上下文参数。

6. 集成 Spring

MapStruct还可以与Spring框架集成，允许在映射器中注入Spring管理的bean。

这需要在Mapper接口上使用@Mapper(componentModel = "spring")注解来指定Spring作为组件模型。然后，可以使用@Autowired注解来注入Spring管理的bean。

@Mapper(componentModel = "spring")
public interface MyMapper {
    TargetObject map(SourceObject source);
}

这样，MapStruct 映射器就可以作为 Spring Bean 进行自动装配。

通过使用 MapStruct，你可以减少手动编写的样板代码，提高开发效率，并减少因手动映射而产生的错误。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。