MapStruct 解锁从容应对 null 值的映射策略

2022-12-18 14:53:58

MapStruct：处理 null 值的大师

MapStruct 概述

MapStruct 是一款 Java 对象映射框架，以其简洁的注解语法和高效的映射性能而广受赞誉。有了 MapStruct，你可以轻松地将源对象转换为目标对象，无需编写繁琐的手工映射代码。它不仅提高了开发效率，还确保了映射过程的准确性和一致性。

MapStruct 处理 null 值的策略

在实际应用中，源对象或目标对象中经常会出现 null 值，这给映射过程带来了不小的挑战。MapStruct 提供了多种策略来处理 null 值，帮助开发者从容应对复杂多变的映射场景。

1. 忽略 null 值

这是最简单也是最常用的策略。当源对象中存在 null 值时，MapStruct 会直接忽略该值，不会将其映射到目标对象中。这种策略适用于那些不需要在目标对象中保留 null 值的情况。

2. 映射为 null 值

这种策略与忽略 null 值相反，当源对象中存在 null 值时，MapStruct 会将该值映射为目标对象中的 null 值。这种策略适用于那些需要在目标对象中保留 null 值的情况。

3. 映射为默认值

这种策略允许开发者指定一个默认值，当源对象中存在 null 值时，MapStruct 会将该值映射为指定的默认值。这种策略适用于那些需要在目标对象中填充默认值的情况。

4. 自定义映射

如果上述策略都不能满足你的需求，你可以使用自定义映射来处理 null 值。通过自定义映射，你可以编写自己的代码来控制如何处理 null 值。这种策略适用于那些需要进行复杂映射的情况。

选择合适的策略

在选择 MapStruct 处理 null 值的策略时，需要根据具体情况进行考虑。以下是一些需要注意的因素：

目标对象的类型 ：如果目标对象是基本数据类型或不可变对象，那么可以使用忽略 null 值或映射为 null 值的策略。如果目标对象是可变对象，那么可以使用映射为默认值或自定义映射的策略。
映射场景的复杂性 ：如果映射场景比较简单，那么可以使用忽略 null 值或映射为 null 值的策略。如果映射场景比较复杂，那么可以使用映射为默认值或自定义映射的策略。
性能要求 ：如果对性能要求比较高，那么可以使用忽略 null 值或映射为 null 值的策略。如果对性能要求不高，那么可以使用映射为默认值或自定义映射的策略。

MapStruct 处理 null 值的示例

为了更好地理解 MapStruct 处理 null 值的策略，我们来看一个示例。假设我们有一个源对象 Person，它包含 name、age 和 address 三个属性。目标对象 PersonDTO 也包含这三个属性。我们希望使用 MapStruct 将 Person 对象映射为 PersonDTO 对象。

@Mapper
public interface PersonMapper {

    PersonDTO toPersonDTO(Person person);

}

在上面的示例中，我们使用 MapStruct 注解来生成 PersonMapper 接口。该接口包含一个 toPersonDTO() 方法，用于将 Person 对象映射为 PersonDTO 对象。默认情况下，MapStruct 会忽略 Person 对象中的 null 值。如果我们希望将 Person 对象中的 null 值映射为 PersonDTO 对象中的 null 值，可以在 toPersonDTO() 方法上添加 @Mapping 注解。

@Mapper
public interface PersonMapper {

    @Mapping(target = "name", nullValuePropertyMapping = "name")
    @Mapping(target = "age", nullValuePropertyMapping = "age")
    @Mapping(target = "address", nullValuePropertyMapping = "address")
    PersonDTO toPersonDTO(Person person);

}