zl程序教程

您现在的位置是:首页 >  数据库

当前栏目

mapper

2023-03-07 09:46:20 时间

Mapper映射文件是一个xml格式文件,必须遵循相应的dtd文件规范,如ibatis-3-mapper.dtd。我们先大体上看看支持哪些配置?如下所示,从Eclipse里截了个屏:

从上图可以看出,映射文件是以<mapper>作为根节点,在根节点中支持9个元素,分别为insert、update、delete、select(增删改查);cache、cache-ref、resultMap、parameterMap、sql。

下文中,我们将首先对增删改进行描述,然后对查进行详细说明,最后对其他五个元素进行简单说明。

(1)insert、update、delete

我们先从配置文件看起:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper     
  3. PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
  4. "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
  5. <!-- mapper 为根元素节点, 一个namespace对应一个dao -->
  6. <mapper namespace="com.dy.dao.UserDao">
  7. <insert
  8.       <!-- 1. id (必须配置)  
  9.         id是命名空间中的唯一标识符,可被用来代表这条语句。   
  10.         一个命名空间(namespace) 对应一个dao接口,   
  11.         这个id也应该对应dao里面的某个方法(相当于方法的实现),因此id 应该与方法名一致 -->
  12. id="addUser"
  13.       <!-- 2. parameterType (可选配置, 默认为mybatis自动选择处理)  
  14.         将要传入语句的参数的完全限定类名或别名, 如果不配置,mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  
  15.         parameterType 主要指定参数类型,可以是int, short, long, string等类型,也可以是复杂类型(如对象) -->
  16. parameterType="user"
  17.       <!-- 3. flushCache (可选配置,默认配置为true)  
  18.         将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:true(对应插入、更新和删除语句) -->
  19. flushCache="true"
  20.       <!-- 4. statementType (可选配置,默认配置为PREPARED)  
  21.         STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。 -->
  22. statementType="PREPARED"
  23.       <!-- 5. keyProperty (可选配置, 默认为unset)  
  24.         (仅对 insert 和 update 有用)唯一标记一个属性,MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值,默认:unset。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 -->
  25. keyProperty=""
  26.       <!-- 6. keyColumn     (可选配置)  
  27.         (仅对 insert 和 update 有用)通过生成的键值设置表中的列名,这个设置仅在某些数据库(像 PostgreSQL)是必须的,当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 -->
  28. keyColumn=""
  29.       <!-- 7. useGeneratedKeys (可选配置, 默认为false)  
  30.         (仅对 insert 和 update 有用)这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段),默认值:false。  -->
  31. useGeneratedKeys="false"
  32.       <!-- 8. timeout  (可选配置, 默认为unset, 依赖驱动)  
  33.         这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。 -->
  34. timeout="20">
  35. <update
  36. id="updateUser"
  37. parameterType="user"
  38. flushCache="true"
  39. statementType="PREPARED"
  40. timeout="20">
  41. <delete
  42. id="deleteUser"
  43. parameterType="user"
  44. flushCache="true"
  45. statementType="PREPARED"
  46. timeout="20">
  47. </mapper></span>

上面给出了一个比较全面的配置说明,但是在实际使用过程中并不需要都进行配置,可根据自己的需要删除部分配置项。

在这里,我列举出我自己的配置文件,精简之后是这样的:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper     
  3. PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
  4. "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
  5. <mapper namespace="com.majing.learning.mybatis.dao.UserDao">
  6. <insert id="addUser" parameterType="user" useGeneratedKeys="true" keyProperty="id">
  7.         insert into user(name,password,age) values(#{name},#{password},#{age})  
  8. </insert>
  9. <delete id="deleteUser" parameterType="int">
  10.         delete from user where id = #{id}  
  11. </delete>
  12. <update id="updateUser" parameterType="user" >
  13.         update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}  
  14. </update>
  15. </mapper></span> 这里的parameterType设置成user是因为如果不设置的情况下,会自动将类名首字母小写后的名称,原来的类名为User。不过,建议大家还是使用typeAlias进行配置吧。唯一需要说明的就是<insert>元素里面的useGeneratedKeys和keyProperties属性,这两个属性是用来获取数据库中的主键的。

在数据库里面经常性的会给数据库表设置一个自增长的列作为主键,如果我们操作数据库后希望能够获取这个主键该怎么弄呢?正如上面所述,如果是支持自增长的数据库,如mysql数据库,那么只需要设置useGeneratedKeys和keyProperties属性便可以了,但是对于不支持自增长的数据库(如oracle)该怎么办呢?

mybatis里面在<insert>元素下面提供了<selectKey>子元素用于帮助解决这个问题。来看下配置:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><selectKey
  2. <!-- selectKey 语句结果应该被设置的目标属性。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 -->
  3. keyProperty="id"
  4. <!-- 结果的类型。MyBatis 通常可以推算出来,但是为了更加确定写上也不会有什么问题。MyBatis 允许任何简单类型用作主键的类型,包括字符串。如果希望作用于多个生成的列,则可以使用一个包含期望属性的 Object 或一个 Map。 -->
  5. resultType="int"
  6. <!-- 这可以被设置为 BEFORE 或 AFTER。如果设置为 BEFORE,那么它会首先选择主键,设置 keyProperty 然后执行插入语句。如果设置为 AFTER,那么先执行插入语句,然后是 selectKey 元素 - 这和像 Oracle 的数据库相似,在插入语句内部可能有嵌入索引调用。 -->
  7. order="BEFORE"
  8. <!-- 与前面相同,MyBatis 支持 STATEMENT,PREPARED 和 CALLABLE 语句的映射类型,分别代表 PreparedStatement 和 CallableStatement 类型。 -->
  9. statementType="PREPARED">
  10. </selectKey>
  11. </span>

针对不能使用自增长特性的数据库,可以使用下面的配置来实现相同的功能:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><insert id="insertUser" parameterType="com.dy.entity.User">
  2. <!-- oracle等不支持id自增长的,可根据其id生成策略,先获取id -->
  3. <selectKey resultType="int" order="BEFORE" keyProperty="id">
  4.               select seq_user_id.nextval as id from dual  
  5. </selectKey>
  6.            insert into user(id, name, password, age, deleteFlag)   
  7.                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})  
  8. </insert></span>

讲完了insert、update、delete,接下来我们看看用的比较多的select。

(2)select、resultType、resultMap

我们先来看看select元素都有哪些配置可以设置:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><select
  2.         <!--  1. id (必须配置)  
  3.         id是命名空间中的唯一标识符,可被用来代表这条语句。   
  4.         一个命名空间(namespace) 对应一个dao接口,   
  5.         这个id也应该对应dao里面的某个方法(相当于方法的实现),因此id 应该与方法名一致  -->
  6. id="findUserById"
  7.      <!-- 2. parameterType (可选配置, 默认为mybatis自动选择处理)  
  8.         将要传入语句的参数的完全限定类名或别名, 如果不配置,mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  
  9.         parameterType 主要指定参数类型,可以是int, short, long, string等类型,也可以是复杂类型(如对象) -->
  10. parameterType="int"
  11.      <!-- 3. resultType (resultType 与 resultMap 二选一配置)  
  12.          resultType用以指定返回类型,指定的类型可以是基本类型,可以是java容器,也可以是javabean -->
  13. resultType="User"
  14.      <!-- 4. resultMap (resultType 与 resultMap 二选一配置)  
  15.          resultMap用于引用我们通过 resultMap标签定义的映射类型,这也是mybatis组件高级复杂映射的关键 -->
  16. resultMap="userResultMap"
  17.      <!-- 5. flushCache (可选配置)  
  18.          将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:false -->
  19. flushCache="false"
  20.      <!-- 6. useCache (可选配置)  
  21.          将其设置为 true,将会导致本条语句的结果被二级缓存,默认值:对 select 元素为 true -->
  22. useCache="true"
  23.      <!-- 7. timeout (可选配置)   
  24.          这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)-->
  25. timeout="10000"
  26.      <!-- 8. fetchSize (可选配置)   
  27.          这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset(依赖驱动)-->
  28. fetchSize="256"
  29.      <!-- 9. statementType (可选配置)   
  30.          STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED-->
  31. statementType="PREPARED"
  32.      <!-- 10. resultSetType (可选配置)   
  33.          FORWARD_ONLY,SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个,默认值为 unset (依赖驱动)-->
  34. resultSetType="FORWARD_ONLY"></span>

我们还是从具体的示例来看看,

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><select id="findUserById" resultType="User">
  2.     select * from user where id = #{id}  
  3. </select></span>

这里我们根据用户id去查询这个用户的信息,resultType=User是一个别名,如果我们接触到的是这种一对一的问题,那么可以简单的定义一个实体,这个实体代表数据库表中的一条记录即可。但是如果我们遇到一对多的问题呢,就拿这里的查询用户信息来说,如果每个用户有各种兴趣,需要维护每个用户的兴趣信息,那么我们可能就存在下面的数据表结构:

[javascript]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;">CREATE TABLE `user` (  
  2.   `id` int(11) NOT NULL AUTO_INCREMENT,  
  3.   `name` varchar(255) NOT NULL,  
  4.   `password` varchar(255) NOT NULL,  
  5.   `age` int(3) DEFAULT NULL,  
  6.   PRIMARY KEY (`id`)  
  7. ) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8;  
  8. CREATE TABLE `userinterests` (  
  9.   `userid` int(11) DEFAULT NULL,  
  10.   `interestid` int(11) DEFAULT NULL  
  11. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;  
  12. CREATE TABLE `interests` (  
  13.   `interestid` int(11) NOT NULL,  
  14.   `interestname` varchar(255) DEFAULT NULL,  
  15.   PRIMARY KEY (`interestid`)  
  16. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</span>  

其中user表用于记录用户信息,interests表用于维护所有的兴趣标签,而userinterests用于维护每个用户的兴趣情况。

这时候,如果我们需要根据用户id去查询用户的信息和兴趣信息该怎么做呢?这时候我们就要用到<select>中的另一个重要属性了,那就是resultMap。

在配置查询的返回结果时,resultType和resultMap是二选一的操作。对于比较复杂的查询结果,一般都会设置成resultMap。

resultMap该怎么配置呢?又支持哪些配置呢?我们看看下面:

[html]  view plain copy

  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><resultMap type="" id="">
  2.         <!-- id, 唯一性,注意啦,这个id用于标示这个javabean对象的唯一性, 不一定会是数据库的主键(不要把它理解为数据库对应表的主键)   
  3.             property属性对应javabean的属性名,column对应数据库表的列名  
  4.             (这样,当javabean的属性与数据库对应表的列名不一致的时候,就能通过指定这个保持正常映射了)  
  5.         -->
  6. <id property="" column=""/>
  7. <!-- result与id相比, 对应普通属性 -->
  8. <result property="" column=""/>
  9. <!-- 
  10.             constructor对应javabean中的构造方法
  11.          -->
  12. <constructor>
  13. <!-- idArg 对应构造方法中的id参数 -->
  14. <idArg column=""/>
  15. <!-- arg 对应构造方法中的普通参数 -->
  16. <arg column=""/>
  17. </constructor>
  18.         <!--   
  19.             collection,对应javabean中容器类型, 是实现一对多的关键   
  20.             property 为javabean中容器对应字段名  
  21.             column 为体现在数据库中列名  
  22.             ofType 就是指定javabean中容器指定的类型  
  23.         -->
  24. <collection property="" column="" ofType=""></collection>
  25.         <!--   
  26.             association 为关联关系,是实现N对一的关键。  
  27.             property 为javabean中容器对应字段名  
  28.             column 为体现在数据库中列名  
  29.             javaType 指定关联的类型  
  30.          -->
  31. <association property="" column="" javaType=""></association>
  32. </resultMap></span>
 1  更新单条记录 

UPDATE course SET name = 'course1' WHEREid= 'id1';

2  更新多条记录的同一个字段为同一个值

 UPDATEcourseSETname='course1'WHEREidin('id1','id2','id3);

3  更新多条记录为多个字段为不同的值

比较普通的写法,是通过循环,依次执行update语句。

Mybatis写法如下: 

<update id="updateBatch"  parameterType="java.util.List">  
    <foreach collection="list" item="item" index="index" open="" close="" separator=";">
        update course
        <set>
            name=${
      item.name}
        </set>
        where id = ${
      item.id}
    </foreach>      
</update>
一条记录update一次,性能比较差,容易造成阻塞。

MySQL没有提供直接的方法来实现批量更新,但可以使用case when语法来实现这个功能。

 UPDATE course
    SET name = CASE id 
        WHEN 1 THEN 'name1'
        WHEN 2 THEN 'name2'
        WHEN 3 THEN 'name3'
    END, 
    title = CASE id 
        WHEN 1 THEN 'New Title 1'
        WHEN 2 THEN 'New Title 2'
        WHEN 3 THEN 'New Title 3'
    END
WHERE id IN (1,2,3)
这条sql的意思是,如果id为1,则name的值为name1,title的值为New Title1;依此类推。

在Mybatis中的配置则如下:

 <updateid="updateBatch"parameterType="list">

            update course
            <trim prefix="set" suffixOverrides=",">
             <trim prefix="name=case" suffix="end,">
                 <foreach collection="list" item="item" index="index">
                         <if test="item.name!=null">
                          when id=#{item.id} then #{item.name}
                         </if>
                 </foreach>
              </trim>
              <trim prefix="title =case" suffix="end,">
                 <foreach collection="list" item="item" index="index">
                         <if test="item.title!=null">
                          when id=#{item.id} then #{item.title}
                         </if>
                 </foreach>
              </trim>
             </trim>
            where
            <foreach collection="list" separator="or" item="item" index="index">
              id=#{item.id}
          </foreach>
</update>
     
<trim>属性说明 
1. prefix,suffix  表示在 trim 标签包裹的部分的前面或者后面添加内容 
2.如果同时有 prefixOverrides,suffixOverrides  表示会用 prefix,suffix 覆盖 Overrides 中的内容。 
3.如果只有 prefixOverrides,suffixOverrides  表示删除开头的或结尾的 xxxOverides 指定的内容。
4  sql批量更新   
     看另外一个示例:
      < update id = "updateBatch" parameterType = "java.util.List" >
    update mydata_table 
    set  status=
    <foreach collection="list" item="item" index="index" 
        separator=" " open="case ID" close="end">
        when #{item.id} then #{item.status}
    </foreach>
    where id in
    <foreach collection="list" index="index" item="item" 
        separator="," open="(" close=")">
        #{item.id,jdbcType=BIGINT}
    </foreach>
 </update>
     其中 when...then... 是 sql 中的 "switch"  语法。这里借助 mybatis 的 <foreach> 语法来拼凑成了批量更新的 sql ,上面的意思就是批量更新 id 在 updateBatch 参数所传递 List 中的数据的status 字段。还可以使用 <trim> 实现同样的功能,代码如下:
<update id="updateBatch" parameterType="java.util.List">
        update mydata_table
        <trim prefix="set" suffixOverrides=",">
            <trim prefix="status =case" suffix="end,">
                <foreach collection="list" item="item" index="index">
                     when id=#{item.id} then #{item.status}
                </foreach>
            </trim>
        </trim>
        where id in
        <foreach collection="list" index="index" item="item" separator="," open="(" close=")">
            #{item.id,jdbcType=BIGINT}
        </foreach>
</update>
其结构如下:
    update mydata_table 
    set status = 
    case
        when id = #{item.id} then #{item.status}//此处应该是<foreach>展开值
        ...
    end
    where id in (...);

如果对要更新的数据进行判断,只有符合条件的数据才能进行更新,这种情况可以这么做:

<trim prefix="status =case" suffix="end,">     
 <foreach collection="list" item="item" index="index">          
<if test="item.status !=null and item.status != -1">            
  when id=#{item.id} then #{item.status}          
</if>      
</foreach> 
</trim>

这样的话只有要更新的list中status !=null&& status !=-1的数据才能进行status更新.其他的将使用默认值更新,而不会保持原数据不变.如果要保持原数据不变呢?即满足条件的更新,不满足条件的保持原数据不变,简单的来做就是再加一个<if>,因为mybatis中没有if...else...语法,但可以通过多个<if>实现同样的效果,如下:

 <trim prefix="status =case" suffix="end,">   
   <foreach collection="list" item="item" index="index">     
     <if test="item.status !=null and item.status != -1">            
  when id=#{item.id} then #{item.status}       
  </if>         
 <if test="item.status == null or item.status == -1">             
when id=#{item.id} then mydata_table.status      //这里就是原数据       
   </if>     
 </foreach>
 </trim>
    
 
整体批量更新的写法如下:      
     < update id = "updateBatch" parameterType = "java.util.List" >
        update mydata_table
        <trim prefix="set" suffixOverrides=",">
            <trim prefix="status =case" suffix="end,">
                 <foreach collection="list" item="item" index="index">
                     <if test="item.status !=null and item.status != -1">
                         when id=#{item.id} then #{item.status}
                     </if>
                     <if test="item.status == null or item.status == -1">
                         when id=#{item.id} then mydata_table.status//原数据
                     </if>
                 </foreach>
            </trim>
        </trim>
        where id in
        <foreach collection="list" index="index" item="item" separator="," open="(" close=")">
            #{item.id,jdbcType=BIGINT}
        </foreach>
</update>      

参考学习: http://blog.csdn.net/xyjawq1/article/details/74129316 我的示例: https://gitee.com/lzbgit/maven_demo/blob/master/demo-maven/src.main.resources/mapper/LoginMapper.xml