@Mapper注解和@MapperScan注解的使用

一、@Mapper注解的使用

1.1 @Mapper注解的的作用

• 为了把mapper这个DAO交給Spring管理( http://412887952-qq-com.iteye.com/blog/2392672)；
• 为了不再写mapper映射文件（https://blog.csdn.net/weixin_39666581/article/details/103899495）；
• 自动为添加@Mapper注解的接口生成一个实现类（http://www.tianshouzhi.com/api/tutorials/mapstruct/292）。

1.2 domain类的作用

• 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}

1.3、章节通常是嵌套形成树状结构，当我们需要返回一个树形结构的数据到页面时，就需要构建一个model，如下：

• 那么问题来了，当我们每次需要处理一个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(componentModel = "spring", uses = {})
public interface ChapterMapper { 
public ChapterModel entityToModel(Chapter chapter);
}

• 重新生成class文件，执行命令： mvn clean compile(我用的是maven)，可以看到在项目target目录下已生成了一个generated-sources目录，其下存在ChapterMapperImpl。查看里面的代码，可发现entityToModel方法已被实现。

• 细心一点，其实我们可以发现，生成的方法并不够“智能”，返回的model中只有五个属性被赋值了（而这五个属性恰好就是Chapter类的六个属性中的五个），因为mapstruct是根据属性的名字来匹配的，entity中的name属性，在model里找不到同名的属性，所以就忽略了。那么，如果我们要设置呢？让name赋值给model中的groupName？另外还有一种更复杂的需求，我们希望根据Chapter的parentId属性查找父级目录Chapter,再将父级目录的name赋值给model的parentName属性，又该怎么处理呢？

@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 compile。

二、@MapperScan注解使用

1、@Mapper注解

• 作用：在接口类上添加了@Mapper，在编译之后会生成相应的接口实现类；
• 添加位置：接口类上面。

@Mapper
public interface UserDAO {
   //代码
}

2、@MapperScan

• 如果想要每个接口都要变成实现类，那么需要在每个接口类上加上@Mapper注解，比较麻烦，解决这个问题用@MapperScan；
• 作用：指定要变成实现类的接口所在的包，然后包下面的所有接口在编译之后都会生成相应的实现类；
• 添加位置：是在Springboot启动类上面添加；

@SpringBootApplication
@MapperScan("com.winter.dao")
public class SpringbootMybatisDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
    }
}

• 添加@MapperScan(“com.winter.dao”)注解以后，com.winter.dao包下面的接口类，在编译之后都会生成相应的实现类。

3、使用@MapperScan注解多个包

• 实际用的时候根据自己的包路径进行修改

@SpringBootApplication  
@MapperScan({"com.kfit.demo","com.kfit.user"})  
public class App {  
    public static void main(String[] args) {  
       SpringApplication.run(App.class, args);  
    }  
} 

4、Dao接口类没在Spring Boot主程序可以扫描的包或者子包下面

• 可使用如下方式进行配置（没验证过，不确定能否使用，或许需要根据自己定义的包名进行修改路径）：

@SpringBootApplication  
@MapperScan({"com.kfit.*.mapper","org.kfit.*.mapper"})  
public class App {  
    public static void main(String[] args) {  
       SpringApplication.run(App.class, args);  
    }  
}