Myibatis 动态SQL

[code="java"]动态SQL

MyBatis的一个强大的特性之一通常是它的动态SQL能力。如果你有使用JDBC或其他相似框架的经验,你就明白条件地串联SQL字符串在一起是多么的痛苦,确保不能忘了空格或在列表的最后省略逗号。动态SQL可以彻底处理这种痛苦。

通常使用动态SQL不可能是独立的一部分,MyBatis当然使用一种强大的动态SQL语言来改进这种情形,这种语言可以被用在任意映射的SQL语句中。

动态SQL元素和使用JSTL或其他相似的基于XML的文本处理器相似。在MyBatis之前的版本中,有很多的元素需要来了解。MyBatis3大大提升了它们,现在用不到原先一半的元素就能工作了。MyBatis采用功能强大的基于OGNL的表达式来消除其他元素。

if

choose(when,otherwise)

trim(where,set)

foreach

if

在动态SQL中所做的最通用的事情是包含部分where字句的条件。比如:

SELECT*FROMBLOG

WHEREstate=‘ACTIVE’

ANDtitlelike#{title}

这条语句会提供一个可选的文本查找功能。如果你没有传递title,那么所有激活的博客都会被返回。但是如果你传递了title,那么就会查找相近的title(对于敏锐的检索,这中情况下你的参数值需要包含任意的遮掩或通配符)的博客。

假若我们想可选地搜索title和author呢?首先,要改变语句的名称让它有意义。然后简单加入另外的一个条件。

SELECT*FROMBLOGWHEREstate=‘ACTIVE’

ANDtitlelike#{title}

ANDauthor_namelike#{author.name}

choose,when,otherwise

有时我们不想应用所有的条件,相反我们想选择很多情况下的一种。Java中的switch和语句相似,MyBatis提供choose元素。

我们使用上面的示例,但是现在我们来搜索当title提供时仅有title条件,当author提供时仅有author条件。如果二者都没提供,只返回featuredblogs(也许是由管理员策略地选择的结果列表,而不是返回大量没有意义的随机博客结果列表)。

SELECT*FROMBLOGWHEREstate=‘ACTIVE’

ANDtitlelike#{title}

ANDauthor_namelike#{author.name}

ANDfeatured=1

trim,where,set

前面的例子已经方便地处理了一个臭名昭著的动态SQL问题。要考虑我们回到“if”示例后会发生什么,但是这次我们将“ACTIVE=1”也设置成动态的条件。

SELECT*FROMBLOG

WHERE

state=#{state}

ANDtitlelike#{title}

ANDauthor_namelike#{author.name}

如果这些条件都没有匹配上将会发生什么?这条SQL结束时就会成这样:

SELECT*FROMBLOG

WHERE

这会导致查询失败。如果仅仅第二个条件匹配是什么样的?这条SQL结束时就会是这样:

SELECT*FROMBLOG

WHERE

ANDtitlelike‘someTitle’

这个查询也会失败。这个问题不能简单的用条件来解决,如果你从来没有这样写过,那么你以后也不会这样来写。

MyBatis有一个简单的处理,这在90%的情况下都会有用。而在不能使用的地方,你可以自定义处理方式。加上一个简单的改变,所有事情都会顺利进行:

SELECT*FROMBLOG

state=#{state}

ANDtitlelike#{title}

ANDauthor_namelike#{author.name}

where元素知道如果由被包含的标记返回任意内容,就仅仅插入“WHERE”。而且,如果以“AND”或“OR”开头的内容,那么就会跳过WHERE不插入。

如果where元素没有做出你想要的,你可以使用trim元素来自定义。比如,和where元素相等的trim元素是:

...

prefixOverrides属性采用管道文本分隔符来覆盖,这里的空白也是重要的。它的结果就是移除在prefixOverrides属性中指定的内容,插入在with属性中的内容。

和动态更新语句相似的解决方案是set。set元素可以被用于动态包含更新的列,而不包含不需更新的。比如:

updateAuthor

username=#{username},

password=#{password},

email=#{email},

bio=#{bio}

whereid=#{id}

这里,set元素会动态前置SET关键字,而且也会消除任意无关的逗号,那也许在应用条件之后来跟踪定义的值。

如果你对和这相等的trim元素好奇,它看起来就是这样的:

...

注意这种情况下我们覆盖一个后缀,而同时也附加前缀。

foreach

另外一个动态SQL通用的必要操作是迭代一个集合,通常是构建在IN条件中的。比如:

SELECT*

FROMPOSTP

WHEREIDin

#{item}

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

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

这个部分是对关于XML配置文件和XML映射文件的而讨论的。下一部分将详细讨论JavaAPI,所以你可以得到你已经创建的最有效的映射。

Multi-dbvendorsupport

IfadatabaseIdProviderwasconfigureda"_databaseId"variableisavailablefordynamiccode,soyoucanbuilddifferentstatementsdependingondatabasevendor.Havealookatthefollowingexample:

selectseq_users.nextvalfromdual

selectnextvalforseq_usersfromsysibm.sysdummy1"

insertintousersvalues(#{id},#{name})