MapStruct

配置

提供详细模式的日志。参见 https://mapstruct.org/documentation/stable/reference/html/#_apache_maven

IDEA

需要开启 IDEA 注解处理器 (Build, Execution, Deployment → Compiler → Annotation Processors → enable annotation processor)

提供 IDEA 插件。插件地址 下载 或 IDEA → Settings → plugins → marketplace 搜索 MapStruct Support。

Mapping 规则

属性名

当 源属性 与 目标实体的某属性 名称相同 时，它将被 隐式映射。

当 源属性 与 目标实体的某属性 名称不同 时，可以该 domain 所有的 mapper 中通过 @mapping 注释指定其名称。

@Mapper
public interface PersonMapper {
    @Mapping(target = "fullName", source = "name")
    PersonDto personToPersonDto(Person person);
}

上例中，Person 实体类 姓名字段 命名为 “name”，但对应 DTO 姓名字段 命名为 “fullName”。

可以为 Person 实体类新建一个 PersonMapper，用于编写 Person 实体类 toDTO，toVO，toCO 等一系列映射方法。随后，在对应的 personToPersonDTO 方法上使用 @Mapper 注解，指定 source 和 target 对应的属性名，即可完成属性名不同时的映射。

类型

MapStruct 主要使用属性名映射。

如果映射属性的类型在源和目标实体上不同，在许多情况下，MapStruct 会自动处理类型转换。

如，源属性为 int price，目标属性为 String price，MapStruct 将自动调用 String.valueOf(int) 进行自动转换。若情况相反，则自动调用 Integer.parseInt(String)。

转换包装类到基本数据类型的时候会做非空判断。

参见 https://mapstruct.org/documentation/stable/reference/html/#implicit-type-conversions

NULL

传入参数为空，则 return null;

public Person map(PersonDto dto) {
	if (dto == null) {
		return null;
	}
}