Mybatis-Plus中Mapper的接口文件与xml文件存放位置问题
1. 当xml文件在resources目录下
需要在application.yml文件中配置mybatis-plus.mapper-locations值,保证xml文件被读取到,即可正常运行。
mybatis-plus:
mapper-locations: classpath:*/mapper/*.xml #指定sql映射文件
2. 当xml文件不在resources目录下
(1)mapper和mapper.xml在同一个目录下,且文件名相同
查询报错如下:
pom.xml文件配置标签,将xml文件编译打包,此时可以正常查询。
<!--将src/main/java目录下的所有xml文件都作为项目的资源文件,编译打包时会进行预编译并打包进去-->
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
<!--filtering标签默认是false,表示include标签中的文件不需要预编译并打入包中;true表示需要被预编译打包-->
<filtering>true</filtering>
</resource>
</resources>
原因:
因为xml文件在java目录下,如果是用maven构建的项目,maven默认的打包环境下,只会把src/main/java包中的 ".java"文件进行编译生成“.class”文件,加入以上代码才能在打包的时候,使xml文件被打包进jar/war包中。
扩展:
<!--将src/main/resources目录下的所有.xml文件和a.properties作为项目的资源文件,编译打包时会进行预编译并打包进去-->
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.xml</include>
<include>a.properties</include>
</includes>
<filtering>true</filtering>
</resource>
<!--将src/main/resources目录下,除了a.properties的所有文件都作为项目的资源文件,编译时会被打包进去,但不会被编译-->
<resource>
<directory>src/main/resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>a.properties</exclude>
</excludes>
</resource>
(2) mapper和mapper.xml在同一个目录下,但文件名不相同
测试发现报错:
(3)mapper和mapper.xml不在同一个目录下
mapper和mapper.xml不在同一个目录下时,无论文件名是否相同,测试同样报错,找不到对应方法。
3. 总结
1).当mapper文件和xml文件在同一个目录下(非resources目录下),需要配置pom.xml文件,使xml文件能够被打进jar包,不需要额外配置yml文件;
2).当mapper文件在/java目录下,xml文件在resources目录下,需要配置yml文件使得xml文件能够被找到。