ibatis的<![CDATA]>,dynamic属性和#,$的应用

<![CDATA[   ]]>的正确使用
ibatis作为一种半自动化的OR Mapping工具，其灵活性日益体现出来，越来越多的人都倾向于在项目中使用。由于Sql中经常有与xml规范相冲突的字符对xml映射文件的合法性造成影响。许多人都知道使用<![CDATA[   ]]>标记来避免冲突，但是在sql配置中有动态语句的时候，还是有一些细节需要特别注意的，不然是费心又费力。

在使用ibatis时，经常需要配置待执行的sql语句。使用过ibatis的朋友都知道，无可避免的都会碰到一些不兼容、冲突的字符，多数人也都知道用<![CDATA[   ]]>标记避免Sql中与xml规范相冲突的字符对xml映射文件的合法性造成影响。但是，如果在ibatis中使用了动态语句的时候，还是有一些细节需要注意。下面举例说明一下：

环境：oracle、ibatis、java


错误例1：符号“<=”会对xml映射文件的合法性造成影响

<select id="find" parameterClass="java.util.Map" resultClass="java.lang.Long"> 
select id
from tableA a,
     tableB b
<dynamic prepend="WHERE">
<isNotNull prepend="AND" property="startDate">
  a.act_time >= #startDate#
  and a.act_time <= #endDate#
  and a.id = b.id
</isNotNull>   
</dynamic> 
</select>

错误例2：将整个sql语句用<![CDATA[   ]]>标记来避免冲突，在一般情况下都是可行的，但是由于该sql配置中有动态语句（where部分），将导致系统无法识别动态判断部分，导致整个sql语句非法。

<select id="find" parameterClass="java.util.Map" resultClass="java.lang.Long">
<![CDATA[  
select id
from tableA a,
     tableB b
<dynamic prepend="WHERE">
<isNotNull prepend="AND" property="startDate">
  a.act_time >= #startDate#
  and a.act_time <= #endDate#
  and a.id = b.id
</isNotNull>   
</dynamic> 
  ]]>
</select>

正确做法：缩小范围，只对有字符冲突部分进行合法性调整。

<select id="find" parameterClass="java.util.Map" resultClass="java.lang.Long"> 
select id
from tableA a,
     tableB b
<dynamic prepend="WHERE">
<isNotNull prepend="AND" property="startDate">
  a.act_time >= #startDate#
  <![CDATA[ and a.act_time <= #endDate#  ]]>
  and a.id = b.id
</isNotNull>   
</dynamic> 
</select>

dynamic的正确使用
dynamic可以去除第一个prepend="and"中的字符（这里为and），从而可以帮助你实现一些很实用的功能。具体情况如下：

1.使用dynamic

1.1 xml

select * from Person表
        <dynamic prepend="where"> 
                <isNotNull property="name" prepend="and">
                    name=#name#
                </isNotNull>
                <isNotNull property="sex" prepend="and">
                    sex=#sex#
                </isNotNull>               
        </dynamic>

1.2 结果

       当name、sex都非null时打出如下的sql语句:

select    Person where (and) name= ? , and sex= ?

     显然name前的and被自动去除了，很方便吧。

2.不使用dynamic

2.1 xml
       如果我把dynamic 去掉就会变的很恶心，如下：

select * from Person     
                <isNotNull property="name" prepend="and">
                    name=#name#
                </isNotNull>
                <isNotNull property="sex" prepend="and">
                    sex=#sex#
                </isNotNull>   

      

2.2 结果
      当name、sex都非null时打出如下的sql语句:

select    Person where and name= ? , and sex= ?

      显然name前多个and，sql语句错误。

3.总结

      dynamic 会自动去除第一个 prepend="and中的内容(这里为and)，从而方便一些操作。


#和$的区别在Ibatis中我们使用SqlMap进行Sql查询时需要引用参数，在参数引用中遇到的符号#和$之间的区分为，#可以进行与编译，进行类型匹配，而$不进行数据类型匹配，例如：

select * from table where id = #id# ，其中如果字段id为字符型，那么#id#表示的就是'id'类型，如果id为整型，那么#id#就是id类型。

select * from table where id = $id$ ，如果字段id为整型，Sql语句就不会出错，但是如果字段id为字符型，那么Sql语句应该写成 select * from table where id = '$id$'

评论

1 楼 远去的渡口 2010-08-04  

很不错，项目中也是用ibatis,你的总结对我挺有帮助。