@Mapper 是 Mybatis 的注解,和Spring没有关系。@Mapper注解的的作用
1:为了把mapper这个DAO交給Spring管理,参考 http://412887952-qq-com.iteye.com/blog/2392672
2:为了不再写mapper映射文件,参考https://blog.csdn.net/weixin_39666581/article/details/103899495
3:为一个添加@Mapper注解的接口自动生成一个实现类,参考http://www.tianshouzhi.com/api/tutorials/mapstruct/292
domain类是我们用于与数据库映射的实体类,通常情况下,在将实体数据序列化发送到客户端时,我们不会把domain类序列化,而是将domain类转成一个model,将model序列化作为响应数据,返回给浏览器。例如,有一个章节类(Chapter):
@Entity@Table(name = "chapters")
public class Chapter {
@Id
@Column(name = "id", unique = true, nullable = false)
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(name = "name", nullable = false)
@ColumnComment("章节名")
private String name;
@Column(name = "book_id", nullable = false) private Long bookId; @Column(name = "parent_id")
@ColumnComment("父章节的id,标示从属于哪个章节。如果为null,则表示改章节就是book(顶结点)")
private Long parentId; @Column(name = "description", nullable = true)
private String description; @Column(name = "sort_num")
private Integer sortNum;
/// 省略 get/set
}
章节通常是嵌套成树状结构。当我们需要返回一个树形结构的数据到页面时,就需要构建一个model,如下所示:
public class ChapterModel {
private Long id;
private Long bookId;
private Long parentId;
private String groupName;
private Integer sortNum;
private String description;
private List<ChapterModel> items; // 树结构的体现
private int level;
private boolean expanded;
private boolean isArticle;
private boolean ifCanClick;
private String parentName;
// 省略 get/set
}
那么问题来了,每次我们需要处理一个Chapter对象时,都需要创建一个model,将chapter里的数据对应塞进model里,抽成方法就是:entityToModel。@Mapper就是起这个作用,它只需要你去创建一个接口或抽象类(ChapterMapper),然后定义这个entityToModel方法(并不需要去实现),因为它会自动创建继承类(ChapterMapperImpl),并实现这个方法(entityToModel)。事实上,实现方法的内部同样是调用简单set/get,但这为我们省了不少时间。
首先,在pom文件中引入依赖:
<dependency>
<groupId>org.mapstruct</groupId>
<artifactId>mapstruct-jdk8</artifactId> <version>1.2.0.Beta2</version></dependency><dependency> <groupId>org.mapstruct</groupId>
<artifactId>mapstruct-processor</artifactId>
<version>1.2.0.Beta2</version>
</dependency>
创建接口,并使用mapper注解:
@Mapper(componentModel = "spring", uses = {})
public interface ChapterMapper {
public ChapterModel entityToModel(Chapter chapter);
}
使用maven命令生成class文件,执行命令: mvn clean compile。
可以看到,在项目target目录下,生成了一个generated-sources目录,下面可以找到ChapterMapperImpl:
查看里面的代码,发现entityToModel方法已经被实现了,如下所示:
仔细观察,我们会发现,返回的model中只有5个属性被赋值了(而这5个属性恰好就是Chapter类的6个属性中的5个)。因为mapstruct是根据属性的名字来匹配的,entity中的name属性,在model里找不到同名的属性,所以就忽略了。
那么,怎么实现让name赋值给model中的groupName?另外,还有一种更复杂的需求,我们希望根据Chapter的parentId属性查找父级目录Chapter,再将父级目录的name赋值给model的parentName属性,又该怎么处理呢?
只需要给方法加一个注解,并相应配置,再添加一个方法(changeToParentName)即可:
@Autowired
private ChapterService chapterService;
@Mappings({ @Mapping(source = "chapter.name", target = "groupName"), @Mapping(source = "chapter.parentId", target = "parentName"), })
public abstract ChapterModel entityToModel(Chapter chapter);
public String changeToParentName(Long parentId) {
if (parentId != null) {
return chapterService.getNameById(parentId);
}
return null;
}
可以看到,因为要添加一个自定义实现方法changeToParentName,所以我们把接口改成了抽象类。
看下@Mappings({})里的配置属性和值,就会发现改造映射规则的配置方式。
source属性中chapter.name中的chapter就是方法的参数名,name当然就是属性名了;target属性,就是需要映射的model的属性名;changeToParentName这个方法名不是固定的,但是参数值和返回的数据类型却是固定的。
接下来,我们再次用命令重新清理一下class文件,使用命令mvn clean。然后,重新编译,使用命令mvn compile。再次查看target目录下生成的文件,就会发现已经符合我们的要求了。