如何编写mybatis动态sql语句

桃扇骨 2022-06-11 02:59 334阅读 0赞

# 如何编写mybatis动态sql语句？ #

近期在做一个复杂的条件查询功能，整理了一些知识，希望可以帮助到大家。

有些时候，sql语句where条件中，需要一些安全判断，例如按某一条件查询时如果传入的参数是空，此时查询出的结果很可能是空的，也许我们需要参数为空时，是查出全部的信息。使用mysql的函数生成Id，这时我们可以使用动态sql。

下面介绍一下用mysql语法和函数:

## if标签 ##

这是我做的一个很普通的查询语句:

![Image 1][]![Center][]

但是此时如果studentName或studentSex为null，此语句很可能报错或查询结果为空。此时我们使用if动态sql语句先进行判断，如果值为null或等于空字符串，我们就不进行此条件的判断，增加灵活性。

参数为实体类StudentEntity。将实体类中所有的属性均进行判断，如果不为空则执行判断条件。

![Image 1][]

## Foreach用法 ##

对于动态SQL 非常必须的，主是要迭代一个集合，通常是用于IN 条件。List 实例将使用“list”做为键，数组实例以“array” 做为键。

foreach元素是非常强大的，它允许你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也允许你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。

注意：你可以传递一个List实例或者数组作为参数对象传给MyBatis。当你这么做的时候，MyBatis会自动将它包装在一个Map中，用名称在作为键。List实例将会以“list”作为键，而数组实例将会以“array”作为键。

![Center 1][]

### 1、参数为array的写法 ###

动态SQL语句：

![Center 2][]

###  ![Image 1][] ###

### 2、参数为list示例的写法 ###

动态SQL语句：

![Center 3][]

![Image 1][]

### 3、参数为map示例的写法 ###

我在做项目中用的就是map的参数形式，下面为map中参数的说明：

<table> 
 <tbody> 
 <tr> 
 <td> item </td> 
 <td> 循环体中的具体对象。支持属性的点路径访问，如item.age,item.info.details。 具体说明：若collection属性为list或array，则item代表list或array里面的一个元素。若collection属性对应一个map，则item代表的是map中的value集合中的单个value 该参数为必选。 </td> 
 </tr> 
 <tr> 
 <td> collection </td> 
 <td> foreach遍历的对象，作为入参时，List对象默认用list代替作为键，数组对象有array代替作为键，Map对象没有默认的键。也就是传入的集合（list，array，map）的名字，这个名字可以在foreach里面随便引用） 当然在作为入参时可以使用@Param("params")来设置键，设置keyName后，list,array将会失效。 除了入参这种情况外，还有一种作为参数对象的某个字段的时候。举个例子： 如果User有属性List ids。入参是User对象，那么这个collection = "ids" 如果User有属性Ids ids;其中Ids是个对象，Ids有个属性List id;入参是User对象，那么collection = "ids.id" 如果传入参数类型为map，这个入参有注解@Param("params")，则map的所有的key集合可以写成params.keys，所有值集合可以写成params.values。这样foreach就可以对key集合或值集合进行迭代了。 上面只是举例，具体collection等于什么，就看你想对那个元素做循环。 该参数为必选。 </td> 
 </tr> 
 <tr> 
 <td> separator </td> 
 <td> 元素之间的分隔符，例如在in()的时候，separator=","会自动在元素中间用“,“隔开，避免手动输入逗号导致sql错误，如in(1,2,)这样。该参数可选。 </td> 
 </tr> 
 <tr> 
 <td> open </td> 
 <td> foreach代码的开始符号，一般是(和close=")"合用。常用在in(),values()时。该参数可选。 </td> 
 </tr> 
 <tr> 
 <td> close </td> 
 <td> foreach代码的关闭符号，一般是)和open="("合用。常用在in(),values()时。该参数可选。 </td> 
 </tr> 
 <tr> 
 <td> index </td> 
 <td> 在list和数组中,index是元素的序号，在map中，index是元素的key，该参数可选。 </td> 
 </tr> 
 </tbody> 
</table>

示例如下：

![Image 1][]![Center 4][]

参考文档：

[http://www.cnblogs.com/zkongbai/p/5336015.html][http_www.cnblogs.com_zkongbai_p_5336015.html]

http://blog.csdn.net/u013510614/article/details/50503607

## 个人总结 ##

MyBatis 的强大特性之一便是它的动态 SQL。

如果使用 JDBC，就能体会到根据不同条件拼接 SQL 语句有多么痛苦。拼接的时候要确保不能忘了必要的空格，还要注意省掉列名列表最后的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。通常使用动态 SQL 不可能是独立的一部分,MyBatis 当然使用一种强大的动态 SQL 语言来改进这种情形,这种语言可以被用在任意的 SQL 映射语句中，我真为动态sql真的很棒！

[Image 1]: 
[Center]: /images/20220611/28726ce78f9b49f995a35b07156e85d7.png
[Center 1]: /images/20220611/dc28693504d84cf0b2cd16f5681dc374.png
[Center 2]: /images/20220611/7506bde2e64e4f508b832b47ec55006e.png
[Center 3]: /images/20220611/55988496faf148ffaf6a7cff866577a7.png
[Center 4]: /images/20220611/dcbd3647abae422f821d8342f009be69.png
[http_www.cnblogs.com_zkongbai_p_5336015.html]: http://www.cnblogs.com/zkongbai/p/5336015.html