iBATIS SQL Maps之动态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>

上面的例子中，根据参数“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语句中。

• • 二元条件元素的属性：

propend —— 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）

property  —— 被比较的属性（必选）

compareProperty —— 另一个用于和前者比较的属性（必选或选择compareValue）

compareValue      —— 用于比较的值（必选或选择compareProperty）

 

一元条件元素

一元条件元素检查属性的状态是否符合特定的条件。

• • 一元条件元素的属性：

prepend —— 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）

property  —— 被比较的属性（必选）

其他元素

• • Parameter Present：这些元素检查参数对象是否存在。

Parameter Present的属性：

prepend —— 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）

• • Iterate：这属性遍历整个集合，并未List集合中的元素重复元素体的内容。

Iterate的属性：

prepend       —— 可被覆盖的SQL语句组成部分，添加在语句的前面（可选）

property        —— 类型为java.util.List的用于遍历的元素（必选）

open             —— 整个遍历内容体开始的字符串，用于定义括号（可选）

close             —— 整个遍历内容体结束的字符串，用于定义括号（可选）

conjunction  —— 每次遍历内容之间的字符串，用于定义AND或OR（可选）

简单的动态SQL元素

虽然动态Mapped Statement API功能强大，但有时仅需要一小部分的动态SQL即可。为此，SQL Statement和statement都可以包含简单的动态SQL元素，以帮助实现动态的order by子句，动态的查询字段或SQL语句的其他动态部分。简单动态SQL元素的概念有点像inline parameter的映射，但使用了稍微不同的语法。考虑下面的例子：

<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

<dynamic prepend = "WHERE" >

<isNotEmpty property = "description" >

PRD_DESCRIPTION $operator$ #description#

</isNotEmpty>

</dynamic>

</statement>

上面的例子中，参数对象的operator属性将用于替代符号$operator$。因此，假如operator属性等于“like”，description属性等于“%dog%”，生成的SQL语句如下：

SELECT * FROM PRODUCT WHERE PRD_DESCRIPTION LIKE '%dog%'