快捷導(dǎo)航

解決Mapper接口和mapper.xml的文件位置問題

更新時間：2020年12月04日 11:39:36 作者：前行的道路

這篇文章主要介紹了解決Mapper接口和mapper.xml的文件位置問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

今天遇到一個問題是mybatis中接口和對應(yīng)的mapper文件位置不同，而引起的操作也會不同，在網(wǎng)上找了好久最終找到了方法，這里就簡單的解析一下：

我們知道在典型的maven工程中，目錄結(jié)構(gòu)有：src/main/java和src/main/resources，前者是用來存放java源代碼的，后者則是存放一些資源文件，比如配置文件等.

Mybatis中接口和對應(yīng)的mapper文件不一定要放在同一個包下，如果放在一起的目的是為了Mybatis進(jìn)行自動掃描，并且要注意此時Java接口的名稱和mapper文件的名稱要相同，否則會報異常，由于此時Mybatis會自動解析對應(yīng)的接口和相應(yīng)的配置文件，所以就不需要配置mapper文件的位置了。

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

在默認(rèn)的情況下maven打包的時候，對于src/main/java目錄只打包源代碼，而不會打包其他文件。所以此時如果把對應(yīng)的mapper文件放到src/main/java目錄下時，不會打包到最終的jar文件夾中，也不會輸出到target文件夾中，由于在進(jìn)行單元測試的時候執(zhí)行的是/target目錄下/test-classes下的代碼，所以在測試的時候也不會成功。

為了實現(xiàn)在maven默認(rèn)環(huán)境下打包時，Mybatis的接口和mapper文件在同一包中，可以通過將接口文件放在src/main/java某個包中，而在src/main/resources目錄中建立同樣的包，這是一種約定優(yōu)于配置的方式，這樣在maven打包的時候就會將src/main/java和src/main/resources相同包下的文件合并到同一包中。

在默認(rèn)maven打包的環(huán)境下，不要將接口文件和mapper文件全部放到src/main/java，這樣也不會把mapper文件打包進(jìn)去

在src/main/java和src/main/resources中相同的包名，相同的文件名，默認(rèn)打包后的結(jié)構(gòu)如下：

發(fā)現(xiàn)打包之后已經(jīng)到同一個包下了。

而當(dāng)你把接口和mapper文件全部放到src/main/java中同一包時，如下：

打包之后的文件如下：

發(fā)現(xiàn)編譯打包之后并沒有mapper文件，所以此時不管是測試還是正式執(zhí)行都會出錯??！

更改maven構(gòu)建配置

如果不想將接口和mapper文件分別放到src/main/java和src/main/resources中，而是全部放到src/main/java，那么在構(gòu)建的時候需要指定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文件不在同一個包下，就不能進(jìn)行自動掃描解析了，需要對接口和文件分別進(jìn)行配置。

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風(fēng)格的路徑格式 -->
  <property name="mapperLocations" value="classpath*:mappers/**/*.xml" />
  // ...
 </bean>
</beans>

補(bǔ)充知識：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下接口的相應(yīng)文件相對應(yīng)，但是簡單來書，main中文件夾是包屬性例如：comgaoxin.dao，屬于三級結(jié)構(gòu)，但是在resources中目錄屬于一級結(jié)構(gòu)，需注意。

舉例（防止日后看不懂）

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>
  <!--配置環(huán)境-->
  <environments default="mysql">
    <!--配置mysql的環(huán)境，注意，default中的屬性，與下邊environment中id的屬性是一樣的-->
    <environment id="mysql">
      <!--配置事務(wù)的類型-->
      <transactionManager type="JDBC"></transactionManager>
      <!--配置數(shù)據(jù)源，也叫作連接池-->
      <dataSource type="POOLED">
        <!--配置連接數(shù)據(jù)庫的四個基本信息-->
        <property name="driver" value="com.mysql.jdbc.Driver"/>
        <property name="url" value="jdbc:mysql://localhost:3306/數(shù)據(jù)庫的名字"/>
        <property name="username" value="數(shù)據(jù)庫用戶名"/>
        <property name="password" value="數(shù)據(jù)庫的密碼"/>
      </dataSource>
    </environment>
  </environments>
  <!--指定映射配置文件的位置，映射配置文件指的是每個dao獨(dú)立的配置文件-->
  <mappers>
    <!--指定文件的位置，要與main中java的文件結(jié)構(gòu)位置相同-->
    <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是不知道你到底要封裝到哪里，會出現(xiàn)錯誤，我這個是User表，查詢的也是這個，最后返回的結(jié)果就封裝在User類中-->
  <select id="findAll" resultType="com.gaoxin.domain.User">
    SELECT *FROM USER
  </select>
  <!--注意在resources中，目錄是一級結(jié)構(gòu)，要一個一個創(chuàng)建，而com.gaoxin.dao是一個目錄。而包是三級結(jié)構(gòu)-->
</mapper>

以上這篇解決Mapper接口和mapper.xml的文件位置問題就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: