如何在 Spring Boot 中使用 Mapstruct

小蜗牛慢慢爬行2024-12-20 23:04

我们将学习 Spring Boot 应用程序的 MapStruct 依赖关系。

它是什么？

MapStruct是一个代码生成器，它基于约定优于配置的方法，大大简化了 Java bean 类型之间的映射实现。
生成的映射代码使用普通方法调用，因此速度快、类型安全且易于理解。

为什么？

多层应用程序通常需要在不同的对象模型（例如实体和 DTO）之间进行映射。编写此类映射代码是一项繁琐且容易出错的任务。MapStruct 旨在通过尽可能自动化来简化这项工作。

首先，我们需要在 pom.xml/gradle 中添加 MapStruct 依赖项

您可以找到 MapStruct -> mvnrepository的新版本

在本文中我们将举 2 个示例。

让我们从一个简单的开始；

这里我们有用户模型，让我们想象一下，您不是返回整个模型，而是考虑返回 DTO。
例如；

在这种情况下，我们可以使用 Mapstruct 轻松地从 User 映射到 UserDTO。
我们需要创建一个接口；

然后我们只需要调用我们需要的方法就可以了。

用法是 -> UserMapper.INSTANCE.userToUserDTO(user);
它直接返回，没有 id 字段。
因此，响应将是 ->

另一个 例子是；
您可能会遇到不同的模型存储相同的信息但使用不同的字段名称的情况。

例如，您有 Order.java 模型

你有 OrderResponse.java

假设将LocalDate orderDate 格式化为String purchaseDate ，clientName 和customerName 是相同的信息。
在这种情况下，我们如何轻松完成？

使用@Mapping注释时，我们可以轻松地定义它们，就像在OrderMapper.java中看到的那样

我们可以在OrderService中使用这个映射器；

因此 OrderResponse 将是；

java 复制代码

{ 
 "clientName" ： "xiaoming" ，
 "productName" ： "智能手机" ，
 "formattedPrice" ： "850.75" ，
 "purchaseDate" ： "2024-12-18" 
}

就这样，如您所见，Mapstruct 易于使用、实现和在模型、dto 和响应之间进行映射。