首页 > 编程语言 > 解决Mapper接口和mapper.xml的文件位置问题
2020
12-05

解决Mapper接口和mapper.xml的文件位置问题

今天遇到一个问题是mybatis中接口和对应的mapper文件位置不同，而引起的操作也会不同，在网上找了好久最终找到了方法，这里就简单的解析一下：

我们知道在典型的maven工程中，目录结构有：src/main/java和src/main/resources，前者是用来存放java源代码的，后者则是存放一些资源文件，比如配置文件等.

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

1：接口和文件放在同一个包中如下：

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

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

在默认maven打包的环境下，不要将接口文件和mapper文件全部放到src/main/java，这样也不会把mapper文件打包进去

在src/main/java和src/main/resources中相同的包名，相同的文件名，默认打包后的结构如下：

发现打包之后已经到同一个包下了。

而当你把接口和mapper文件全部放到src/main/java中同一包时，如下：

打包之后的文件如下：

发现编译打包之后并没有mapper文件，所以此时不管是测试还是正式执行都会出错！！

更改maven构建配置

如果不想将接口和mapper文件分别放到src/main/java和src/main/resources中，而是全部放到src/main/java，那么在构建的时候需要指定maven打包需要包括xml文件，具体配置如下：

<build>
  <resources>
    <resource>
      <directory>src/main/java</directory>
      <includes>
        <include>**/*.xml</include>
      </includes>
      <filtering>false</filtering>
    </resource>
  </resources>
</build>

这样在打包的时候也会将mapper文件打包到/target文件夹中。

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

如果接口和mapper文件不在同一个包下，就不能进行自动扫描解析了，需要对接口和文件分别进行配置。

2.1 XML配置方式

2.1.1 不使用Spring

使用Mybatis的配置文件如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
 PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
 "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
 <mappers>
  <!-- 扫描路径下的mapper映射文件 -->
  <mapper resource="mappers/UserMapper.xml"/>
  <!-- 扫描包下的接口文件 -->
  <package name="edu.zju.bme.data.manage.mapper" />
 </mappers>
</configuration>
2.1.2 使用Spring
使用spring的配置文件如下：
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
 xsi:schemaLocation="
 http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
 http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">
 <!-- 配置接口存储的包，用来扫描mapper接口 -->
 <mybatis:scan base-package="edu.zju.bme.data.manage.mapper" />
 <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <!-- 配置mapper文件位置，扫描映射文件，可以使用Ant风格的路径格式 -->
  <property name="mapperLocations" value="classpath*:mappers/**/*.xml" />
  // ...
 </bean>
</beans>

补充知识：mybatis配置文件中config与mapper的约束

Config的约束：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration 
 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 
 "http://mybatis.org/dtd/mybatis-3-config.dtd">

Mapper的约束：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper 
 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
 "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

PS：

1：一般这个config的配置文件的约束的名字叫做：SQLMapConfig.xml(在resources中)

2：Mapper的配置文件约束是在resources中与其main中java下接口的相应文件相对应，但是简单来书，main中文件夹是包属性例如：comgaoxin.dao，属于三级结构，但是在resources中目录属于一级结构，需注意。

举例（防止日后看不懂）

SQLMapConfig.xml：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
    PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-config.dtd">
<!--Mybatis的主配置文件-->
<configuration>
  <!--配置环境-->
  <environments default="mysql">
    <!--配置mysql的环境，注意，default中的属性，与下边environment中id的属性是一样的-->
    <environment id="mysql">
      <!--配置事务的类型-->
      <transactionManager type="JDBC"></transactionManager>
      <!--配置数据源，也叫作连接池-->
      <dataSource type="POOLED">
        <!--配置连接数据库的四个基本信息-->
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/数据库的名字"/>
        <property name="username" value="数据库用户名"/>
        <property name="password" value="数据库的密码"/>
      </dataSource>
    </environment>
  </environments>
  <!--指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件-->
  <mappers>
    <!--指定文件的位置，要与main中java的文件结构位置相同-->
    <mapper resource="com.gaoxin.dao.IUserDao.xml"></mapper>
  </mappers>
</configuration>

Mapper.xml(也就是java中dao包中接口文件相映射的文件名.xml)

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
    PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.gaoxin.dao.IUserDao">
  <!--配置查询所有，resultType的作用就是返回封装的位置，如果你要是不写的话，最后mybatis是不知道你到底要封装到哪里，会出现错误，我这个是User表，查询的也是这个，最后返回的结果就封装在User类中-->
  <select id="findAll" resultType="com.gaoxin.domain.User">
    SELECT *FROM USER
  </select>
  <!--注意在resources中，目录是一级结构，要一个一个创建，而com.gaoxin.dao是一个目录。而包是三级结构-->
</mapper>

以上这篇解决Mapper接口和mapper.xml的文件位置问题就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持自学编程网。

编程技巧