直接使用 JDBC 一个非常普遍的问题是动态 SQL。使用参数值、参数本身和数据列都 是动态的 SQL,通常非常困难。典型的解决方法是,使用一系列 if-else 条件语句和一连串 讨厌的字符串连接。对于这个问题,SQL Map API 使用和 mapped statement 非常相似的结构, 提供了较为优雅的方法。这里是一个简单的例子:
1 <select id="dynamicGetAccountList" cacheModel="account-cache" resultMap="account-result" > 2 select * from ACCOUNT 3 <isGreaterThan prepend="and" property="id" compareValue="0"> 4 where ACC_ID = #id# 5 </isGreaterThan> 6 order by ACC_LAST_NAME 7 </select>
在更复杂的例子中,动态 Mapped Statement 的用处更明显。如下面比较复杂的例子:
1 <statement id="someName" resultMap="account-result" > 2 select * from ACCOUNT 3 <dynamic prepend="where"> 4 <isGreaterThan prepend="and" property="id" compareValue="0"> ACC_ID = #id# 5 </isGreaterThan> 6 <isNotNull prepend=”and" property="lastName"> ACC_LAST_NAME = #lastName# 7 </isNotNull> 8 </dynamic> 9 order by ACC_LAST_NAME 10 </statement>
上面的例子中,<dynamic>元素划分出 SQL 语句的动态部分。动态部分可以包含任意多 的条件标签元素,条件标签决定是否在语句中包含其中的 SQL 代码。所有的条件标签元素 将根据传给动态查询 Statement 的参数对象的情况来工作。<dynamic>元素和条件元素都有 “prepend”属性,它是动态 SQL 代码的一部分,在必要情况下,可以被父元素的“prepend” 属性覆盖。上面的例子中,prepend 属性“where”将覆盖第一个为“真”的条件元素。这对 于确保生成正确的 SQL 语句是有必要的。例如,在第一个为“真”的条件元素中,“AND” 是不需要的,事实上,加上它肯定会出错。以下小节讨论不同的条件元素,包括二元条件元 素,一元条件元素和其他动态元素。
二元条件元素
二元条件元素将一个属性值和一个静态值或另一个属性值比较,如果条件为“真”,元 素体的内容将被包括在查询 SQL 语句中。
二元条件元素的属性:
prepend - 可被覆盖的 SQL 语句组成部分,添加在语句的前面(可选)
property - 被比较的属性(必选)
compareProperty - 另一个用于和前者比较的属性(必选或选择 compareValue)
compareValue - 用于比较的值(必选或选择 compareProperty)
<isEqual> |
比较属性值和静态值或另一个属性值是否相等。 |
<isNotEqual> |
比较属性值和静态值或另一个属性值是否不相等。 |
<isGreaterThan> |
比较属性值是否大于静态值或另一个属性值。 |
<isGreaterEqual> |
比较属性值是否大于等于静态值或另一个属性值。 |
<isLessThan> |
比较属性值是否小于静态值或另一个属性值。 |
<isLessEqual> |
比较属性值是否小于等于静态值或另一个属性值。 例子: <isLessEqual prepend=”AND” property=”age” compareValue=”18”> ADOLESCENT = ‘TRUE’ </isLessEqual> |
一元条件元素
一元条件元素检查属性的状态是否符合特定的条件。
* 一元条件元素的属性:
prepend - 可被覆盖的 SQL 语句组成部分,添加在语句的前面(可选)
property - 被比较的属性(必选)
<isPropertyAvailable> |
检查是否存在该属性(存在 parameter bean 的属性)。 |
<isNotPropertyAvailable> |
检查是否不存在该属性(不存在 parameter bean 的属性)。 |
<isNull> |
检查属性是否为 null。 |
<isNotNull> |
检查属性是否不为 null。 |
<isEmpty> |
检查 Collection.size()的值,属性的 String 或 String.valueOf()值, 是否为 null 或空(“”或 size() < 1)。 |
<isNotEmpty> |
检查 Collection.size()的值,属性的 String 或 String.valueOf()值, 是否不为 null 或不为空(“”或 size() > 0)。 例子: <isNotEmpty prepend=”AND” property=”firstName” > FIRST_NAME=#firstName# </isNotEmpty> |
其他元素
* Parameter Present:这些元素检查参数对象是否存在。
Parameter Present 的属性:
prepend - 可被覆盖的 SQL 语句组成部分,添加在语句的前面(可选)
<isParameterPresent> |
检查是否存在参数对象(不为 null)。 |
<isNotParameterPresent> |
检查是否不存在参数对象(参数对象为 null)。 例子: <isNotParameterPresent prepend=”AND”> EMPLOYEE_TYPE = ‘DEFAULT’ </isNotParameterPresent> |
* Iterate:这属性遍历整个集合,并为 List 集合中的元素重复元素体的内容。
Iterate 的属性:
prepend - 可被覆盖的 SQL 语句组成部分,添加在语句的前面(可选)
property - 类型为 java.util.List 的用于遍历的元素(必选)
open - 整个遍历内容体开始的字符串,用于定义括号(可选)
close -整个遍历内容体结束的字符串,用于定义括号(可选)
conjunction - 每次遍历内容之间的字符串,用于定义 AND 或 OR(可选)
<iterate> |
遍历类型为 java.util.List 的元素。 例子: <iterate prepend=”AND” property=”userNameList” open=”(” close=”)” conjunction=”OR”> username=#userNameList[]# </iterate> 注意:使用<iterate>时,在List元素名后面包括方括号[]非常重要,方括号[]将 对象标记为List,以防解析器简单地将List输出成String。 |
简单的动态SQL元素
虽然动态 Mapped Statement API 功能强大,但有时仅需要一小部分的动态 SQL 即可。 为此,SQL statement 和 statement 都可以包含简单的动态 SQL 元素,以帮助实现动态的 order by 子句,动态的查询字段或 SQL 语句的其他动态部分。简单动态 SQL 元素的概念有点象 inline parameter 的映射,但使用了稍微不同的语法。考虑下面的例子:
1 <statement id=”getProduct” resultMap=”get-product-result”> 2 select * from PRODUCT order by $preferredOrder$ 3 </statement>
preferredOrder 动态元素将被参数对象的 preferredOrder 属性值替换(象 parameter map 一样)。不同的是,它从根本上改变了 SQL 语句本身,比仅仅简单地改变参 数值严重得多。在这样的动态 SQL 语句中,错误可能会引起安全,性能和稳定性的风险。 因此,应细心检查,以确保简单动态 SQL 元素使用的正确。另外,还要留意您的设计,以 防数据库细节对业务逻辑对象模型造成不好的影响。
单动态元素可以包含在<dynamic-mapped-statement>中,当要修改 SQL 语句本身时它能派上用场。例如:
1 <statement id=”getProduct” resultMap=”get-product-result”> SELECT * FROM PRODUCT 2 <dynamic prepend=”WHERE”> 3 <isNotEmpty property=”description”> PRD_DESCRIPTION $operator$ #description# 4 </isNotEmpty> 5 </dynamic> 6 </statement>
上面的例子中,参数对象的 operator 属性将用于替代符号$operator$。因此,假如 operator属性等于“like”,description 属性等于“%dog%”,生成的 SQL 语句如下:
SELECT * FROM PRODUCT WHERE PRD_DESCRIPTION LIKE ‘%dog%’;