Spring 与 Mybatis 中的 @Repository 与 @Mapper与@Mapperscan

@Repository、@Service、@Controller,它们分别对应存储层Bean,业务层Bean,和展示层Bean。

如果使用@Repository则需要使用@MapperScan("xxx.xxx.xxx.mapper")进行扫描,然后生成Dao层的Bean才能被注入到Service层中。

@Mapper通过xml里面的namespace里面的接口地址,生成了Bean后注入到Service层中。相当于@Mapper=@Repository+@MapperScan

使用注解的方式开发Dao层的时候,常常会混淆这两个注解,不知道怎么添加,这里做个记录。

1 - @Mapper

@MapperMybatis 的注解,和 Spring 没有关系,
@Repository Spring 的注解,用于声明一个 Bean。(重要)

使用 Mybatis 有 XML 文件或者注解的两种使用方式,如果是使用 XML 文件的方式,我们需要在配置文件中指定 XML 的位置,这里只研究注解开发的方式

原理:
在 Spring 程序中,Mybatis 需要找到对应的 mapper,在编译的时候动态生成代理类,实现数据库查询功能,所以我们需要在接口上添加 @Mapper 注解

@Mapper
public interface UserDao {
    ...
}

但是,仅仅使用@Mapper注解,我们会发现,在其他变量中依赖注入,IDEA 会提示错误但是不影响运行(亲测~)。因为我们没有显式标注这是一个 Bean,IDEA 认为运行的时候会找不到实例注入,所以提示我们错误。如下图,会有红色波浪线。

Spring 与 Mybatis 中的 @Repository 与 @Mapper与@Mapperscan

Spring 与 Mybatis 中的 @Repository 与 @Mapper与@Mapperscan

Spring 与 Mybatis 中的 @Repository 与 @Mapper与@Mapperscan

尽管这个错误提示并不影响运行,但是看起来很不舒服,所以我们可以在对应的接口上添加 bean 的声明,@Repository如下:

@Repository // 也可以使用@Component,效果都是一样的,只是为了声明为bean
@Mapper
public interface UserDao {
    ...
}

注意:

此处的@Repository仅仅是为了让IDEA别报错没有实际功能(像@Service@Controller那样具有实例化对象并注入到IOC容器的功能)。
因为此处修饰的是接口类interface,而java规定接口类不能实例化(因为接口实际上是特殊的抽象类) 

2 - @Repository

正如上面说的,@Repository 用于声明 dao 层的 bean,如果我们要真正地使用 @Repository 来进行开发,那是基于代码的开发,简单来说就是手写 JDBC而不能用于Mapper.xml方式开发。

和 @Service、@Controller 一样,我们将 @Repository 添加到对应的实现类上,如下:

@Repository
public class UserDaoImpl implements UserDao{
    
    @Override
    public int insertUser(){
        JdbcTemplate template = new JdbcTemplate();
        ...
    }
}

3 - 其他扫描手段

基于注解的开发也有其他手段帮助 Mybatis 找到 mapper,那就是 @MapperScan 注解,可以在启动类上添加该注解,自动扫描包路径下的所有接口。使用这种方法,接口上不用添加任何注解

@SpringBootApplication
@MapperScan("com.scut.thunderlearn.dao")
public class UserEurekaClientApplication {

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

4 - 总结

  1. @Mapper 一定要有,否则 Mybatis 找不到 mapper。
  2. @Repository 可有可无,可以消去依赖注入的报错信息。
  3. @MapperScan 可以替代 @Mapper。但是依然解决不了,IDE注入红线的问题。
  4. 最终得出答案:@Mapper和@Repository 同时使用,完美解决所有问题。
上一篇:获取自增主键 insert新增数据之后的值


下一篇:mybatis-@Mapper接口用法