（转）ibatis初学指南

IBatis学习总结
一、 介绍：
相对于Hibernate和Apache OJB等“一站式”ORM解决方案而言，IBatis是一种“半自动化”的ORM实现。
这个框架将让你能够更好的在JAVA应用中设计和实现实体层。这个框架有两个主要的组成部分，一个是SQL Maps，另一个是Data Access Objects。另外还包括一些可能很有用的工具。
SQL Maps：
Sql Maps是这个框架中最激动人心的部分，它是整个iBATIS Database Layer的核心价值所在。通过使用Sql Maps你可以显著的节约数据库操作的代码量。SQL Maps使用一个简单的XML文件来实现从javaBean到SQL statements的映射。跟其他的框架或者对象映射工具相比，SQL Maps最大的优势是简单。它需要学习的东西很少，在连接表或复杂查询时也不需要复杂的scheme(怎么翻complex scheme?)，使用SQL Maps， 你可以自由的使用SQL语句。
Data Access Objects (DAO)
当我们开发灵活的JAVA应用时，有一个好主意就是通过一个通用API层把实体操作的细节封装起来。Data Access Objects允许你通过一个简单接口的来操作数据，从而隐藏了实现的细节。使用DAO，你可以动态配置你的应用程序来访问不同的实体存储机制。如果你有一个复杂的应用需要用到几个不同的数据库，DAO可以让你建立一个一致的API，让系统的其他部分来调用。
Utilities
iBATIS Database Layer包含一系列的有用的工具，比如SimpleDataSource，JDBC DataSource 2.0(也包括3.0)的一个轻量级实现。ScriptRunner也提供了从单元测试到自动发布的数据库准备工作。
工作流程：
SQL Maps提供一个简单的框架，通过XML描述来映射JAVABeans，MAP implementations甚至原始类型的包装(String,Integer等)到JDBC PreparedStatement。想法很简单，基本的步骤如下：
1) 提供一个对象作为参数(either a JavaBean, Map or primitive wrapper)，The parameter object will be used setting input values in an update statement, or query values in a where clause (etc.).(感觉不译为好，你说呢？)
2) 执行这个映射的statement，这一步是魔术发生的地方。SQL Maps框架将建立一个PreparedStatement实例(instance)，使用前面提供的对象的参数，执行statement，然后从ResultSet中建立一个返回对象。
3) 如果是Update，则返回有多少行修改了，如果是查询，则返回一个对象或者对象的集合。跟参数一样，返回对象也可以是一个JAVABEAN，MAP或者一个primitive type wrapper。
流程图如下：

二、 现在介绍使用IBatis的配置文件:
SQL Map的配置文件。这个文件是SQL Map实现的根配置，这不是本总结所要具体描述的。
配置文件是XML文件，我们用它来配置属性，JDBC DataSources 和 SQL Maps。它给我们一个便利的地方可以集中配置不同的DataSource。这个框架支持iBATIS SimpleDataSource, Jakarta DBCP (Commons)，以及其他任何可以通过JNDI context来访问的DataSource。我们在以后将详细讨论这个问题。现在我们用Jakarta DBCP，结构很简单，上面这个例子，它的配置文件如下。

<properties>元素：
这SQL Map中的<properties>元素支持SQL Map XML配置文件。配置文件里的元素符合Data Map规则。如下图：

<properties>所应用的文件里的元素必须和<datasource>里的元素相对应。下面是SqlMapConfigExample.properties文件的内容。里面的元素和<datasource>里的元素相对应。

<settings>元素
maxRequests:在同一时间内能执行SQL语句的次数
maxSession:在同一时间内能起作用的Session数
maxTransaction:在同一时间内能执行的事务。
statementCacheSize:缓冲区的大小
三、 现在介绍操作IBatis的方法：
注意：本总结适合有使用开发IBatis基础的人员参考。由于本人的能力有限，不足之处请大家指出。
1. statement支持元素及支持的属性：
1.1 ID
ID属性是必须的，它表示这个语句的名称，它在整个<SqlMap>元素内唯一的。在代码通过ID来引用相关语句。
1.2 parameterMap
parameterMap属性定义了一个有序的值列表，分别有序的对应了标准参数化的SQL语句中的?占位符。
1.3 parameterClass
在没有指明parameterMap属性的情况下，你可以指定parameterClass属性方法来替代parameterMap属性。parameterClass属性的值可以使用类型的别名或者类型(类)全称
1.4 resultMap
resultMap可以让你控制你如何让数据从查询结果(ResultMap)中提取出来存入java对象中。并且可以定义如何将字段映射到java bean的属性里。如下图：

1.5 resultClass
在resultMap属性没有指定的情况下，可以采用resultClass方式，resultClass的属性值可采用类型别名或者类型(Class)全称的方式。指定的类将根据数据库的元数据自动的映射到查询结果的字段值中。
2. ParameterMap元素属性
2.1 ID
ID属性是必须的，它提供了<parameterMap>对元素Data Map里的唯一表示符
2.2 Class
Class属性是可选的，Class属性必须是JavaBean或Map实列，Class属
性虽是可选的，但推荐大家指定，Class属性 可以用来验证传入的参数的合法性及优化查询
3. 查询语句
3.1 屏蔽特殊符 <![CDATA[ ]]>

3.2 语句导入 <include>，可以是语句优化

使用<include>方法，上面的语句可以写成：

4．自增长方法：<selectKey resultClass=”int”>，不管<selectKey resultClass=”int”>处于该语句的什么部位，都先执行此自增长方法。注意：Mysql和Oracle的方法不一样。

5. <insert>方法：

Insert方法使用parameterMap属性，字段名要和<parameterMap>方法里的元素一一对应
6. <resultClass>属性：

使用resultClass方法，类Person里必须id,firstName,lastName,birthDate,werghtKilograms,heightMeters这些属性。
7. 使用xmlResultName:XML映射文件

XML文件内容：

8. 使用<parameterMap>方法：用来设置元素的属性，其中nullValue表示缺省值

上面的方法也可以写成这样：

9. 如果传入的参数只有一个，用#value#来替代传入的参数名。如果还传来的是字段名，则IBatis不支持

10. 判断传入的参数是否存在:isNotNull,判断传入的参数值是否大于设定的值：isGreaterThan

11. 判断传入的参数是否为空：isEmpty和isNotEmply

12. 如果进行模糊查询，使用like方法
Ibatis 进阶
在项目中使用ibatis有一段时间了，之前一直用jdbc、hibernate。自我感觉ibatis是介于jdbc和hibernate之间的非常实用的轻量级框架，相信用过的人都有同感吧。对搞java的来说，上手是非常快的，只要你具备sql基础，再加一点ORM的思想，夏昕的《ibatis开发指南》是不错的选择。
今天项目搞完了,我就把所学的，以及在项目中用到拿来贴一番，也是对我个人技术的总结吧，怎样快速开发，准备工作我就不说了。。。
1.ibatis 实例配置(sqlMapConfig.xml)

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMapConfig PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"
    "http://java.plugbase.org/dtd/sql-map-config-2.dtd">

<sqlMapConfig>

  <!-- Configure a built-in transaction manager.  If you're using an 
       app server, you probably want to use its transaction manager 
       and a managed datasource -->

 //缓存配置
 <settings     
      enhancementEnabled ="true"      
      lazyLoadingEnabled ="true"      
      errorTracingEnabled ="true"
      maxSessions ="200"                  
      useStatementNamespaces ="false"    
  /> 

  //数据库连接-事务管理
  <transactionManager type="JDBC" commitRequired="false">
    <dataSource type="SIMPLE">
      <property name="JDBC.Driver" value="com.mysql.jdbc.Driver"/>
      <property name="JDBC.ConnectionURL" value="jdbc:mysql://localhost:3306/imdbtest?characterEncoding=UTF-8"/>
      <property name="JDBC.Username" value="sa"/>
      <property name="JDBC.Password" value="sa"/>

      <property name="Pool.MaximumActiveConnections" value="100"/>
        <property name="Pool.MaximumIdleConnections" value="20"/>
        <property name="Pool.MaximumCheckoutTime" value="20000"/>
        <property name="Pool.TimeToWait" value="10000"/>
        <property name="Pool.PingQuery" value="select * from dual"/>
        <property name="Pool.PingEnabled" value="false"/>
        <property name="Pool.PingConnectionsOlderThan" value="1"/>
        <property name="Pool.PingConnectionsNotUsedFor" value="1"/>
    </dataSource>
  </transactionManager>

  <!-- List the SQL Map XML files. They can be loaded from the 
       classpath, as they are here (com.domain.data) -->    

  //引入sql映射文件
  <sqlMap resource="org/plugbase/company/resources/sql.xml" />

</sqlMapConfig>

2.ORM的映射文件(sqlMap.xml)，ibatis高明的地方就在此，sql语句让你自己写，这样多开放，多自由。。。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMap
    PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
    "http://java.plugbase.org/dtd/sql-map-2.dtd">

<sqlMap namespace="users">

    <!-- 别名  -->
    <typeAlias alias="User" type="org.plugbase.entity.Users"/>

    <!-- 对象与关系映射-结果集 -->
    <resultMap class="User" id="userResult">
        <result property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="password" column="password"/>
        <result property="gender" column="gender"/>
        <result property="birth" column="birth"/>
    </resultMap>

    <!-- 按主键查询用户 -->
    <select id="getUserById" parameterClass="java.lang.Integer" resultMap="userResult">
        <![CDATA[
            select * from users
            where id = #id#
        ]]>
    </select>

    <!-- 添加用户 -->
    <insert id="insertUser" parameterClass="User">
        <![CDATA[
            insert into users(username,password,gender,birth)
            values(#username#,#password#,#gender#,#birth#)
        ]]>
    </insert>

    <!-- 删除用户 -->
    <delete id="deleteUser" parameterClass="java.lang.Integer">
        <![CDATA[
            delete from users
        where id = #id#
        ]]>
    </delete>

    <!-- 更新用户 -->
    <update id="updateUser" parameterClass="User">
        <![CDATA[
            update users 
            set username = #username#,gender = #gender#,birth = #birth#
            where id = #id#
        ]]>
    </update>
</sqlMap>

说一下几个属性：
传入参数：一般都是用parameterClass，它可以传递Javabean对象或单纯的数据(如：int、String型)，自己封装的集合如Map，很方便，至于parameterMap配起来比较麻烦，有的人甚至连resultMap都不愿意配。
返回参数：则比较灵活了，resultClass和resultMap随你选，你要懒，就用resultClass吧，直接将JavaBean引进来，resultMap都不需要了。。。如resultClass = "org.plugbase.entity.Users"；

3.在项目中一般与其它框架相配合，那么ibatis作为持久化层只需要如下封装提供SqlMapClient接口便行：

String resource ="com/ibatis/sample/SqlMapConfig.xml";
Reader reader;
reader = Resources.getResourceAsReader(resource);
XmlSqlMapClientBuilder xmlBuilder =
new XmlSqlMapClientBuilder();
SqlMapClient sqlMap = xmlBuilder.buildSqlMap(reader);

4.sqlMap关键技术：
a.分页：基于mysql的分页固然很方便，只需将索引与页面大小用Map传递过来即可：
<!-- 查询所有用户总记录数 -->

 <select id="getUsersAllCount" resultClass="java.lang.Integer">
        <![CDATA[
            select count(*) from users
        ]]>
    </select>

    <!-- 分页查询所有用户 -->
    <select id="getUsersByCurrentIndexAndPageSize" parameterClass="map" resultMap="userResult">
        <![CDATA[
            select * from users
            order by id desc
            limit #index#,#pageSize#
        ]]>
    </select>

只可惜有点不足，那就是每次必须得查两次。。。

b.动态映射:一般就是根据判定条件动态查询，分一元判定和二元判定：
一元判定有：
节点名 描述
<isPropertyAvailable> 参数类中是否提供了此属性
<isNotPropertyAvailable> 与<isPropertyAvailable>相反
<isNull> 属性值是否为NULL
<isNotNull> 与<isNull>相反
<isEmpty> 如果属性为Collection或者String，其size是否<1，
如果非以上两种类型，则通过String.valueOf(属性值)
获得其String类型的值后，判断其size是否<1
<isNotEmpty> 与<isEmpty>相反。
用得比较多的就是<isNotNull>、<isNotEmpty>相关的。。。

<select id="getUsers" parameterClass="user" resultMap="get-user-result">
select * from t_user
<dynamic prepend="WHERE">
<isNotEmpty prepend="AND" property="name">
(name like #name#)
</isNotEmpty>
<isNotEmpty prepend="AND" property="address">
(address like #address#)
</isNotEmpty>
</dynamic>
</select>

二元判定有：
节点名 属性值与compareValues的关系
<isEqual> 相等。
<isNotEqual> 不等。
<isGreaterThan> 大于
<isGreaterEqual> 大于等于
<isLessThan> 小于
<isLessEqual> 小于等于

<isGreaterThan prepend="AND" property="age"
compareValue="18">
(age=#age#)
</isGreaterThan>

其中，property="age"指定了属性名”age”，compareValue=”18”指明
了判定值为”18”。
上面判定节点isGreaterThan 对应的语义是：如果age 属性大于
18(compareValue)，则在SQL中加入(age=#age#)条件。

c.批量删除，这一点ibatis做得比较好，只需要传入一组id数组就ok,比以往的for循环好多了。。。

<delete id="deleteNews" parameterClass="map">
        delete from news
        <iterate prepend="where" property="newsids" open="(" close=")" conjunction="OR">
                newsid =#newsids[]#
        </iterate>
    </delete>

属性conjunction是起到中间连接符的作用，有or,and等
sql语句如delete from news where (newsid = 1 or newsid = 2)

d.批量修改，类似删除：

<update id="updateTypeByC_ids" parameterClass="map" >
        <![CDATA[
        update client
            set mod_uid=#mod_uid#,mod_time=#mod_time#,type=#type#
            where cid=#cid#
        ]]>
        <isNotNull property="c_ids">
            <iterate prepend="AND" property="c_ids" open="(" close=")" conjunction="OR">
                c_id =#c_ids[]#
            </iterate>
        </isNotNull>
    </update>

e.动态模糊查询关于like的写法,有三种方式：
一种使用concat()函数：
<!-- 全查询记录数 -->

    <select id="countNews" resultClass="int">
        select count(*) from news 
        <isNotNull prepend="where" property="key">
            $key$ like concat('%',#value#,'%')
        </isNotNull>
        <isNotNull prepend="where" property="type">
            $type$ = #value#
        </isNotNull>
    </select>

还有下面两种拼接：

<select id="getPersonsByName" resultClass="com.unmi.Person">
    select id as id,name as name,passwd as passwd from person
        <dynamic prepend="WHERE">
            <isNotNull prepend="AND" property="name">
                (name like '%$name$%')
                <!-- (name like '%'||#name#||'%') -->
            </isNotNull>
    </dynamic>
</select>