2024年4月4日发(作者：)

mapstruct 高级用法

1. 自定义映射器

MapStruct在大多数情况下可以自动生成映射器，但在某些情况下，我们可能需要进

行一些自定义映射操作。为此，MapStruct提供了自定义映射器的功能。自定义映射器可

以使用@Mapper组件的componentModel属性来指定生成的映射器采用“Spring”或“CDI”

等组件模型。

例如，我们可以自定义转换一个字符串到时间类型：

```

@Mapper(componentModel = "spring")

public interface CustomMapper {

@Mappings({

@Mapping(target = "timestamp", expression =

"java(().getEpochSecond())")

})

OrderDto toOrderDto(Order order);

在上面的例子中，自定义映射器定义了一个toLocalDateTime方法，该方法把一个字

符串转换成一个本地时间，然后在toOrderDto方法中使用Java 8时间API来获取当前时

间戳。

2. 过滤

有时候我们无需应用所有字段之间的映射，这时我们需要使用过滤器来跳过某些字段。

MapStruct提供了@MappingTarget注释来标识映射目标对象，并使用@Mappings注释配置

字段过滤。下面是一个例子：

在上述例子中， updateOrder方法被用于将OrderDto对象中的属性更新到Order对象

中。通过在@Mappings注释中使用ignore = true，我们可以忽略映射中的一些字段。

3. 后处理器

在某些情况下，我们可能需要在映射完成后进行一些操作，这时我们可以使用

MapStruct的后处理器（后处理器通常实现MapStruct的后处理器接口）。通过实现后处理

器接口，我们可以在生成的映射器上注册我们的后处理器实现，如下所示：

OrderMapper INSTANCE = per();

OrderDto toOrderDto(Order order);

在上述例子中，doSomething方法是后处理器方法。它将在toOrder或toOrderDto方

法执行后被执行。我们可以添加任何实现我们想要的处理逻辑。

4. 通过工厂类来创建目标对象

MapStruct提供了一个高级功能，它可以通过工厂类来创建目标对象并进行映射。您

可以通过指定@Mapper注释中的componentModel属性将映射器转换为Spring Bean或CDI

Bean。具体来说，我们可以使用@Mapper注释的factoryClass属性和factoryMethod属性

来指定工厂类的名称和方法名称，如下所示：

在上述例子中，我们使用OrderFactory类的createOrder方法来创建目标对象。

5. 使用Spring EL表达式

MapStruct支持Spring表达式语言（SpEL），我们可以在映射时使用SpEL来生成动态

表达式。例如：

```

@Mapper(componentModel = "spring")

public interface OrderMapper {

@Mappings({

@Mapping(target = "orderDate", expression =

"#{@Utils@hasText(source)?"

"(source,

_LOCAL_DATE_TIME).atZone(

Default()).toInstant():null}")

})

Order convert(String source);

}

```

在上述例子中，我们使用Spring EL表达式来检查source字符串是否为非空，如果是

非空，则把source字符串转换成ateTime对象。

6. 配置转换器

MapStruct提供了@MapperConfiguration注释来设置通用的映射配置。这样一旦通用

配置仅仅需要维护一次，就可以全局生效。我们可以定义一个另外的类（通常命名为

“MapperConfig”）来存放通用映射配置并返回一个类的实例，然后在映射接口中通过

@Mapper注释的“config”属性来引用。

例如：

在上述例子中，MappingConfig定义了一个copyIgnoreNull方法，该方法复制指定的

Order对象，但忽略所有空值字段。

7. 高级对象映射

MapStruct支持高级映射，例如将一个Map对象转换成一个Java Bean对象（或者将

Java Bean转换成Map）。为了进行高级映射操作，我们需要使用MapStruct提供的

MapStructMapper组件，并在@Mapper注释中指定映射器的类型。例如：

在上述示例中，我们定义了两个方法：toOrder和toMap方法。这两个方法分别将Map

对象转换为Order对象和将Order对象转换为Map对象。在@Mapper注释中使用type属性

指定映射器的类型为MapStructMapper组件。

总结

本文提供了一些MapStruct高级用法的示例。这些高级用法涉及到自定义映射器、过

滤、后处理器、通过工厂类创建目标对象、使用Spring EL表达式以及高级对象映射。通

过使用这些高级用法，我们可以更灵活地使用MapStruct生成的映射器来完成我们的映射

操作。