ibatis动态mapped Statement 配置详解

落日映苍穹つ 2022-09-19 12:13 136阅读 0赞

**动态 Mapped Statement**  
直接使用 JDBC 一个非常普遍的问题是动态 SQL。使用参数值、参数本身和数据列都  
是动态的 SQL，通常非常困难。典型的解决方法是，使用一系列 if-else 条件语句和一连串  
讨厌的字符串连接。对于这个问题，SQL Map API使用和 mapped statement非常相似的结构，  
提供了较为优雅的方法。这里是一个简单的例子：  
<select id="dynamicGetAccountList"  
cacheModel="account-cache"  
resultMap="account-result" >  
select \* from ACCOUNT  
<isGreaterThan prepend="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  
在更复杂的例子中，动态 Mapped Statement 的用处更明显。如下面比较复杂的例子：  
<statement id="dynamicGetAccountList" resultMap="account-result" >

select \* from ACCOUNT  
<dynamic prepend="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\_EMAIL like \#emailAddress\#  
</isNotNull>  
<isGreaterThan prepend="AND" property="id" compareValue="0">  
ACC\_ID = \#id\#  
</isGreaterThan>  
</dynamic>  
order by ACC\_LAST\_NAME

</statement>  
根据不同的条件，上面动态的语句可以产生 16 条不同的查询语句。使用 if-else 结构和  
字符串，会产生上百行很乱的代码。  
而使用动态 Statement，和在 SQL 的动态部位周围插入条件标签一样容易。例如：  
<statement id="someName" resultMap="account-result" >  
select \* from ACCOUNT  
<dynamic prepend="where">  
<isGreaterThan prepend="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 语句中。 二元条件元素的属性：  
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 － 被比较的属性（必选）

检查是否存在该属性（存在 parameter bean 的属性）。  
<isPropertyAvailable>  
检查是否不存在该属性（不存在 parameter bean 的属性）。  
<isNotPropertyAvailable>  
检查属性是否为 null。  
<isNull>  
检查属性是否不为 null。  
<isNotNull>  
检查 Collection.size()的值，属性的 String 或 String.valueOf()值,  
<isEmpty>  
是否为 null或空（“”或size() < 1）。  
检查 Collection.size()的值，属性的 String 或 String.valueOf()值,  
<isNotEmpty>  
是否不为 null 或不为空（“”或 size() > 0）。  
例子：  
<isNotEmpty prepend=”AND” property=”firstName” >  
FIRST\_NAME=\#firstName\#  
</isNotEmpty>  
  
  
其他元素 Parameter Present：这些元素检查参数对象是否存在。  
Parameter Present的属性：  
prepend － 可被覆盖的 SQL 语句组成部分，添加在语句的前面（可选）  
检查是否存在参数对象（不为 null）。  
<isParameterPresent>  
检查是否不存在参数对象（参数对象为 null）。  
<isNotParameterPresent>  
例子：  
<isNotParameterPresent prepend=”AND”>  
EMPLOYEE\_TYPE = ‘DEFAULT’  
</isNotParameterPresent>  
Iterate：这属性遍历整个集合，并为 List 集合中的元素重复元素体的内容。  
Iterate 的属性：  
prepend － 可被覆盖的 SQL 语句组成部分，添加在语句的前面（可选）  
property － 类型为 java.util.List 的用于遍历的元素（必选）  
open － 整个遍历内容体开始的字符串，用于定义括号（可选）  
close －整个遍历内容体结束的字符串，用于定义括号（可选）  
conjunction － 每次遍历内容之间的字符串，用于定义 AND 或 OR（可选）  
遍历类型为 java.util.List的元素。  
<iterate>  
例子：  
<iterate prepend=”AND” property=”userNameList”  
open=”(” close=”)” conjunction=”OR”>  
username=\#userNameList\[\]\#  
</iterate>  
  
  
注意：使用<iterate>时，在List元素名后面包括方括号\[\]非常重要，方括号\[\]将  
对象标记为List，以防解析器简单地将List输出成String。