
本文将介绍如何使用 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。
立即学习“Java免费学习笔记(深入)”;
@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
关键点在于定义了两个 Mapper 接口,并且在 LeafMapperSecond 中定义了 List 转换方法。 MapStruct 会自动处理 List 的递归转换,无需手动编写复杂的递归逻辑。
基于Intranet/Internet 的Web下的办公自动化系统,采用了当今最先进的PHP技术,是综合大量用户的需求,经过充分的用户论证的基础上开发出来的,独特的即时信息、短信、电子邮件系统、完善的工作流、数据库安全备份等功能使得信息在企业内部传递效率极大提高,信息传递过程中耗费降到最低。办公人员得以从繁杂的日常办公事务处理中解放出来,参与更多的富于思考性和创造性的工作。系统力求突出体系结构简明
现在,我们可以编写一个测试用例来验证转换是否正确:
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);
} 在这个测试用例中,我们创建了一个包含嵌套 Leaf 对象的 Tree 对象,然后使用 TreeMapper 将其转换为 TreeResponse 对象。最后,我们断言转换后的 TreeResponse 对象中的数据是否与预期一致。
注意事项:
- 确保 MapStruct 的依赖已正确添加到项目中。
- 使用 @Mapper 注解标记 Mapper 接口。
- 对于递归结构,需要定义多个 Mapper 接口,并提供 List 转换方法。
- MapStruct 会自动处理 List 的递归转换,无需手动编写复杂的递归逻辑。
- 如果需要自定义映射逻辑,可以使用 @Mapping 注解。
总结:
通过使用 MapStruct,我们可以轻松地处理包含递归结构的数据序列化。 这种方法简洁、高效,并且易于维护。它避免了手动编写复杂的递归逻辑,提高了开发效率。 这种方法特别适用于 API 开发,可以将复杂的内部数据结构转换为清晰的 JSON 响应。









