使用 MapStruct 处理 Java 递归数据结构的序列化_技术教程

本文将介绍如何使用 MapStruct 处理 Java 中包含递归结构的数据序列化，例如树形结构。我们将以一个 Tree 类及其包含的 Leaf 类为例，演示如何使用 MapStruct 将其转换为对应的 TreeResponse 和 LeafResponse 类。

首先，我们来看一下需要转换的实体类和目标响应类：

@Builder
@Getter
@AllArgsConstructor
@FieldDefaults(level = PUBLIC)
public class Tree {
    String name;
    List leafs;
}

@Builder
@Getter
@AllArgsConstructor
@FieldDefaults(level = PUBLIC)
public class Leaf {
    String name;
    List children;
}

@Getter
@Setter
@FieldDefaults(level = PUBLIC)
public class TreeResponse {
    String name;
    List leafs;
}

@Getter
@Setter
@FieldDefaults(level = PUBLIC)
public class LeafResponse {
    String name;
    List children;
}

可以看到，Leaf 类包含一个 children 列表，该列表也是 Leaf 类型的，这就构成了一个递归结构。

为了使用 MapStruct 进行转换，我们需要定义两个 Mapper 接口：TreeMapper 和 LeafMapperSecond。

@Mapper
public interface TreeMapper {

    @Mapping(target = "name", source = "entity.name")
    TreeResponse map(Tree entity);
}

@Mapper
public interface LeafMapperSecond {
    LeafResponse map(Leaf entity);

    List map(List entity);
}

TreeMapper 负责将 Tree 对象转换为 TreeResponse 对象。LeafMapperSecond 负责将 Leaf 对象转换为 LeafResponse 对象，并且提供了一个用于转换 List 到 List 的方法。

关键点在于定义了两个 Mapper 接口，并且在 LeafMapperSecond 中定义了 List 转换方法。 MapStruct 会自动处理 List 的递归转换，无需手动编写复杂的递归逻辑。

现在，我们可以编写一个测试用例来验证转换是否正确：

private TreeMapper treeMapper = Mappers.getMapper(TreeMapper.class);
private LeafMapperSecond leafMapper = Mappers.getMapper(LeafMapperSecond.class);

@Test
public void test() {
    List leafs = new ArrayList<>();
    leafs.add(Leaf.builder().name("Leaf 1").build());

    leafs.add(
            Leaf.builder()
                    .name("Leaf 2")
                    .children(
                            Arrays.asList(
                                    Leaf.builder()
                                            .name("Leaf Children 1")
                                            .children(
                                                    Arrays.asList(
                                                            Leaf.builder()
                                                                    .name("Leaf Children 1.1")
                                                                    .build(),
                                                            Leaf.builder()
                                                                    .name("Leaf Children 1.2")
                                                                    .build()))
                                            .build(),
                                    Leaf.builder().name("Leaf Children 2").build()))
                    .build());

    Tree tree = Tree.builder().name("tree name").leafs(leafs).build();

    TreeResponse treeResponse = treeMapper.map(tree);

    assertEquals(treeResponse.name, "tree name");
    assertEquals(treeResponse.leafs.size(), 2);

    LeafResponse leafWithChildren =
            treeResponse.leafs.stream()
                    .filter(l -> l.name.equals("Leaf 2"))
                    .findFirst()
                    .orElse(null);
    assertNotNull(leafWithChildren);
    assertEquals(leafWithChildren.getChildren().size(), 2);

    LeafResponse leafWithSubChildren =
            leafWithChildren.children.stream()
                    .filter(l -> l.name.equals("Leaf Children 1"))
                    .findFirst()
                    .orElse(null);

    assertNotNull(leafWithSubChildren);
    assertEquals(leafWithChildren.getChildren().size(), 2);
}