Mybatis中接口和对应的mapper文件位置详解

男娘i 2022-05-28 01:19 910阅读 0赞

## 一、引言 ##

最近要新做一个平台项目，对于框架的搭建，当然是要给架构师来搭建和设计（所谓的架构，估计也是copy的）。Pull到搭完的项目后，在Mybaits的配置文件中，有几处和我之前自己搭建的框架不太一样，出于想知道有什么区别时，就顺口问了一下，结果得到的回复是：你的配置方式太老了，而且支持重复命名空间，我的这种是新的方式。听完，我，呵呵……所以，我就想记录一下，我对此的理解。

## 二、Maven打包分析 ##

在 Maven 项目中，目录结构有：src/main/java 和 src/main/resources，前者是用来存放 Java 源代码的，后者是用来存放一些资源文件。一般情况下，我们用到的资源文件（各种xml，properites等）都放在该目录下面，在用 Maven 打包时，Maven 能把这些资源文件打包到相应的jar或者war里。

但有时候，比如 Mybatis 的 mapper.xml 文件，我们习惯把它 和 Mapper.java 放一起，都放在src/main/java下面（方便查看），这样在用 Maven 打包时，就需要修改 pom.xml 文件，来把 mapper.xml 文件一起打包进jar或者war里了（因为在默认的情况下，Maven打包的时候，对于src/main/java目录只打包源代码，而不会打包其他文件），否则，这些文件不会被打包的。（Maven 认为 src/main/java 只是Java的源代码路径）。此种方式需要在 pom.xml 文件中添加如下配置（也可以使用其他的配置方式，如 build-helper-maven-plugin、maven-resources-plugin插件）：  
![这里写图片描述][70]

## 三、Mybatis接口（Dao）和 mapper 文件位置 ##

###### 1、接口和文件放在同一个包中 ######

Mybatis 中接口和对应的mapper文件不一定要放在同一个包下。如果放在一起，目的是为了 Mybatis 进行自动扫描，并且需要注意的是，此时Java接口的名称和mapper.xml文件的名称要相同（名称指的是包名，见下图），否则会报异常，由于此时 Mybatis 会自动解析对应的接口和相应的配置文件，所以就不需要配置mapper文件的位置了。  
![这里写图片描述][70 1]  
![这里写图片描述][70 2]

由于在默认的情况下，对于src/main/java目录，Maven只打包源代码，而不会打包其他文件。所以此时如果把对应的 mapper 文件放到src/main/java目录下时，不会打包到最终的jar文件夹中，也不会输出到target文件夹中，由于在进行单元测试的时候执行的是/target/test-classes下的代码，所以在测试的时候也不会成功。

为了实现在 Maven 默认环境下打包时，Mybatis 的接口和mapper.xml文件在同一包中，可以通过将接口文件（java文件）放在src/main/java某个包中，而在 src/main/resources 目录中建立同样的包，这是一种约定优于配置的方式，这样在maven打包的时候就会将src/main/java和src/main/resources相同包下的文件合并到同一包中。

在 src/main/java 和 src/main/resources 中相同的包名，相同的文件名，默认打包后的结构如下：  
![这里写图片描述][70 3]

###### 2、接口和文件不在同一个包下 ######

该情况下的目录结构如下图所示：  
![这里写图片描述][70 4]  
如果 Dao 接口文件和 mapper.xml 文件不在同一个包下，就不能进行自动扫描解析了，需要对接口和mapper 文件分别进行配置。配置方式有两种：

（1）、不在Spring中配置、使用Mybatis的配置文件如下：  
![这里写图片描述][70 5]

（2）在Spring 配置文件中配置如下：  
![这里写图片描述][70 6]

我对第二种方式的理解是，Spring容器会加载扫描目录 mapper下xml文件，然后在通过该文件中的命名空间来找到接口文件 Dao 的所在位置，然后做出映射。

--------------------

补充：

（3）在 SpringBoot 中使用注解 配置如下：  
在application.yml或application.properties中配置Mybatis的配置文件和Mapper文件位置。

mybatis.config-location=classpath:Mybatis-config.xml
    mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

在启动类上，标注@MapperScan注解

@MapperScan({ "com.scorpios.backend.sys.mapper")
    public class BackendApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(BackendApplication.class, args);
        }
    }

在接口上使用@Mapper注解

@Mapper
    public interface MenuMapper { 
        int deleteById(Integer id);
        int insert(Menu menu);
        Menu getMenu(Integer id);
        int save(Menu menu);
    }

[70]: /images/20220528/9f6a68a7b2304ee8808ddabd94a2b6d4.png
[70 1]: /images/20220528/c19cc933bdb84dcc8be4294afcd8ea9c.png
[70 2]: /images/20220528/cfe5b66416b04d46939707c0949b1c68.png
[70 3]: /images/20220528/3422f2d7a39741d6acb84f165f4a3afc.png
[70 4]: /images/20220528/3411d7c36e8e4a959df5c82237aa95c1.png
[70 5]: /images/20220528/9c445e48c0644e0dba45720cd6da892f.png
[70 6]: /images/20220528/9dad4baddde24a4683ece9477edd6615.png