ibatis的动态Mapped Statement 标签

动态Mapped Statement
直接使用JDBC 一个非常普遍的问题是动态SQL。使用参数值、参数本身和数据列都
是动态的SQL，通常非常困难。典型的解决方法是，使用一系列if-else 条件语句和一连串
讨厌的字符串连接。对于这个问题，SQL Map API使用和mapped statement非常相似的结构，
提供了较为优雅的方法。这里是一个简单的例子：
<selectid="dynamicGetAccountList"
cacheModel="account-cache"
resultMap="account-result" >
select * from ACCOUNT
<isGreaterThanprepend="and"property="id" compareValue="0">
where ACC_ID =#id#
</isGreaterThan>
order by ACC_LAST_NAME
</select>
上面的例子中，根据参数bean“id”属性的不同情况，可创建两个可能的语句。如果参
数“id”大于0，将创建下面的语句：
select * from ACCOUNT where ACC_ID = ?
或者，如果“id”参数小于等于0，将创建下面的语句：
select *from ACCOUNT
在更复杂的例子中，动态MappedStatement的用处更明显。如下面比较复杂的例子：
<statement id="dynamicGetAccountList" resultMap="account-result" >
select * from ACCOUNT
<dynamicprepend="WHERE">
<isNotNull prepend="AND" property="firstName">
(ACC_FIRST_NAME =#firstName#
<isNotNull prepend="OR" property="lastName">
ACC_LAST_NAME =#lastName#
</isNotNull>
)
</isNotNull>
<isNotNull prepend="AND" property="emailAddress">
ACC_EMAILlike #emailAddress#
</isNotNull>
<isGreaterThanprepend="AND" property="id"compareValue="0">
ACC_ID= #id#
</isGreaterThan>
</dynamic>
order by ACC_LAST_NAME
http://www.ibatis.com Clinton Begin 著 刘涛(toleu@21cn.com) 译
开发指南 iBATIS SQL Maps Page 42 of 62
</statement>
根据不同的条件，上面动态的语句可以产生16条不同的查询语句。使用if-else结构和
字符串，会产生上百行很乱的代码。
而使用动态Statement，和在SQL的动态部位周围插入条件标签一样容易。例如：
<statement id="someName" resultMap="account-result" >
select * from ACCOUNT
<dynamicprepend="where">
<isGreaterThanprepend="and"property="id" compareValue="0">
ACC_ID= #id#
</isGreaterThan>
<isNotNull prepend=”and" property="lastName">
ACC_LAST_NAME =#lastName#
</isNotNull>
</dynamic>
order by ACC_LAST_NAME
</statement>
上面的例子中，<dynamic>元素划分出SQL语句的动态部分。动态部分可以包含任意多
的条件标签元素，条件标签决定是否在语句中包含其中的SQL代码。所有的条件标签元素
将根据传给动态查询Statement 的参数对象的情况来工作。<dynamic>元素和条件元素都有
“prepend”属性，它是动态SQL代码的一部分，在必要情况下，可以被父元素的“prepend”
属性覆盖。上面的例子中，prepend属性“where”将覆盖第一个为“真”的条件元素。这对
于确保生成正确的SQL语句是有必要的。例如，在第一个为“真”的条件元素中，“AND”
是不需要的，事实上，加上它肯定会出错。以下小节讨论不同的条件元素，包括二元条件元
素，一元条件元素和其他动态元素。
二元条件元素
二元条件元素将一个属性值和一个静态值或另一个属性值比较，如果条件为“真”，元
素体的内容将被包括在查询SQL语句中。
z 二元条件元素的属性：
prepend － 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）
property － 被比较的属性（必选）
compareProperty － 另一个用于和前者比较的属性（必选或选择compareValue）
compareValue － 用于比较的值（必选或选择compareProperty）
<isEqual> 比较属性值和静态值或另一个属性值是否相等。
<isNotEqual> 比较属性值和静态值或另一个属性值是否不相等。
http://www.ibatis.com Clinton Begin 著 刘涛(toleu@21cn.com) 译
开发指南 iBATIS SQL Maps Page 43 of 62
<isGreaterThan> 比较属性值是否大于静态值或另一个属性值。
<isGreaterEqual> 比较属性值是否大于等于静态值或另一个属性值。
<isLessThan> 比较属性值是否小于静态值或另一个属性值。
<isLessEqual> 比较属性值是否小于等于静态值或另一个属性值。
例子：
<isLessEqual prepend=”AND” property=”age” compareValue=”18”>
ADOLESCENT = ‘TRUE’
</isLessEqual>
一元条件元素
一元条件元素检查属性的状态是否符合特定的条件。
z 一元条件元素的属性：
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）。
例子：
<isNotEmptyprepend=”AND” property=”firstName” >
FIRST_NAME=#firstName#
</isNotEmpty>
其他元素
z ParameterPresent：这些元素检查参数对象是否存在。
ParameterPresent的属性：
prepend － 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）
<isParameterPresent> 检查是否存在参数对象（不为null）。
<isNotParameterPresent> 检查是否不存在参数对象（参数对象为null）。
例子：
<isNotParameterPresent prepend=”AND”>
EMPLOYEE_TYPE = ‘DEFAULT’
</isNotParameterPresent>

z Iterate：这属性遍历整个集合，并为List集合中的元素重复元素体的内容。
Iterate的属性：
prepend － 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）
property － 类型为java.util.List的用于遍历的元素（必选）
open － 整个遍历内容体开始的字符串，用于定义括号（可选）
close －整个遍历内容体结束的字符串，用于定义括号（可选）
conjunction － 每次遍历内容之间的字符串，用于定义AND或OR（可选）
<iterate> 遍历类型为java.util.List的元素。
例子：
<iterateprepend=”AND” property=”userNameList”
open=”(”close=”)” conjunction=”OR”>
username=#userNameList[]#
</iterate>
注意：使用<iterate>时，在List元素名后面包括方括号[]非常重要，方括号[]将
对象标记为List，以防解析器简单地将List输出成String。
简单的动态SQL元素
虽然动态Mapped Statement API功能强大，但有时仅需要一小部分的动态SQL即可。
为此，SQLstatement和statement都可以包含简单的动态SQL元素，以帮助实现动态的order
by子句，动态的查询字段或SQL语句的其他动态部分。简单动态SQL元素的概念有点象
inlineparameter的映射，但使用了稍微不同的语法。考虑下面的例子：
<statement id=”getProduct”resultMap=”get-product-result”>
select * from PRODUCT order by $preferredOrder$
</statement>
上面的例子中，preferredOrder动态元素将被参数对象的preferredOrder属性值替换（象
parameter map一样）。不同的是，它从根本上改变了SQL语句本身，比仅仅简单地改变参
数值严重得多。在这样的动态SQL语句中，错误可能会引起安全，性能和稳定性的风险。
因此，应细心检查，以确保简单动态SQL元素使用的正确。另外，还要留意您的设计，以
防数据库细节对业务逻辑对象模型造成不好的影响。例如，您不应因为要使用order by子句，
而将一个数据字段名作为业务对象的属性，或作为JSP页面的一个域的值。
简单动态元素可以包含在<dynamic-mapped-statement>中，当要修改SQL语句本身时它
能派上用场。例如：
<statement id=”getProduct”resultMap=”get-product-result”>
SELECT * FROM PRODUCT
<dynamicprepend=”WHERE”>
<isNotEmptyproperty=”description”>
PRD_DESCRIPTION $operator$ #description#
</isNotEmpty>
</dynamic>
</statement>
上面的例子中，参数对象的operator属性将用于替代符号$operator$。因此，假如operator
属性等于“like”，description属性等于“%dog%”，生成的SQL语句如下：
SELECT * FROM PRODUCT WHERE PRD_DESCRIPTION LIKE ‘%dog%