mybatis的mapper映射文件

1概述
1.1應用架構
     mybatis框架用於支持對關係數據庫的操做，該體系的應用架構以下圖所示：

    在mybatis框架體系中，主要的組件是：SqlSessionFactoryBean和MapperScannerConfigurer。SqlSessionFactoryBean類依賴外部注入的數據源：DataSource。並有兩個屬性：configLocation和mapperLocations。
ConfigLocation指定了mybatis配置文件的位置；mapperLocations指定了多個mapper映射文件的位置。
MapperSacannerConfigurer依賴SqlSessionFactoryBean，並根據basePackages屬性指定的IDao接口類所在的包位置，自動掃描該包路徑，爲每一個IDao類建立一個MapperFactoryBean類。MapperFactoryBean類會爲它所對應的IDao接口類建立其具體的實現類實例，並將其注入到service層的業務代碼中。
在Spring boot開發中，使用@MapperScan註解代替MapperScannerConfigurer類。它們的效果是同樣的。
在使用mybatis框架實現數據庫操做的時候，上圖紅色框部分的內容須要開發人員實現。
數據源是任何實現了javax.sql.datasource接口的類實例。例如：org.apache.tomcat.jdbc.pool.datasource，該數據源對應單庫單表操做；或者com.dangdang.ddframe.rdb.sharding.jdbc.core.datasource.ShardingDataSource,該數據源對用分庫，分表操做。
IDao爲數據操做接口，實現用戶的數據操做邏輯。通常分爲接口類和po類兩部分。
配置文件分爲：mybatis配置文件和mapper配置文件。mybatis配置文件主要用來設計po類的別名，方便對po類的引用；mapper配置文件用來管理SQL語句。
1.2主要開發要素
    在mybatis開發中，涉及到主要開發要素是:dao接口類，mapper映射文件，以及po類。它們之間的關係以下：

    dao接口類中，定義了數據庫操做的接口方法，主要包含增，刪，改，查等接口方法；po類定義接口方法的參數，可以使用po類保存查詢結果，或者爲insert，update方法提供數據集參數。操做數據庫表的SQL語句保存在mapper映射文件中。mapper映射文件分別提供select,insert,update,delete xml元素，分別對應數據庫的查詢，插入，修改，刪除操做。每個xml元素經過id屬性與dao接口類中的方法相互關聯。

1.3 mapper文件的結構
    mapper映射文件是xml格式的配置文件，由一系列具備層級關係的元素組成。而且經過元素的屬性，這些元素之間具備關聯關係。具體狀況以下圖所示：

    在mapper映射文件中，主要包含以下配置元素：

• mapper元素。該元素是最頂層的配置元素，其屬性namespace指向IDao類的全類型名，即：包路徑+類名。在mapper元素下面，包含以下子元素：resultMap元素，select元素，insert元素，update元素，delete元素。
• resultMap元素。創建數據庫表的列名與po類的數據字段之間的映射關係。當po類的數據字段與數據庫表不一致的時候，或者承載複雜查詢結果的時候，使用resultMap配置；
• select元素。用來維護select語句。
• insert元素。用來維護insert語句。
• update元素。用來維護update語句。
• delete元素。用來維護delete語句。

2 文件示例
    在開發過程當中，須要開發人員配置mapper映射文件，編寫Idao類，以及Idao了所依賴的po類。具體示例以下：
2.1 mapper映射文件
    mapper配置文件的示例以下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org/DTD Mapper 3.0" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.lifeng.demo.mybatis.dao.IUserDao">

    <resultMap type="UserInfo" id="userData">
        <id property="id" column="f_id" />
        <result property="name" column="f_name" />
        <result property="birth" column="f_birth" />
        <result property="salary" column="f_salary" />
    </resultMap>

    <!-- id要與接口方法名相同 -->
    <!-- SQL語句中的參數名稱（#{id}），要與java代碼中的參數bean的數據字段相同，這裏是UserInfo.id字段 -->
    <!-- type屬性可省略 -->
    <insert id="insertUserInfoByBean">
        insert into t_user (f_id,f_name,f_birth,f_salary) values (#{id},#{name},#{birth},#{salary})
    </insert>
    
    <!-- @Param的參數必須與#{}中的參數一致 -->
    <insert id="insertUserInfo">
        insert into t_user (f_id,f_name,f_birth,f_salary) values (#{id},#{name},#{birth},#{salary})
    </insert>

    <insert id="insertUserInfoByBatch">
        insert into t_user (f_id,f_name,f_birth,f_salary) values
        <foreach collection="list" item="item" separator="," index="idx">
            (#{idx},#{item.name},#{item.birth},#{item.salary})
        </foreach>
    </insert>

    <!--resultMap屬性的值是 resultMap配置節id的值。當承載返回結果的java bean數據字段與數據庫表字段格式不一致時，使用resultMap -->
    <!-- 若是返回多行數據，會用list封裝UserData -->
    <select id="listUserInfo" resultMap="userData">
        select * from t_user
    </select>

    <select id="getUserCount" resultType="int">
        select count(*) from
        t_user
    </select>

    <select id="listUserInfoToMap" resultType="map">
        select * from
        t_user
    </select>

    <select id="getUserInfoById" resultMap="userData">
        select * from t_user
        where f_id = #{id}
    </select>

    <select id="getUserInfoToMap" resultType="hashmap">
        select * from t_user
        where f_id=#{id}
    </select>

    <delete id="deleteAll">
        delete from t_user
    </delete>

    <delete id="deleteUserInfoById">
        delete from t_user where
        id=#{id}
    </delete>

    <update id="updateUserInfo">
        update t_user set f_name =
        #{name} where f_id =
        #{id}
    </update>

</mapper>

　　

2.2 po文件
    po文件的示例以下：

package com.lifeng.demo.mybatis.dao.dto;

import java.io.Serializable;
import java.text.SimpleDateFormat;
import java.util.Date;

public class UserInfo implements Serializable {

    private static final long serialVersionUID = 6730890636022435120L;
    private int id;
    private String name;
    private Date birth;
    private double salary;

    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 Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public double getSalary() {
        return salary;
    }

    public void setSalary(double salary) {
        this.salary = salary;
    }

    @Override
    public String toString() {
        StringBuilder builder = new StringBuilder();
        builder.append("UserInfo = [");
        builder.append("id:");
        builder.append(this.id);

        builder.append(" name:");
        builder.append(this.name);

        if (this.birth != null) {
            builder.append(" birth:");
            builder.append(new SimpleDateFormat("yyyyMMdd").format(this.birth));
        }

        builder.append(" salary:");
        builder.append(this.salary);

        return builder.toString();
    }
}

2.3 dao文件
    Dao接口的示例以下：

package com.lifeng.demo.mybatis.dao;

import java.math.BigInteger;
import java.util.Date;
import java.util.List;
import java.util.Map;

import org.apache.ibatis.annotations.MapKey;
import org.apache.ibatis.annotations.Param;

import com.lifeng.demo.mybatis.dao.dto.UserInfo;

public interface IUserDao {
    
    List<UserInfo> listUserInfo();
    
    int getUserCount();
    
    UserInfo getUserInfoById(int Id);
    
    Map<String,Object> getUserInfoToMap(int id);
    
    @MapKey("f_id")
    Map<BigInteger,Map<String,Object>> listUserInfoToMap();
    
    int insertUserInfoByBean(UserInfo userInfo);
    
    int insertUserInfo(@Param("id") int id,@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") double salary);
    
    int insertUserInfoByBatch(List<UserInfo> ls);
    
    int updateUserInfo(UserInfo userInfo);
    
    int deleteUserInfoById(int Id);
    
    int deleteAll();
}

3 經常使用元素
3.1 resultMap
    使用resultMap配置節，創建po類的數據字段與數據庫表的列名之間的映射關係。當po類的數據字段與數據庫表的列名不一致的時候，可以使用該配置。 resultMap的代碼示例以下：

<resultMap type="UserInfo" id="userData">
        <id property="id" column="f_id" />
        <result property="name" column="f_name" />
        <result property="birth" column="f_birth" />
        <result property="salary" column="f_salary" />
</resultMap>

    type屬性執行po類的全類型名，即：包名+類名。若是在mybatis配置文件中，爲po類創建了別名，那麼type屬性能夠引用該別名。
    id屬性應該全局惟一，它被select元素的resultMap屬性引用。

    <id>子元素用來創建po數據字段與數據庫表主鍵列之間的映射關係。
    <result>子元素用來創建po數據字段與數據庫表非主鍵列之間的映射關係。
    property屬性用來指定po類的數據字段名。例如：private String name；該定義中的name。
    column屬性用來指定數據庫表的列名。
3.2 select
    在mapper文件中，使用select元素來管理select語句。
3.2.1 返回單值
當查詢結果返回一個單值的時候，其配置以下：

<select id="getUserCount" resultType="int">
select count(*) from t_user
</select>

    使用resultType屬性指定返回結果的數據類型，這裏能夠是java基本數據類型，如：int,String等。

    在IDao類中，接口方法定義以下：

int getUserCount();

    方法的返回值類型是int，與resultType的值對應；方法的名稱是getUserCount與id屬性的值對應。

3.2.2 返回單對象

    單對象的含義是：查詢結果包含多個數據列，但只有一行數據。可使用javabean或者map來保存查詢結果。

3.2.2.1經過javabean返回單對象
    經過javabean返回查詢結果的配置以下：

<select id="getUserInfoById" resultMap="userData">
select * from t_user
where f_id = #{id}
</select>

    當po類的數據字段與數據庫表的列名徹底一致的時候，可以使用resultType=po類全類型名，或po類別名 的方式指定查詢結果的類型。

    當po類的數據字段與數據庫表的列名不一致的時候，須要定義resultMap映射。在這種狀況下，使用resultMap屬性，該屬性的值與<resultMap>元素的id屬性的值相同。
    resultMap與resultType不能同時使用。
    在IDao類中，接口方法的定義以下：

UserInfo getUserInfoById(int id)

    返回值的類型是UserInfo，經過<resultMap>元素的配置，將該類型映射到userData。在<select>元素中，經過resultMap屬性引用userData.

3.2.2.2經過map返回單對象
    當查詢結果是一個單對象，可是沒有定義po類的時候，可以使用map來承載查詢結果。map的key是數據庫表的列名，value是該列對應的值。mapper映射文件的配置以下：

<select id="getUserInfoToMap" resultType="hashmap">
select * from t_user where f_id=#{id}
</select>

    resultType屬性的值設定爲hashmap，或者map便可。IDao類中，接口方法定義以下：

Map<String,Object> getUserInfoToMap(int id);

 

3.2.3返回數據集
    數據集的含義是：包含多行數據，每行數據包含多列。

3.2.3.1經過list返回數據集
    當查詢結果返回一個數據集的時候，mybatis會將查詢結果放入list中，而後返回。在這種狀況下,resultTpye或者resultMap屬性指定的是list列表元素的類型，而非集合自己。mapper映射文件的配置以下：

<select id="listUserInfo" resultMap="userData">
select * from t_user
</select>

    resultMap或者resultType能夠設定爲java bean ，也可設定爲map。該配置形式與返回單對象相同，其差異在IDao類中的接口方法定義：

list<UserInfo> listUserInfo();

    在定義接口方法的時候，須要使用list包裝單值對象的類型。

 

3.2.3.2經過map返回數據集
    該方式須要與註解@MapKey配合使用。map的key是：數據庫表中的任意一列，通常選具備索引性質的列，如：id，name等。value是：po類的引用，或者另一個map的引用。mapper配置文件的內容以下：

<select id="listUserInfoToMap" resultType="map">
select * from t_user
</select>

    在IDao類中，接口方法的定義以下：

@MapKey("f_id")
Map<BigInteger,Map<String,Object>> listUserInfoToMap();

    在上面的示例中，value的值是map類型。value的值也能夠是po類。在使用po類的時候，mapper映射文件的配置以下：

<select id="listUserInfo" resultMap="userData">
select * from t_user
</select>

    在IDao類中，接口方法定義以下：

@MapKey("id")
map<int,UserInfo> listUserInfo();

 

3.3結論
resultType使用匯總以下，resultType屬性的值能夠是以下情形：
      1.基本數據類型，如：int,String等；
      2.class數據類型，如：java bean，這裏輸入的是全類型名或者別名;
      3.map數據類型。包括：單對象和集合兩種；
      4.集合數據類型，是集合元素的類型，而非集合自己。
   resultMap的使用匯總以下：
   該屬性的值是：<resultMap>元素的id屬性的值。只有當po數據字段與數據庫表列名不一致的時候，才使用。
3.3 insert
    在mybatis中，使用<insert>元素來管理insert語句。若是sql語句比較簡單，可以使用@Insert註解來代替mapper映射文件。
    若是須要插入的數據字段比較多，可使用po類封裝這些數據字段，示例以下：

<insert id="insertUserInfoByBean" parameterType="UserInfo">
insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})
</insert>

    IDao類的接口方法定義以下：

int insertUserInfoByBean(UserInfo userInfo);

   <insert>元素的id屬性值是IDao類接口方法的名稱。

    <insert>元素的parameterType屬性值能夠省略。其值是接口方法參數的類型。若是接口方法的參數是java bean，那麼該值是全類型名（即：包名+類名），或者是類型的別名。
     注意：在sql語句中，如：#{name}，#{birth}等參數，其名稱：name,birth，必須與接口參數UserInfo的數據字段一致。即：UserInfo的數據字段名稱必須是name,birth。不然沒法識別。

    若是須要插敘的數據字段比較少，那麼能夠直接傳遞給參數到接口方法中，mapper映射文件的示例以下：

<insert id="insertUserInfo" >
insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})
</insert>

    IDao接口類的定義以下：

int insertUserInfo(@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") double salary);

    註解@Param用來指定接口方法的參數名與sql語句中的參數名之間的映射。@Param註解的參數，如：name，必須與sql語句中的參數，如：#{name}中的name 是徹底一致的。

    若是sql語句比較簡單，可使用註解來代替mapper映射文件，示例以下：

@Insert("{insert into t_user (f_name,f_birth,f_salary) values (#{name},#{birth},#{salary})}")
int insertUserInfo(@Param("name") String userName,@Param("birth") Date birthDay,@Param("salary") double salary);

3.4 update

    <update>元素用來維護update類型的sql語句。若是該sql語句比較簡單，可使用@Update註解代替mapper映射文件。

3.5 delete
    <delete>元素用來維護delete類型的sql語句。若是該sql語句比較簡單，可使用@Delete註解來代替mapper映射文件。

3.6 動態sql
    使用動態sql來支持複雜的sql語句。在動態sql部分，包含以下xml元素：
if, choose, when, otherwise, trim, where, set, foreach。

3.6.1示例表
    以以下表結構示例動態sql：

3.6.2 if語句
    根據 username 和 sex 來查詢數據。若是username爲空，那麼將只根據sex來查詢；反之只根據username來查詢。首先不使用 動態SQL 來書寫

<select id="selectUserByUsernameAndSex"
resultType="user" parameterType="com.ys.po.User">
<!-- 這裏和普通的sql 查詢語句差很少，對於只有一個參數，後面的 #{id}表示佔位符，裏面不必定要寫id,
寫啥均可以，可是不要空着，若是有多個參數則必須寫pojo類裏面的屬性 -->
select * from user where username=#{username} and sex=#{sex}
</select>

    上面的查詢語句，咱們能夠發現，若是 #{username} 爲空，那麼查詢結果也是空，如何解決這個問題呢？使用 if 來判斷

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
select * from user where
<if test="username != null">
username=#{username}
</if>

<if test="username != null">
and sex=#{sex}
</if>
</select>

      這樣寫咱們能夠看到，若是 sex 等於 null，那麼查詢語句爲 select * from user where username=#{username},可是若是usename 爲空呢？那麼查詢語句爲 select * from user where and sex=#{sex}，這是錯誤的 SQL 語句，如何解決呢？請看下面的 where 語句

3.6.3 if + where 語句

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
select * from user
<where>
<if test="username != null">
username=#{username}
</if>

<if test="username != null">
and sex=#{sex}
</if>
</where>
</select>

    這個「where」標籤會知道若是它包含的標籤中有返回值的話，它就插入一個‘where’。此外，若是標籤返回的內容是以AND 或OR 開頭的，則它會剔除掉。

3.6.3 if + set 語句
     同理，上面的對於查詢 SQL 語句包含 where 關鍵字，若是在進行更新操做的時候，含有 set 關鍵詞，咱們怎麼處理呢？

<!-- 根據 id 更新 user 表的數據 -->
<update id="updateUserById" parameterType="com.ys.po.User">
update user u
<set>
<if test="username != null and username != ''">
u.username = #{username},
</if>
<if test="sex != null and sex != ''">
u.sex = #{sex}
</if>
</set>

where id=#{id}
</update>

 

    這樣寫，若是第一個條件 username 爲空，那麼 sql 語句爲：update user u set u.sex=? where id=? ； 若是第一個條件不爲空，那麼 sql 語句爲：update user u set u.username = ? ,u.sex = ? where id=?
3.6.4 choose(when,otherwise) 語句
    有時候，咱們不想用到全部的查詢條件，只想選擇其中的一個，查詢條件有一個知足便可，使用 choose 標籤能夠解決此類問題，相似於 Java 的 switch 語句

<select id="selectUserByChoose" resultType="com.ys.po.User" parameterType="com.ys.po.User">
select * from user
<where>
<choose>
<when test="id !='' and id != null">
id=#{id}
</when>
<when test="username !='' and username != null">
and username=#{username}
</when>
<otherwise>
and sex=#{sex}
</otherwise>
</choose>
</where>
</select>

    也就是說，這裏咱們有三個條件，id,username,sex，只能選擇一個做爲查詢條件

　　　　若是 id 不爲空，那麼查詢語句爲：select * from user where id=?
　　　　若是 id 爲空，那麼看username 是否爲空，若是不爲空，那麼語句爲 select * from user where username=?;
　　　　　　　　　　若是 username 爲空，那麼查詢語句爲 select * from user where sex=?

3.6.5 trim語句
    trim標記是一個格式化的標記，能夠完成set或者是where標記的功能
　　①、用 trim 改寫上面第二點的 if+where 語句

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
select * from user
<!-- <where>
<if test="username != null">
username=#{username}
</if>

<if test="username != null">
and sex=#{sex}
</if>
</where> -->
<trim prefix="where" prefixOverrides="and | or">
<if test="username != null">
and username=#{username}
</if>
<if test="sex != null">
and sex=#{sex}
</if>
</trim>
</select>

 

prefix：前綴；prefixoverride：去掉第一個and或者是or。
②、用 trim 改寫上面第三點的 if+set 語句

<!-- 根據 id 更新 user 表的數據 -->
<update id="updateUserById" parameterType="com.ys.po.User">
update user u
<!-- <set>
<if test="username != null and username != ''">
u.username = #{username},
</if>
<if test="sex != null and sex != ''">
u.sex = #{sex}
</if>
</set> -->
<trim prefix="set" suffixOverrides=",">
<if test="username != null and username != ''">
u.username = #{username},
</if>
<if test="sex != null and sex != ''">
u.sex = #{sex},
</if>
</trim>

where id=#{id}
</update>　　 　

 

　suffix：後綴　　
suffixoverride：去掉最後一個逗號（也能夠是其餘的標記，就像是上面前綴中的and同樣）　
3.6.6 SQL片斷
有時候可能某個 sql 語句咱們用的特別多，爲了增長代碼的重用性，簡化代碼，咱們須要將這些代碼抽取出來，而後使用時直接調用。
好比：假如咱們須要常常根據用戶名和性別來進行聯合查詢，那麼咱們就把這個代碼抽取出來，以下：

<!-- 定義 sql 片斷 -->
<sql id="selectUserByUserNameAndSexSQL">
<if test="username != null and username != ''">
AND username = #{username}
</if>
<if test="sex != null and sex != ''">
AND sex = #{sex}
</if>
</sql>

 

引用 sql 片斷

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="com.ys.po.User">
select * from user
<trim prefix="where" prefixOverrides="and | or">
<!-- 引用 sql 片斷，若是refid 指定的不在本文件中，那麼須要在前面加上 namespace -->
<include refid="selectUserByUserNameAndSexSQL"></include>
<!-- 在這裏還能夠引用其餘的 sql 片斷 -->
</trim>
</select>

 

注意：①、最好基於 單表來定義 sql 片斷，提升片斷的可重用性
　　    ②、在 sql 片斷中不要包括 where

3.6.7 foreach語句
需求：咱們須要查詢 user 表中 id 分別爲1,2,3的用戶
　　sql語句：select * from user where id=1 or id=2 or id=3
　　　　　　 select * from user where id in (1,2,3)
①、創建一個 UserVo 類，裏面封裝一個 List<Integer> ids 的屬性

package com.ys.vo;

import java.util.List;

public class UserVo {
//封裝多個用戶的id
private List<Integer> ids;

public List<Integer> getIds() {
return ids;
}

public void setIds(List<Integer> ids) {
this.ids = ids;
}

}　　

 

②、咱們用 foreach 來改寫 select * from user where id=1 or id=2 or id=3

<select id="selectUserByListId" parameterType="com.ys.vo.UserVo" resultType="com.ys.po.User">
select * from user
<where>
<!--
collection:指定輸入對象中的集合屬性。該屬性的值有三種：list,array,map，根據傳入的集合類型而設定該值。
item:每次遍歷生成的對象
index:當前迭代的次數
open:開始遍歷時的拼接字符串
close:結束時拼接的字符串
separator:遍歷對象之間須要拼接的字符串
select * from user where 1=1 and (id=1 or id=2 or id=3)
-->
<foreach collection="list" item="id" open="and (" close=")" separator="or">
id=#{id}
</foreach>
</where>
</select>

 

③、咱們用 foreach 來改寫 select * from user where id in (1,2,3)

<select id="selectUserByListId" parameterType="com.ys.vo.UserVo" resultType="com.ys.po.User">
select * from user
<where>
<!--
collection:指定輸入對象中的集合屬性.該屬性的值有三種：list,array,map，根據傳入的集合類型而設定該值。
item:每次遍歷生成的對象
index:當前迭代的次數
open:開始遍歷時的拼接字符串
close:結束時拼接的字符串
separator:遍歷對象之間須要拼接的字符串
select * from user where 1=1 and id in (1,2,3)
-->
<foreach collection="list" item="id" open="and id in (" close=") " separator=",">
#{id}
</foreach>
</where>
</select>