Mybatis中Mapper映射文件使用詳解
更新時間：2020年06月16日 11:37:08 作者：DreamMakers
這篇文章主要介紹了Mybatis中Mapper映射文件使用詳解，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
緊接上文所述，在這篇文章中我將對Mapper映射文件進(jìn)行詳細(xì)的說明。
Mapper映射文件是一個xml格式文件，必須遵循相應(yīng)的dtd文件規(guī)范，如ibatis-3-mapper.dtd。我們先大體上看看支持哪些配置？如下所示，從Eclipse里截了個屏：
從上圖可以看出，映射文件是以<mapper>作為根節(jié)點，在根節(jié)點中支持9個元素，分別為insert、update、delete、select（增刪改查）;cache、cache-ref、resultMap、parameterMap、sql。
下文中，我們將首先對增刪改進(jìn)行描述，然后對查進(jìn)行詳細(xì)說明，最后對其他五個元素進(jìn)行簡單說明。
（1）insert、update、delete
我們先從配置文件看起：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<!-- mapper 為根元素節(jié)點， 一個namespace對應(yīng)一個dao -->
<mapper namespace="com.dy.dao.UserDao">
<insert
<!-- 1. id （必須配置）
id是命名空間中的唯一標(biāo)識符，可被用來代表這條語句。
一個命名空間（namespace） 對應(yīng)一個dao接口,
這個id也應(yīng)該對應(yīng)dao里面的某個方法（相當(dāng)于方法的實現(xiàn)），因此id 應(yīng)該與方法名一致 -->
id="addUser"
<!-- 2. parameterType （可選配置, 默認(rèn)為mybatis自動選擇處理）
將要傳入語句的參數(shù)的完全限定類名或別名， 如果不配置，mybatis會通過ParameterHandler 根據(jù)參數(shù)類型默認(rèn)選擇合適的typeHandler進(jìn)行處理
parameterType 主要指定參數(shù)類型，可以是int, short, long, string等類型，也可以是復(fù)雜類型（如對象） -->
parameterType="user"
<!-- 3. flushCache （可選配置，默認(rèn)配置為true）
將其設(shè)置為 true，任何時候只要語句被調(diào)用，都會導(dǎo)致本地緩存和二級緩存都會被清空，默認(rèn)值：true（對應(yīng)插入、更新和刪除語句） -->
flushCache="true"
<!-- 4. statementType （可選配置，默認(rèn)配置為PREPARED）
STATEMENT，PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement，PreparedStatement 或 CallableStatement，默認(rèn)值：PREPARED。 -->
statementType="PREPARED"
<!-- 5. keyProperty (可選配置， 默認(rèn)為unset)
（僅對 insert 和 update 有用）唯一標(biāo)記一個屬性，MyBatis 會通過 getGeneratedKeys 的返回值或者通過 insert 語句的 selectKey 子元素設(shè)置它的鍵值，默認(rèn)：unset。如果希望得到多個生成的列，也可以是逗號分隔的屬性名稱列表。 -->
keyProperty=""
<!-- 6. keyColumn (可選配置)
（僅對 insert 和 update 有用）通過生成的鍵值設(shè)置表中的列名，這個設(shè)置僅在某些數(shù)據(jù)庫（像 PostgreSQL）是必須的，當(dāng)主鍵列不是表中的第一列的時候需要設(shè)置。如果希望得到多個生成的列，也可以是逗號分隔的屬性名稱列表。 -->
keyColumn=""
<!-- 7. useGeneratedKeys (可選配置， 默認(rèn)為false)
（僅對 insert 和 update 有用）這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數(shù)據(jù)庫內(nèi)部生成的主鍵（比如：像 MySQL 和 SQL Server 這樣的關(guān)系數(shù)據(jù)庫管理系統(tǒng)的自動遞增字段），默認(rèn)值：false。 -->
useGeneratedKeys="false"
<!-- 8. timeout (可選配置， 默認(rèn)為unset, 依賴驅(qū)動)
這個設(shè)置是在拋出異常之前，驅(qū)動程序等待數(shù)據(jù)庫返回請求結(jié)果的秒數(shù)。默認(rèn)值為 unset（依賴驅(qū)動）。 -->
timeout="20">
<update
id="updateUser"
parameterType="user"
flushCache="true"
statementType="PREPARED"
timeout="20">
<delete
id="deleteUser"
parameterType="user"
flushCache="true"
statementType="PREPARED"
timeout="20">
</mapper>
上面給出了一個比較全面的配置說明，但是在實際使用過程中并不需要都進(jìn)行配置，可根據(jù)自己的需要刪除部分配置項。
在這里，我列舉出我自己的配置文件，精簡之后是這樣的：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.majing.learning.mybatis.dao.UserDao">
<insert id="addUser" parameterType="user" useGeneratedKeys="true" keyProperty="id">
insert into user(name,password,age) values(#{name},#{password},#{age})
</insert>
<delete id="deleteUser" parameterType="int">
delete from user where id = #{id}
</delete>
<update id="updateUser" parameterType="user" >
update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}
</update>
</mapper>
這里的parameterType設(shè)置成user是因為如果不設(shè)置的情況下，會自動將類名首字母小寫后的名稱，原來的類名為User。不過，建議大家還是使用typeAlias進(jìn)行配置吧。唯一需要說明的就是<insert>元素里面的useGeneratedKeys和keyProperties屬性，這兩個屬性是用來獲取數(shù)據(jù)庫中的主鍵的。
在數(shù)據(jù)庫里面經(jīng)常性的會給數(shù)據(jù)庫表設(shè)置一個自增長的列作為主鍵，如果我們操作數(shù)據(jù)庫后希望能夠獲取這個主鍵該怎么弄呢？正如上面所述，如果是支持自增長的數(shù)據(jù)庫，如mysql數(shù)據(jù)庫，那么只需要設(shè)置useGeneratedKeys和keyProperties屬性便可以了，但是對于不支持自增長的數(shù)據(jù)庫（如oracle）該怎么辦呢？
mybatis里面在<insert>元素下面提供了<selectKey>子元素用于幫助解決這個問題。來看下配置：
<selectKey
<!-- selectKey 語句結(jié)果應(yīng)該被設(shè)置的目標(biāo)屬性。如果希望得到多個生成的列，也可以是逗號分隔的屬性名稱列表。 -->
keyProperty="id"
<!-- 結(jié)果的類型。MyBatis 通?？梢酝扑愠鰜恚菫榱烁哟_定寫上也不會有什么問題。MyBatis 允許任何簡單類型用作主鍵的類型，包括字符串。如果希望作用于多個生成的列，則可以使用一個包含期望屬性的 Object 或一個 Map。 -->
resultType="int"
<!-- 這可以被設(shè)置為 BEFORE 或 AFTER。如果設(shè)置為 BEFORE，那么它會首先選擇主鍵，設(shè)置 keyProperty 然后執(zhí)行插入語句。如果設(shè)置為 AFTER，那么先執(zhí)行插入語句，然后是 selectKey 元素 - 這和像 Oracle 的數(shù)據(jù)庫相似，在插入語句內(nèi)部可能有嵌入索引調(diào)用。 -->
order="BEFORE"
<!-- 與前面相同，MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 語句的映射類型，分別代表 PreparedStatement 和 CallableStatement 類型。 -->
statementType="PREPARED">
</selectKey>
針對不能使用自增長特性的數(shù)據(jù)庫，可以使用下面的配置來實現(xiàn)相同的功能：
<insert id="insertUser" parameterType="com.dy.entity.User">
<!-- oracle等不支持id自增長的，可根據(jù)其id生成策略，先獲取id -->
<selectKey resultType="int" order="BEFORE" keyProperty="id">
select seq_user_id.nextval as id from dual
</selectKey>
insert into user(id, name, password, age, deleteFlag)
values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})
</insert>
講完了insert、update、delete，接下來我們看看用的比較多的select。
（2）select、resultType、resultMap
我們先來看看select元素都有哪些配置可以設(shè)置：
<select
<!-- 1. id （必須配置）
id是命名空間中的唯一標(biāo)識符，可被用來代表這條語句。
一個命名空間（namespace） 對應(yīng)一個dao接口,
這個id也應(yīng)該對應(yīng)dao里面的某個方法（相當(dāng)于方法的實現(xiàn)），因此id 應(yīng)該與方法名一致 -->
id="findUserById"
<!-- 2. parameterType （可選配置, 默認(rèn)為mybatis自動選擇處理）
將要傳入語句的參數(shù)的完全限定類名或別名， 如果不配置，mybatis會通過ParameterHandler 根據(jù)參數(shù)類型默認(rèn)選擇合適的typeHandler進(jìn)行處理
parameterType 主要指定參數(shù)類型，可以是int, short, long, string等類型，也可以是復(fù)雜類型（如對象） -->
parameterType="int"
<!-- 3. resultType (resultType 與 resultMap 二選一配置)
resultType用以指定返回類型，指定的類型可以是基本類型，可以是java容器，也可以是javabean -->
resultType="User"
<!-- 4. resultMap (resultType 與 resultMap 二選一配置)
resultMap用于引用我們通過 resultMap標(biāo)簽定義的映射類型，這也是mybatis組件高級復(fù)雜映射的關(guān)鍵 -->
resultMap="userResultMap"
<!-- 5. flushCache (可選配置)
將其設(shè)置為 true，任何時候只要語句被調(diào)用，都會導(dǎo)致本地緩存和二級緩存都會被清空，默認(rèn)值：false -->
flushCache="false"
<!-- 6. useCache (可選配置)
將其設(shè)置為 true，將會導(dǎo)致本條語句的結(jié)果被二級緩存，默認(rèn)值：對 select 元素為 true -->
useCache="true"
<!-- 7. timeout (可選配置)
這個設(shè)置是在拋出異常之前，驅(qū)動程序等待數(shù)據(jù)庫返回請求結(jié)果的秒數(shù)。默認(rèn)值為 unset（依賴驅(qū)動）-->
timeout="10000"
<!-- 8. fetchSize (可選配置)
這是嘗試影響驅(qū)動程序每次批量返回的結(jié)果行數(shù)和這個設(shè)置值相等。默認(rèn)值為 unset（依賴驅(qū)動)-->
fetchSize="256"
<!-- 9. statementType (可選配置)
STATEMENT，PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement，PreparedStatement 或 CallableStatement，默認(rèn)值：PREPARED-->
statementType="PREPARED"
<!-- 10. resultSetType (可選配置)
FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一個，默認(rèn)值為 unset （依賴驅(qū)動）-->
resultSetType="FORWARD_ONLY">
我們還是從具體的示例來看看，
<select id="findUserById" resultType="User">
select * from user where id = #{id}
</select>
這里我們根據(jù)用戶id去查詢這個用戶的信息，resultType=User是一個別名，如果我們接觸到的是這種一對一的問題，那么可以簡單的定義一個實體，這個實體代表數(shù)據(jù)庫表中的一條記錄即可。但是如果我們遇到一對多的問題呢，就拿這里的查詢用戶信息來說，如果每個用戶有各種興趣，需要維護(hù)每個用戶的興趣信息，那么我們可能就存在下面的數(shù)據(jù)表結(jié)構(gòu)：
CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `name` varchar(255) NOT NULL, `password` varchar(255) NOT NULL, `age` int(3) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8; CREATE TABLE `userinterests` ( `userid` int(11) DEFAULT NULL, `interestid` int(11) DEFAULT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8; CREATE TABLE `interests` ( `interestid` int(11) NOT NULL, `interestname` varchar(255) DEFAULT NULL, PRIMARY KEY (`interestid`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
其中user表用于記錄用戶信息，interests表用于維護(hù)所有的興趣標(biāo)簽，而userinterests用于維護(hù)每個用戶的興趣情況。
這時候，如果我們需要根據(jù)用戶id去查詢用戶的信息和興趣信息該怎么做呢？這時候我們就要用到<select>中的另一個重要屬性了，那就是resultMap。
在配置查詢的返回結(jié)果時，resultType和resultMap是二選一的操作。對于比較復(fù)雜的查詢結(jié)果，一般都會設(shè)置成resultMap。
resultMap該怎么配置呢？又支持哪些配置呢？我們看看下面：
<resultMap type="" id="">
<!-- id, 唯一性，注意啦，這個id用于標(biāo)示這個javabean對象的唯一性， 不一定會是數(shù)據(jù)庫的主鍵（不要把它理解為數(shù)據(jù)庫對應(yīng)表的主鍵）
property屬性對應(yīng)javabean的屬性名，column對應(yīng)數(shù)據(jù)庫表的列名
（這樣，當(dāng)javabean的屬性與數(shù)據(jù)庫對應(yīng)表的列名不一致的時候，就能通過指定這個保持正常映射了）
-->
<id property="" column=""/>
<!-- result與id相比， 對應(yīng)普通屬性 -->
<result property="" column=""/>
<!--
constructor對應(yīng)javabean中的構(gòu)造方法
-->
<constructor>
<!-- idArg 對應(yīng)構(gòu)造方法中的id參數(shù) -->
<idArg column=""/>
<!-- arg 對應(yīng)構(gòu)造方法中的普通參數(shù) -->
<arg column=""/>
</constructor>
<!--
collection，對應(yīng)javabean中容器類型, 是實現(xiàn)一對多的關(guān)鍵
property 為javabean中容器對應(yīng)字段名
column 為體現(xiàn)在數(shù)據(jù)庫中列名
ofType 就是指定javabean中容器指定的類型
-->
<collection property="" column="" ofType=""></collection>
<!--
association 為關(guān)聯(lián)關(guān)系，是實現(xiàn)N對一的關(guān)鍵。
property 為javabean中容器對應(yīng)字段名
column 為體現(xiàn)在數(shù)據(jù)庫中列名
javaType 指定關(guān)聯(lián)的類型
-->
<association property="" column="" javaType=""></association>
</resultMap>
根據(jù)上面的說明，我們來看看之前的問題怎么解決？
先截圖給出三個表的數(shù)據(jù)情況：
接著，我們來定義興趣類，并改寫之前的用戶實體類
package com.majing.learning.mybatis.entity;
public class Interests {
private int id;
private String name;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@Override
public String toString() {
return "Interests [id=" + id + ", name=" + name + "]";
}
}
package com.majing.learning.mybatis.entity;
import java.util.List;
public class User2 {
private int id;
private String name;
private String password;
private int age;
private List<Interests> interests;
private String author;
public List<Interests> getInterests() {
return interests;
}
public void setInterests(List<Interests> interests) {
this.interests = interests;
}
public String getAuthor() {
return author;
}
public void setAuthor(String author) {
this.author = author;
}
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
public String toString() {
return "User2 [id=" + id + ", name=" + name + ", password=" + password + ", age=" + age + ", interests=" + interests + ", author=" + author + "]";
}
}
緊接著，我們改寫Dao接口：
package com.majing.learning.mybatis.dao;
import com.majing.learning.mybatis.entity.User2;
public interface UserDao2 {
/**
* 查詢
* @param userId
* @return
*/
User2 findUserById (int userId);
}
然后，我們給相關(guān)實體類創(chuàng)建一下別名：
<typeAliases> <typeAlias alias="UserWithInterests" type="com.majing.learning.mybatis.entity.User2"/> <typeAlias alias="Interests" type="com.majing.learning.mybatis.entity.Interests"/> </typeAliases>
然后再創(chuàng)建一個對應(yīng)跟UserDao2對應(yīng)的Mapper映射文件：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.majing.learning.mybatis.dao.UserDao2">
<resultMap type="UserWithInterests" id="UserWithInterestsMap">
<id property="id" column="id"/>
<result property="name" column="name"/>
<result property="password" column="password"/>
<result property="age" column="age"/>
<collection property="interests" column="interestname" ofType="Interests">
<id property="id" column="interestid"/>
<result property="name" column="interestname"/>
</collection>
</resultMap>
<select id="findUserById" resultMap="UserWithInterestsMap">
select a.*,c.* from user as a right join userinterests as b on a.id = b.userid right join interests as c on b.interestid = c.interestid where id = #{id}
</select>
</mapper>
最后將這個映射文件添加到<mappers>元素配置下：
<mappers> <mapper resource="com\majing\learning\mybatis\dao\UserDaoMapper.xml" /> <mapper resource="com\majing\learning\mybatis\dao\UserDao2Mapper.xml" /> </mappers>
下面我們來寫個測試代碼來測試一下是否可以正常運(yùn)行：
public class UserDaoTest3 {
@Test
public void testFindUserById(){
SqlSession sqlSession = getSessionFactory().openSession(true);
UserDao2 userMapper = sqlSession.getMapper(UserDao2.class);
User2 user = userMapper.findUserById(10);
System.out.println("記錄為："+user);
}
// Mybatis 通過SqlSessionFactory獲取SqlSession, 然后才能通過SqlSession與數(shù)據(jù)庫進(jìn)行交互
private static SqlSessionFactory getSessionFactory() {
SqlSessionFactory sessionFactory = null;
String resource = "configuration.xml";
try {
sessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader(resource));
} catch (IOException e) {
e.printStackTrace();
}
return sessionFactory;
}
}
運(yùn)行代碼后，我們可以看到成功啦！
（3）sql
sql元素的意義，在于我們可以定義一串SQL語句，其他的語句可以通過引用它而達(dá)到復(fù)用它的目的。因為平時用到的也不多，這里就不多介紹了，感興趣的朋友可以自行查閱資料了解一下。
（4）cache、cache-ref
關(guān)于緩存的這塊邏輯還沒有研究過，后面專門寫篇文章針對緩存進(jìn)行針對性的說明，敬請關(guān)注。
到此這篇關(guān)于Mybatis中Mapper映射文件使用詳解的文章就介紹到這了,更多相關(guān)Mybatis Mapper映射文件內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
相關(guān)文章
有時候我們要刪除集合中的某些元素，那么就可以參考下面的代碼2013-07-07
Springboot如何優(yōu)雅高效的清除Redis中的業(yè)務(wù)key
這篇文章主要為大家詳細(xì)介紹了Springboot如何優(yōu)雅高效的清除Redis中的業(yè)務(wù)key,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2025-05-05
java通過jacob實現(xiàn)office在線預(yù)覽功能
這篇文章主要為大家詳細(xì)介紹了java通過jacob實現(xiàn)office在線預(yù)覽功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-08-08
SpringBoot集成I18n國際化文件在jar包外生效問題
這篇文章主要介紹了SpringBoot集成I18n國際化文件在jar包外生效問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-04-04
面試時必問的JVM運(yùn)行時數(shù)據(jù)區(qū)詳解
這篇文章主要介紹了JVM運(yùn)行時數(shù)據(jù)區(qū)原理解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2021-08-08
詳解Spring MVC/Boot 統(tǒng)一異常處理最佳實踐
在 Web 開發(fā)中, 我們經(jīng)常會需要處理各種異常，這篇文章主要介紹了詳解Spring MVC/Boot 統(tǒng)一異常處理最佳實踐，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-01-01
這篇文章主要介紹了java中如何執(zhí)行xshell命令，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-06-06
MyBatis之foreach標(biāo)簽的用法及多種循環(huán)問題
這篇文章主要介紹了MyBatis之foreach標(biāo)簽的用法及多種循環(huán)問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11
Java實現(xiàn)Twitter的分布式自增ID算法snowflake
這篇文章主要介紹了Java實現(xiàn)Twitter的分布式自增ID算法snowflake，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-08-08
這篇文章主要介紹了Java 自動安裝校驗TLS/SSL證書的示例，幫助大家更好的理解和使用Java，感興趣的朋友可以了解下2020-10-10