在本文中,我们将探讨MapStruct的使用,简而言之就是Java Bean映射器。
该API包含可在两个Java Bean之间自动映射的功能。使用MapStruct,我们只需要创建接口,该库将在编译时自动创建具体的实现。
对于大多数应用程序,您会注意到很多将POJO转换为其他POJO的样板代码。
例如,一种常见的转换类型发生在持久性支持的实体和发往客户端的DTO之间。
这就是MapStruct解决的问题–手动创建bean映射器非常耗时。该库可以自动生成bean映射器类。
让我们将以下依赖项添加到我们的Maven pom.xml中:
<dependency> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-jdk8</artifactId> <version>1.3.0.Beta2</version> </dependency>
|
让我们还将批注处理程序路径添加到maven-compiler-plugin插件的配置部分。这里所述mapstruct处理器用于生成在生成过程中映射器实现:
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version> <configuration> <source>1.8</source> <target>1.8</target> <annotationProcessorPaths> <path> <groupId>org.mapstruct</groupId> <artifactId>mapstruct-processor</artifactId> <version>1.3.0.Beta2</version> </path> </annotationProcessorPaths> </configuration> </plugin>
|
映射到DTO对象
源实体:
public class Employee { private String firstName; private String lastName; // constructor, getters and setters }
|
DTO目标:public class EmployeeDTO { private String firstName; private String lastName; // getters and setters }
|
映射器:
@Mapper public interface EmployeeMapper { List<EmployeeDTO> map(List<Employee> employees); }
|
这里是将Employee的集合转换为EmployeeDTO的集合类型,如果是两个对象类型直接转更方便。
注意,我们没有为EmployeeMapper 创建实现类-因为MapStruct为我们创建了它。
我们可以通过执行mvn clean install来触发MapStruct处理。输出结果在/target/generated-sources/annotations/目录下。
看看MapStruct 帮我们自动生成的EmployeeMapper 接口实现代码如下:public class EmployeeMapperImpl implements EmployeeMapper { @Override public List<EmployeeDTO> map(List<Employee> employees) { if (employees == null) { return null; } List<EmployeeDTO> list = new ArrayList<EmployeeDTO>(employees.size()); for (Employee employee : employees) { list.add(employeeToEmployeeDTO(employee)); } return list; } protected EmployeeDTO employeeToEmployeeDTO(Employee employee) { if (employee == null) { return null; } EmployeeDTO employeeDTO = new EmployeeDTO(); employeeDTO.setFirstName(employee.getFirstName()); employeeDTO.setLastName(employee.getLastName()); return employeeDTO; } }
|
更详细的转换点击标题见原文。