Mybatis中xml方式实现mapper总结

悠悠 2021-11-13 23:02 437阅读 0赞

Mybatis中实现mapper对sql的操作有两种方式，一种是注解形式，另一种是.xml文件形式。对于sql的一些简单操作而言，使用注解方式非常的简便，但是遇到一些复杂的sql操作时，就需要用到.xml文件形式了。

--------------------

mybatis 的动态sql语句是基于OGNL表达式的。可以方便的在 sql 语句中实现某些逻辑. 总体说来mybatis 动态SQL 语句主要有以下几类:

*  if 语句 (简单的条件判断)
 *  choose (when,otherwize) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似.
 *  trim (对包含的内容加上 prefix,或者 suffix 等，前缀，后缀)
 *  where (主要是用来简化sql语句中where条件判断的，能智能的处理 and or ,不必担心多余导致语法错误)
 *  set (主要用于更新时)
 *  foreach (在实现 mybatis in 语句查询时特别有用)

下面分别介绍这几种处理方式

### if ###

<select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
    select * from t_blog where 1 = 1
    <if test="title != null">
    and title = #{title}
    </if>
    <if test="content != null">
    and content = #{content}
    </if>
    <if test="owner != null">
    and owner = #{owner}
    </if>
    </select>

如果你提供了title参数，那么就要满足title=\#\{title\}，同样如果你提供了Content和Owner的时候，它们也需要满足相应的条件，之后就是返回满足这些条件的所有Blog，这是非常有用的一个功能。  
以往我们使用其他类型框架或者直接使用JDBC的时候， 如果我们要达到同样的选择效果的时候，我们就需要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了。

### choose (when,otherwize) ###

相当于java 语言中的 switch

<select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
     select * from t_blog where 1 = 1 
     <choose>
     <when test="title != null">
     and title = #{title}
     </when>
     <when test="content != null">
     and content = #{content}
     </when>
     <otherwise>
     and owner = "owner1"
     </otherwise>
     </choose>
    </select>

when元素表示当when中的条件满足的时候就输出其中的内容，跟JAVA中的switch效果差不多的是按照条件的顺序，当when中有条件满足的时候，就会跳出choose，即所有的when和otherwise条件中，只有一个会输出，当所有的我很条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单，当title!=null的时候就输出and titlte = \#\{title\}，不再往下判断条件，当title为空且content!=null的时候就输出and content = \#\{content\}，当所有条件都不满足的时候就输出otherwise中的内容。

### trim ###

对包含的内容加上前缀和后缀。

<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
    select * from t_blog 
    <trim prefix="where" prefixOverrides="and |or">
    <if test="title != null">
    title = #{title}
    </if>
    <if test="content != null">
    and content = #{content}
    </if>
    <if test="owner != null">
    or owner = #{owner}
    </if>
    </trim>
    </select>

trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where元素的功能。

trim标记是一个格式化的标记，可以完成set或者是where标记的功能，如下代码：

select * from user 
    <trim prefix="WHERE" prefixoverride="AND |OR">
    <if test="name != null and name.length()>0"> 
    AND name=#{name}
    </if>
    <if test="gender != null and gender.length()>0"> 
    AND gender=#{gender}
    </if>
    </trim>

### where ###

主要是用来简化sql语句中where条件判断的，能智能的处理 and or 条件。

<select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
    select * from t_blog 
    <where>
    <if test="title != null">
    title = #{title}
    </if>
    <if test="content != null">
    and content = #{content}
    </if>
    <if test="owner != null">
    and owner = #{owner}
    </if>
    </where>
    </select>

where元素的作用是会在写入where元素的地方输出一个where，另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的，MyBatis会智能的帮你处理，如果所有的条件都不满足那么MyBatis就会查出所有的记录，如果输出后是and 开头的，MyBatis会把第一个and忽略，当然如果是or开头的，MyBatis也会把它忽略；此外，在where元素中你不需要考虑空格的问题，MyBatis会智能的帮你加上。像上述例子中，如果title=null， 而content != null，那么输出的整个语句会是select \* from t\_blog where content = \#\{content\}，而不是select \* from t\_blog where and content = \#\{content\}，因为MyBatis会智能的把首个and 或 or 给忽略。

### set ###

主要用于更新时。

<update id="dynamicSetTest" parameterType="Blog">
    update t_blog
    <set>
    <if test="title != null">
    title = #{title},
    </if>
    <if test="content != null">
    content = #{content},
    </if>
    <if test="owner != null">
    owner = #{owner}
    </if>
    </set>
    where id = #{id}
    </update>

set元素主要是用在更新操作的时候，它的主要功能和where元素其实是差不多的，主要是在包含的语句前输出一个set，然后如果包含的语句是以逗号结束的话将会把该逗号忽略，如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。

### foreach ###

在实现 in 语句查询时经常用到。

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。

>  *  item表示集合中每一个元素进行迭代时的别名。
>  *  index指定一个名字，用于表示在迭代过程中，每次迭代到的位置。
>  *  open表示该语句以什么开始。
>  *  separator表示在每次进行迭代之间以什么符号作为分隔符。
>  *  close表示以什么结束。

在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：

>  *  如果传入的是单参数且参数类型是一个List的时候，collection属性值为list
>  *  如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
>  *  如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了，此时传入collection的值应为将会使用到的map里的key。

**单参数List的类型：**

<select id="dynamicForeachTest" resultType="com.mybatis.entity.User">
    select * from t_user where id in
    <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
    #{item}
    </foreach>
    </select>

上述collection的值为list，对应的Mapper是这样的：

/**mybatis Foreach测试 */
    public List<User> dynamicForeachTest(List<Integer> ids);

测试代码：

@Test
    public void dynamicForeachTest() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<Integer> ids = new ArrayList<Integer>();
    ids.add(1);
    ids.add(2);
    ids.add(6);
    List<User> userList = mapper.dynamicForeachTest(ids);
    for (User user : userList){
    System.out.println(user);
    }
    sqlSession.close();
    }

**数组类型的参数：**

<select id="dynamicForeach2Test" resultType="com.mybatis.entity.User">
    select * from t_user where id in
    <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
    #{item}
    </foreach>
    </select>

对应mapper：

public List<User> dynamicForeach2Test(int[] ids);

测试代码：

@Test
    public void dynamicForeach2Test() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    int[] ids = {1,2,6};
    List<User> userList = mapper.dynamicForeach2Test(ids);
    for (User user : userList){
    System.out.println(user);
    }
    sqlSession.close();
    }

**Map类型的参数：**

<select id="dynamicForeach3Test" resultType="com.mybatis.entity.User">
    select * from t_user where username like '%${username}%' and id in
    <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
    #{item}
    </foreach>
    </select>

mapper ：

/**mybatis Foreach测试 */
    public List<User> dynamicForeach3Test(Map<String, Object> params);

测试方法：

@Test
    public void dynamicForeach3Test() {
    SqlSession sqlSession = sqlSessionFactory.openSession();
    UserMapper mapper = sqlSession.getMapper(UserMapper.class);
    List<Integer> ids = new ArrayList<Integer>();
    ids.add(1);
    ids.add(2);
    ids.add(6);
    Map map =new HashMap();
    map.put("username", "小");
    map.put("ids", ids);
    List<User> userList = mapper.dynamicForeach3Test(map);
    System.out.println("------------------------");
    for (User user : userList){
    System.out.println(user);
    }
    sqlSession.close();
    }