MapStruct是一个代码生成器,在代码开发过程中,因为不想将自己数据库映射出来的那个实体类作为返回值,或者为了安全,想要将返回值字段名称修改为其他字段名称返回。但是都需要我们自己手动一个一个改的话就太麻烦了。这时候就可以利用MapStruct来解决。
使用步骤:
1.导入依赖
<!-- MapStruct 依赖包 -->
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId>
<version>1.3.0.Final</version>
</dependency>
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.3.0.Final</version>
</dependency>
2.准备好dto和pojo的实体类
3.定义一个转换接口
//添加这个注解是标记这个类是mapstruct转换类
@Mapper
public interface CourseBaseConvert {
//使用之前先构建属性转换示例
CourseBaseConvert INSTANCE = Mappers.getMapper(CourseBaseConvert.class);
//意思是CourseBase中的值赋值给CourseBaseDTO,
// 其中courseBaseId中的id字段赋值给CourseBase中的courseBaseId字段
//其他字段名称相同就赋值,不相同就不赋值,除非也用@Mapping(source = "id", target = "courseBaseId")
//如果是多个字段需要使用mapping指定映射,那么就是用@Mappings()
// @Mappings(
// @Mapping(source = "id", target = "courseBaseId"),
// @Mapping(source = "idtest", target = "courseBaseIdtest")
// )
@Mapping(source = "id", target = "courseBaseId")
CourseBaseDTO entity2dto(CourseBase courseBase);
//如果想要使用集合这种,那么就必须有一个上边这种单个转换的才能使用下边这个集合,而且单个的那个已经使用了@Mapping映射了,所以集合不需要了
// @Mapping(source = "id", target = "courseBaseId")
List<CourseBaseDTO> entity2dtos(List<CourseBase> courseBases);
}
4.在代码中进行调用转换接口引用
List<CourseBaseDTO> courseBaseDTOS = CourseBaseConvert.INSTANCE.entity2dtos(records);
上边第四个中的代码,等号前边的就是dto也就是需要返回给前端的代码,等号后面参数后面的records参数就是代表pojo类型的集合,意思是将pojo类型集合转换为dto类型的集合
注意
如果想要使用集合转换就必须先在转换器定义一个单个转换的,然后再使用集合转换才能成功