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

时间:2024-04-03 10:06:03

一、前言

最近要新做一个平台项目,对于框架的搭建,当然是要给架构师来搭建和设计(所谓的架构,估计也是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插件):
Mybatis中接口和对应的mapper文件位置详解

三、Mybatis接口(Dao)和mapper文件位置

1、接口和文件放在同一个包中
Mybatis中接口和对应的mapper文件不一定要放在同一个包下。如果放在一起,目的是为了Mybatis进行自动扫描,并且需要注意的是,此时Java接口的名称和mapper文件的名称要相同(名称指的是包名,见下图),否则会报异常,由于此时Mybatis会自动解析对应的接口和相应的配置文件,所以就不需要配置mapper文件的位置了。
Mybatis中接口和对应的mapper文件位置详解
Mybatis中接口和对应的mapper文件位置详解

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

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

在src/main/java和src/main/resources中相同的包名,相同的文件名,默认打包后的结构如下:
Mybatis中接口和对应的mapper文件位置详解

2、接口和文件不在同一个包下
该情况下的目录结构如下图所示:
Mybatis中接口和对应的mapper文件位置详解
如果接口和mapper文件不在同一个包下,就不能进行自动扫描解析了,需要对接口和mapper文件分别进行配置。配置方式有两种:
(1)不在Spring中配置、使用Mybatis的配置文件如下:
Mybatis中接口和对应的mapper文件位置详解

(2)在spring配置文件中配置如下:
Mybatis中接口和对应的mapper文件位置详解

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