在springBoot中使用Mapper类问题_@Mapper_@MapperScan_xml文件跟mapper分开_xml文件跟mapper在同一个目录下

---

背景

在springBoot中使用mapper类，因为有其xml文件的存在，所以其xml文件的存放位置不同，会导致出现运行是否能够调用xml文件的问题存在；这个问题我遇到N多次了，不好好的解决一番，实在是不好继续写项目下去了；

xml文件跟mapper分开

当xml文件跟mapper文件分开的时候，也就是将xml文件放在springBoot下的src/main/resources文件下，如下所示：

application.properties

当分开的时候，我们需要在application.properties主配置文件中配置如下：

mybatis.mapper-locations=classpath:mapper/*.xml

• mybatis.mapper-locations
  指明是xml文件的路径

方式一： 主程序中@MapperScan

为了让mybatis扫描到我们的包，还需要在主程序中声明Mapper包的扫描，如下：

也可以不配置上边的扫描，在每个Mapper文件上加上@Mapper注解，每个文件都需要写上，没有上边的方便。

按照上边的配置，不需要在Mapper类中添加注解的，当我们在Service类中直接调用就是了，因为配置文件指明了；
但是这样idea会报红！
当我们在Service中调用的时候，还是会报无法注入，如下展示：
在PermissionMapper类中：

之后在Service类中使用Autowired注入，如下：

注意了：
这样虽然报错，但是项目运行没有一点影响！

如图运行成功：

也就是说是无伤大雅的；

但是要想消除这个idea的报错也可以滴；无法注入，是说没有这样的Bean存在，那么我们就添加一个注解，注入Bean嘛，所以在Mapper包下的所有mapper接口添加一个
@Repository注解
或者是
@Component注解

其效果是一样的，都是告知spring管理这个类为Bean；

这样就不会有报错了，如下：

方式二： 每个接口添加@Mapper

在方式一中，我们需要在主程序类中告诉Mybatis扫描mapper包；添加@MapperScan注解
如下：

我们也可以在每一个mapper接口中添加@Mapper注解，这样就不需要在主程序类中添加扫描了；如下：

注意点

在上面的两种方式中，有一个绕不开的点，就是在resources目录下创建的目录的时候，跟在java目录下创建目录是不一样的；

在java文件中我们创建的目录可以使用

这样表示子级目录，但是在resources文件下创建使用.

idea创建的时候就会误认为是一个名字，如下这样创建：

在盘符系统中，是这样的：

点开之后就只是一个文件，如下：

实际上我们需要使用的是子级目录形式，也就是在application.properties中写的：
mybatis.mapper-locations=classpath:mapper/*.xml

是一个目录路径；

所以，在resources目录下创建文件，需要以/创建，如下这样的形式：

这个锅就是idea来背！！！！！当我们打开其目录结构，就可以发现，如下：

点开之后如下：

但是idea本身也可查看其到底是否是一个目录，如下：

这样就可以显示是否是一个目录结构了，如下：

xml文件跟mapper在同一个目录下

application.properties中不需要配置这个。

mybatis.mapper-locations=classpath:mapper/*.xml

在mapper包下

将原来在resources的mapper目录下的xml文件全部剪切到mapper包下，如下：

主程序类

主程序类还是指明了Mybatis扫描的包，不加@MapperScan扫描，可以在mapper文件中单独加上@Mapper注解。

然后运行主程序类，再访问，如下：

报错：找不到mapper.xml

注意了

xml文件是没有问题的，其它的也没有问题的；因为按照前面分开mapper类和xml文件，运行及其功能都是没有问题的！！！

并且在Ecplise中运行，按照上面的方式去配置，运行也没问题。。。。
但是在idea中就是不行。。。。。。。

百度了好大一会儿，才解决；

在idea中，默认情况下是不会去编译src/main/java下的xml文件的！！！
在idea中，默认情况下是不会去编译src/main/java下的xml文件的！！！

所以需要我们自己配置src/main/java也可以编译资源文件，在pom.xml文件中，如下：

     <!--资源路径-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>

注意这个资源是配置到build标签下的
然后当我们再运行的时候，就成功了~~~~
如下：

并且在编译文件中也有，如下：

SpringBoot中关于@Mapper 和 @Repository 的一些疑问

@Mapper 是 Mybatis 的注解，和 Spring 没有关系，@Repository 是 Spring 的注解，用于声明一个 Bean。

1. @Mapper

Mybatis 需要找到对应的 mapper，在编译的时候动态生成代理类，才能实现对数据库的一系列操作，所以我们需要在接口上添加 @Mapper 注解。

例如（这里只是为了演示并且sql不复杂，所以这里使用注解的方式来编写sql语句）：

@Mapper
public interface UserMapper {

    @Select("select * from user where id = #{id}")
    User getById(Integer id);

    @Select("select * from user")
    List<User> getAll();
}

编写测试方法，可以发现加了自动装配注解的userMapper会出现报错（并不影响代码正常运行），这是因为@Mapper是Mybatis中的注解，我们没有显示的标明UserMapper是spring中的一个Bean，idea此时会认为在运行时找不到实例注入，所以会提示错误

虽然这个报错并不影响代码的正常运行，但是看着很不舒服，我们可以@Repository注解（也可以使用@Componet，只要注明这是一个bean就可以）来显示的说明UserMapper是一个bean

2. @Repository

@Repository 是spring提供的一个注解，用于声明 dao 层的 bean，如果我们要真正地使用 @Repository 来进行开发，那么我们需要手动实现UserMapperImpl，也就是说手写 JDBC代码！！！

@Repository
public class UserMapperImpl implements UserMapper{
	
	@Override
	public User getById(Integer id){
		// 装载Mysql驱动
		// 获取连接
		// 创建Statement
		// 构建SQL语句
		// 执行SQL返回结果
	}
}

3. @MapperScan(“com.xxx.xxx”)

如果我们不使用@Mapper注解，还有另一种方式让Mybatis找到mapper接口，那就是 @MapperScan 注解，可以在启动类上添加该注解，自动扫描包路径下的所有mapper接口。

@SpringBootApplication
@MapperScan("com.example.springboot_mybatis.mapper")
public class SpringbootMybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisApplication.class, args);
    }
}

使用@MapperScan注解之后，就不需要在mapper接口上添加任何注解了！！

4. 总结

• 总的来说，@Mapper 和 @MapperScan 这两个必须有一个，否则就会出错！
• @Repository 可有可无，对程序正常运行没什么影响，但是可以消除idea报错的问题