MyBatis学习总结（11）——MyBatis动态Sql语句

àì夳堔傛蜴生んèń 2022-01-13 04:55 335阅读 0赞

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][]

MyBatis中对数据库的操作，有时要带一些条件，因此动态SQL语句非常有必要，下面就主要来讲讲几个常用的动态SQL语句的语法

MyBatis中用于实现动态SQL的元素主要有：

*  **if**

*  **choose（when，otherwise）**

*  **trim**

*  **where**

*  **set**

*  **foreach**

1、if

对属性进行判断，如果不为空则执行判断条件

**\[html\]**  [view plain][] [copy][view plain]

1.  **<****select** id="selectByCriteria" parameterType="com.mucfc.dto.Student" resultMap="BaseResultMap"**>**  
2.      select \* from t\_student   
3.      where  
4.      **<****if** test="stuId != null and stuId !=''"**>**  
5.      STU\_ID = \#\{stuId\}  
6.      **</****if****>**  
7.      **<****if** test="stuName != null and stuName !=''" **>**  
8.      and STU\_NAME = \#\{stuName\}  
9.      **</****if****>**  
10.     **<****if** test="stuClass != null and stuClass !=''"**>**  
11.     and STU\_CLASS = \#\{stuClass\}  
12.     **</****if****>**  
13.     **<****if** test="stuSex != null and stuSex !=''"**>**  
14.     and STU\_SEX=\#\{stuSex\}  
15.     **</****if****>**  
16.     **<****if** test="stuAge != null and stuAge !=''"**>**  
17.     and STU\_AGE=\#\{stuAge\}  
18.     **</****if****>**       
19. **</****select****>**

来看看结果：

这是从web页面输入的参数

![05133631_9xec.jpg][]

这是输出的结果

![05133631_YG0l.jpg][]

这是打印出来的Sql语句

![05133631_Tu9C.jpg][]

从结果可以看出，只有在条件不为空的时候，属性才会赋值。

2、where

当where中的条件使用的if标签较多时，这样的组合可能会导致错误。我们以在1中的查询语句为例子，当输入参数stuId为空时，就会报错

![05133631_2OGb.jpg][]

然后是输出的结果：

![05133631_0m9L.jpg][]

此时SQL语句变成了select \* from t\_student    where                   and STU\_SEX=?这样会报错

如果上面例子，参数stuId为null，将不会进行STUDENT\_NAME列的判断，则会直接导“WHERE AND”关键字多余的错误SQL。这时我们可以使用where动态语句来解决。这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

可以改成如下：

**\[html\]**  [view plain][] [copy][view plain]

1.  **<****select** id="selectByCriteria" parameterType="com.mucfc.dto.Student" resultMap="BaseResultMap"**>**  
2.      select \* from t\_student   
3.      **<****where****>**  
4.      **<****if** test="stuId != null and stuId !=''"**>**  
5.      STU\_ID = \#\{stuId\}  
6.      **</****if****>**  
7.      **<****if** test="stuName != null and stuName !=''" **>**  
8.      and STU\_NAME = \#\{stuName\}  
9.      **</****if****>**  
10.     **<****if** test="stuClass != null and stuClass !=''"**>**  
11.     and STU\_CLASS = \#\{stuClass\}  
12.     **</****if****>**  
13.     **<****if** test="stuSex != null and stuSex !=''"**>**  
14.     and STU\_SEX=\#\{stuSex\}  
15.     **</****if****>**  
16.     **<****if** test="stuAge != null and stuAge !=''"**>**  
17.     and STU\_AGE=\#\{stuAge\}  
18.     **</****if****>**  
19.     **</****where****>**        
20. **</****select****>**

再来看看,输入查询条件

![05133632_s0yD.jpg][]

然后输出结果

![05133632_Wcfn.jpg][]

打印出来的SQL语句

![05133632_WkpW.jpg][]

\- ==>  Preparing: select \* from t\_student WHERE STU\_SEX=?   
==> Parameters: 男(String)  
 <==      Total: 14

说明结果是正确的。如果它包含的标签中有返回值的话就插入一个where。此外如果标签返回的内容是以AND或OR开头的，则它会剔除掉。

3、set

当update语句中没有使用if标签时，如果有一个参数为null，都会导致错误。  
当在update语句中使用if标签时，如果前面的if没有执行，则或导致逗号多余错误。使用set标签可以将动态的配置SET 关键字，和剔除追加到条件末尾的任何不相关的逗号。  
使用if+set标签修改后，如果某项为null则不进行更新，而是保持数据库原值。如下示例：

4、trim

trim是更灵活的去处多余关键字的标签，他可以实践where和set的效果。

**\[html\]**  [view plain][] [copy][view plain]

1.  **<****select** id="selectByCriteria" parameterType="com.mucfc.dto.Student" resultMap="BaseResultMap"**>**  
2.      select \* from t\_student   
3.      **<****trim** prefix="where" prefixOverrides="AND|OR"**>**    
4.      **<****if** test="stuId != null and stuId !=''"**>**  
5.      STU\_ID = \#\{stuId\}  
6.      **</****if****>**  
7.      **<****if** test="stuName != null and stuName !=''" **>**  
8.      and STU\_NAME = \#\{stuName\}  
9.      **</****if****>**  
10.     **<****if** test="stuClass != null and stuClass !=''"**>**  
11.     and STU\_CLASS = \#\{stuClass\}  
12.     **</****if****>**  
13.     **<****if** test="stuSex != null and stuSex !=''"**>**  
14.     and STU\_SEX=\#\{stuSex\}  
15.     **</****if****>**  
16.     **<****if** test="stuAge != null and stuAge !=''"**>**  
17.     and STU\_AGE=\#\{stuAge\}  
18.     **</****if****>**  
19.     **</****trim****>**     
20. **</****select****>**

首先判断是否需要where,如果需要，它会自动判断如果where后面有and或者or,就自动把它们都去掉。prefix是前置的，还有suffix是后置的。

如下输入查找参数stuclass=2。

![05133632_FRSB.jpg][]

看看打印出来的语句

![05133632_Ecnn.jpg][]

suffix是后置的例子

**\[html\]**  [view plain][] [copy][view plain]

1.    **<****insert** id="insert" parameterType="com.mucfc.dto.Student" **>**  
2.      insert into t\_student   
3.      **<****trim** prefix="(" suffix=")" suffixOverrides="," **>**  
4.        **<****if** test="stuId != null" **>**  
5.          STU\_ID,  
6.        **</****if****>**  
7.        **<****if** test="stu\_name!= null" **>**  
8.          STU\_NAME,  
9.        **</****if****>**  
10.     **</****trim****>**  
11.     **<****trim** prefix="values (" suffix=")" suffixOverrides="," **>**  
12.       **<****if** test="stuId  != null" **>**  
13.         \#\{stuId\},  
14.       **</****if****>**  
15.       **<****if** test="stu\_name != null" **>**  
16.         \#\{stu\_name\},  
17.       **</****if****>**  
18. **<****pre** name="code" class="html"**>** **</****insert****</****pre****>****<****br****>**

这里是自动判断是否为空，然后去掉逗号

**\[html\]**  [view plain][] [copy][view plain]

1.  prefix="(" suffix=")"

会自动判断是否需要加上（）这个符号

5、choose  
  
        有时候我们并不想应用所有的条件，而只是想从多个选项中选择一个。而使用if标签时，只要test中的表达式为true，就会执行if标签中的条件。MyBatis提供了choose 元素。if标签是与(and)的关系，而choose比傲天是或（or）的关系。  
        choose标签是按顺序判断其内部when标签中的test条件出否成立，如果有一个成立，则choose结束。当choose中所有when的条件都不满则时，则执行otherwise中的sql。类似于Java 的switch 语句，choose为switch，when为case，otherwise则为default。

**\[html\]**  [view plain][] [copy][view plain]

1.    
2.  **<****select** id="selectByCriteria" parameterType="com.mucfc.dto.Student" resultMap="BaseResultMap"**>**  
3.      select \* from t\_student  
4.         **<****where****>**  
5.             **<****choose****>**  
6.                 **<****when** test="stuId != null and stuId !=''"**>**  
7.                    STU\_ID = \#\{stuId\}  
8.                 **</****when****>**                                 
9.                 **<****when** test="stuClass != null and stuClass !=''"**>**  
10.                     and STU\_CLASS = \#\{stuClass\}  
11.                **</****when****>**  
12.                **<****otherwise****>**                 
13.                **</****otherwise****>**  
14.            **</****choose****>**  
15.        **</****where****>**  
16.    **</****select****>**

输入两个参数

![05133632_Efeu.jpg][]

这里会跳过王五这个参数，因为stuId不为空

![05133632_bcdo.jpg][]

然后看打印了来的语句，果然只有一个条件，所以说明是对的

![05133633_H4AT.jpg][]

foreach  
  
        对于动态SQL 非常必须的，主是要迭代一个集合，通常是用于IN 条件。List 实例将使用“list”做为键，数组实例以“array” 做为键。  
foreach元素是非常强大的，它允许你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也允许你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。  
注意：你可以传递一个List实例或者数组作为参数对象传给MyBatis。当你这么做的时候，MyBatis会自动将它包装在一个Map中，用名称在作为键。List实例将会以“list”作为键，而数组实例将会以“array”作为键。

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了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key  
  
下面分别来看看上述三种情况的示例代码：  
1.单参数List的类型：

**\[html\]**  [view plain][] [copy][view plain]

1.  **<****select** id="dynamicForeachTest" resultType="Blog"**>**  
2.  select \* from t\_blog where id in  
3.  **<****foreach** collection="list" index="index" item="item" open="(" separator="," close=")"**>**  
4.  \#\{item\}  
5.  **</****foreach****>**  
6.  **</****select****>**

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