学步园

介绍
iBATIS是以SQL为中心的持久化层框架。能支持懒加载、关联查询、继承等特性。

iBATIS不同于一般的OR映射框架。OR映射框架，将数据库表、字段等映射到类、属性，那是一种元数据(meta-data)映射。iBATIS则是将SQL查询的参数和结果集映射到类。

 

所以，iBATIS做的是SQL Mapping的工作。

 

它把SQL语句看成输入以及输出，结果集就是输出，而where后面的条件参数则是输入。iBATIS能将输入的普通POJO对象、Map、XML等映射到SQL的条件参数上，同时也可以将查询结果映射到普通POJO对象（集合）、Map、XML等上面。

 

iBATIS使用xml文件来映射这些输入以及输出。

 

简单示例
基于ibatis-2.3.0.677版本。

1、  创建新的项目，并引入jar包

a)         ibatis-2.3.0.677.jar

b)        mysql驱动

2、  在类路径中提供ibatis的配置文件：sqlMapConfig.xml

<?xml version="1.0" encoding="UTF-8" ?></p> <p><!DOCTYPE sqlMapConfig<br /> PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN" </p> <p> "http://ibatis.apache.org/dtd/sql-map-config-2.dtd"></p> <p><sqlMapConfig><br /> <transactionManager type="JDBC"><br /> <dataSource type="SIMPLE"><br /> <property name="JDBC.Driver" value="com.mysql.jdbc.Driver"/><br /> <property name="JDBC.ConnectionURL" value="jdbc:mysql://127.0.0.1/ibatis"/><br /> <property name="JDBC.Username" value="root"/><br /> <property name="JDBC.Password" value="root"/><br /> </dataSource><br /> </transactionManager><br /> <sqlMap resource="com/bjsxt/ibatis/User.xml"/><br /> </sqlMapConfig>  
 

 

3、创建实体类：User.java

package com.bjsxt.ibatis;</p> <p>public class User {<br /> private int id;<br /> private String username;<br /> private String password; </p> <p> public int getId() {<br /> return id;<br /> }</p> <p> public void setId(int id) {<br /> this.id = id;<br /> }</p> <p> public String getUsername() {<br /> return username;<br /> }</p> <p> public void setUsername(String username) {<br /> this.username = username;<br /> }</p> <p> public String getPassword() {<br /> return password;<br /> }</p> <p> public void setPassword(String password) {<br /> this.password = password;<br /> }<br /> }

 
 

 

4、创建针对User对象的CRUD的xml映射配置:User.xml

<?xml version="1.0" encoding="UTF-8" ?></p> <p><!DOCTYPE sqlMap<br /> PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"<br /> "http://ibatis.apache.org/dtd/sql-map-2.dtd"></p> <p><sqlMap><br /> <!-- Use type aliases to avoid typing the full classname every time. --><br /> <typeAlias alias="User" type="com.bjsxt.ibatis.User"/></p> <p> <!-- Select with no parameters using the result map for Account class. --><br /> <select id="selectAllUsers" resultClass="User"><br /> select * from t_user<br /> </select> </p> <p> <select id="selectUser" resultClass="User" parameterClass="int"><br /> select * from t_user where id=#id#<br /> </select> </p> <p> <insert id="insertUser" parameterClass="User"><br /> insert into t_user values (<br /> null,#username#,#password#<br /> )<br /> </insert> </p> <p> <update id="updateUser" parameterClass="User"><br /> update t_user set username = #username#,password=#password#<br /> where id=#id#<br /> </update></p> <p> <delete id="deleteUser" parameterClass="int"><br /> delete from t_user where id=#id#<br /> </delete><br /> </sqlMap>

 
 

 

5、创建测试程序测试：

package com.bjsxt.ibatis;<br /> import java.io.Reader;<br /> import java.util.Iterator;<br /> import java.util.List;<br /> import junit.framework.TestCase;<br /> import com.ibatis.common.resources.Resources;<br /> import com.ibatis.sqlmap.client.SqlMapClient;<br /> import com.ibatis.sqlmap.client.SqlMapClientBuilder;</p> <p>public class UserTest extends TestCase { </p> <p> public void testUser() throws Exception{ </p> <p> //从配置文件中得到SqlMapClient对象 </p> <p> Reader reader = Resources.getResourceAsReader("sqlMapConfig.xml");<br /> SqlMapClient sqlMapper = SqlMapClientBuilder.buildSqlMapClient(reader);<br /> reader.close(); </p> <p> //创建用户数据<br /> for(int i=0; i<10; i++){<br /> User user = new User();<br /> user.setUsername("用户"+i);<br /> user.setPassword("密码"+i);<br /> sqlMapper.insert("insertUser", user);<br /> } </p> <p> //查询用户数据<br /> List users = sqlMapper.queryForList("selectAllUsers");<br /> for (Iterator iter = users.iterator(); iter.hasNext();) {<br /> User user = (User) iter.next();<br /> System.out.println(user.getUsername());<br /> } </p> <p> //查询特定用户的数据<br /> User user = (User)sqlMapper.queryForObject("selectUser", 1);<br /> System.out.println("用户【id="+1+"】的名称是："+user.getUsername()); </p> <p> //更新用户的信息<br /> user = new User();<br /> user.setId(3);<br /> user.setUsername("更改之后的用户名称");<br /> user.setPassword("密码被更改");<br /> sqlMapper.update("updateUser", user); </p> <p> //删除用户的信息<br /> sqlMapper.delete("deleteUser", 6);<br /> }<br /> }</p> <p>

 

 
 

 

SqlMapClient对象
这个对象是iBatis操作数据库的接口（执行CRUD等操作），它也可以执行事务管理等操作。这个类是我们使用iBATIS的最主要的类。它是线程安全的。通常，将它定义为单例。（与hibernate中sessionFactory的定义类似）。如：

import java.io.Reader;<br /> import com.ibatis.common.resources.Resources;<br /> import com.ibatis.sqlmap.client.SqlMapClient;<br /> import com.ibatis.sqlmap.client.SqlMapClientBuilder; </p> <p>public class IbatisSQLMapConfig {<br /> private static final SqlMapClient sqlMap; </p> <p> //在静态区块中初试化返回<br /> static {<br /> try {<br /> //声明配置文件的名称（映射文件被定义在其中）<br /> String resource = "sql_map_config.xml"; </p> <p> //利用工具类Resources来读取到配置文件<br /> Reader reader = Resources.getResourceAsReader(resource); </p> <p> //创建SqlMapClient接口的变量实例<br /> sqlMap = SqlMapClientBuilder.buildSqlMapClient(reader);</p> <p> } catch (Exception e) {<br /> e.printStackTrace();<br /> throw new RuntimeException(<br /> "Error initializing MyAppSqlConfig class. Cause: " + e);<br /> }<br /> }</p> <p> public static SqlMapClient getSqlMapInstance() {<br /> //提供静态方法返回静态区块中得到的SqlMapClient<br /> return sqlMap;<br /> }<br /> }</p> <p>

 

How To
如何获得刚插入记录的自增长ID值？
  <insert id="insertUser" parameterClass="User"><br /> insert into t_user values (<br /> null,#username#,#password#<br /> )</p> <p> <selectKey resultClass="int" keyProperty="id"><br /> SELECT @@IDENTITY AS ID<br /> </selectKey><br /> </insert><br />  
 
       User user = new User();<br /> user.setUsername("张三");<br /> user.setPassword("张三密码"); </p> <p> //如果主键是自动生成的，则其返回值可以通过<selectKey>标签来设置<br /> //如果不通过<selectKey>标签来设置，则返回值为空！<br /> //<selectKey >中的keyProperty，是指定User中的id属性，当调用结束之后，<br /> //user对象的id值和insert方法的返回值都是这条记录的ID值！<br /> Object obj = sqlMapper.insert("insertUser", user);</p> <p>  

 

parameterClass的使用
  <insert id="insertUser" parameterClass="User"><br /> insert into t_user values (<br /> null,#username#,#password#<br /> )</p> <p> <selectKey resultClass="int" keyProperty="id"><br /> SELECT @@IDENTITY AS ID<br /> </selectKey><br /> </insert> </p> <p> <insert id="insertUser2"><br /> insert into t_user values (<br /> null,#username#,#password#<br /> )</p> <p> <selectKey resultClass="int" keyProperty="id"><br /> SELECT @@IDENTITY AS ID<br /> </selectKey><br /> </insert><br />  
 

 

insertUser使用了parameterClass，所以必需传入User类型的对象

       User user = new User();<br /> user.setUsername("张三");<br /> user.setPassword("张三密码"); </p> <p> //传递进去的对象，必须是User类型<br /> Object obj = sqlMapper.insert("insertUser", user);</p> <p>  

 

insertUser2没有使用parameterClass，所以可以传入任意具有相应属性值的对象

       JustAnObject anobj = new JustAnObject();<br /> anobj.setUsername("用户名");<br /> anobj.setPassword("用户密码"); </p> <p> //如果没有指定parameterClass属性，则任何一个具有相应属性值<br /> //的对象都可以被传递进去<br /> Object obj = sqlMapper.insert("insertUser2", anobj);</p> <p>  

 

parameterMap的使用
  <parameterMap class="User" id="insertUser-param"><br /> <parameter property="username"/><br /> <parameter property="password"/><br /> </parameterMap> </p> <p> <insert id="insertUser" parameterMap="insertUser-param"><br /> insert into t_user values (<br /> null,?,?<br /> )</p> <p> <selectKey resultClass="int" keyProperty="id"><br /> SELECT @@IDENTITY AS ID<br /> </selectKey><br /> </insert></p> <p>  

 

parameterMap用于传入参数，以便匹配SQL语句中的?号

       User user = new User();<br /> user.setUsername("张三dd");<br /> user.setPassword("张三密码dd");<br /> Object obj = sqlMapper.insert("insertUser", user);</p> <p>  

 

利用parameterMap，可以定义参数对象的属性如何映射到SQL查询语句的动态参数上，注意parameterMap中<parameter/>标签的先后顺序不能颠倒！

 

如何将查询结果映射到不同的对象？(resultClass的使用)
  <select id="selectUserForOtherObject" resultClass="com.bjsxt.ibatis.OtherObject" parameterClass="int"><br /> select<br /> username as prop1,<br /> password as prop2<br /> from t_user where id=#value#<br /> </select></p> <p>  

 

       //查找t_user表，将其结果映射到一个属性名不同的对象中！

       OtherObject obj = (OtherObject)sqlMapper.queryForObject("selectUserForOtherObject", 1);<br /> System.out.println(obj.getProp1()+","+obj.getProp2());<br />  
 

 

 

如何将查询结果集映射到不同的对象？(resultMap的基本使用)
 

  <resultMap class="com.bjsxt.ibatis.OtherObject" id="ooResult"><br /> <result property="prop1" column="username"/><br /> <result property="prop2" column="password"/><br /> </resultMap><br /> <!--<br /> 如果使用resultMap来定义如何映射，则如下语句不可写成：<br /> select username as prop1,password as prop2 ....<br /> --><br /> <select id="selectUserForOtherObject2" parameterClass="int" resultMap="ooResult"><br /> select<br /> username,<br /> password<br /> from t_user where id=#value#<br /> </select></p> <p>

 

       //查找t_user表，将其结果映射到一个属性名不同的对象中！<br /> OtherObject obj = (OtherObject)sqlMapper.queryForObject("selectUserForOtherObject2", 17);<br /> System.out.println(obj.getProp1()+","+obj.getProp2());<br />  
 

 

如何将查询结果集映射为xml格式的数据？
 

  <select id="selectXmlData" resultClass="xml" xmlResultName="User" parameterClass="int"><br /> select * from t_user where id=#value#<br /> </select><br /> <select id="selectXmlDatas" resultClass="xml" xmlResultName="User"><br /> select * from t_user<br /> </select></p> <p>

 

       //查找t_user表，将其结果映射到xml！<br /> //返回值是xml形式的字符串<br /> Object obj = (Object)sqlMapper.queryForObject("selectXmlData", 1);<br /> System.out.println(obj); </p> <p> //查找t_user表，将其结果映射到xml！<br /> List list = (List)sqlMapper.queryForList("selectXmlDatas");<br /> System.out.println(list);</p> <p>

 

如何用Map类型的对象作为传入参数？
  <!--<br /> 这里，可以使用全路径类名，如：<br /> java.util.Map<br /> java.util.HashMap<br /> java.util.TreeMap<br /> 或<br /> map<br /> --><br /> <insert id="insertUser" parameterClass="map"><br /> insert into t_user values (<br /> null,#username#,#password#<br /> )<br /> </insert><br />  
 

 

       Map user = new TreeMap();<br /> user.put("username", "Map用户");<br /> user.put("password", "Map用户密码");<br /> sqlMapper.insert("insertUser",user);</p> <p>

 

如何将查询结果集的元素转换为Map类型的对象？
  <!--<br /> resultClass可以定义为java.util.HashMap类型，<br /> 将能自动转换<br /> --><br /> <select id="selectMapUsers" resultClass="java.util.HashMap"><br /> select * from t_user<br /> </select><br />  
 

 

       List list = (List)sqlMapper.queryForList("selectMapUsers");<br /> System.out.println(list);<br /> for (Iterator iter = list.iterator(); iter.hasNext();) {<br /> Map map = (Map) iter.next();<br /> //可在此输出map的数据<br /> }</p> <p>

 

 

 

 

事务处理
可以使用sqlMapClient的startTransaction/commitTransaction/endTransaction等方法来控制事务的边界。

 

如果与spring整合（这是iBatis推荐的方式），则我们需要在spring配置文件中指定其事务特性。

 

 

与spring集成
Spring通过DAO模式，提供了对iBATIS的良好支持。SqlMapClient对象是iBATIS中的主要对象，我们可以通过配置让spring来管理SqlMapClient对象的创建。

 

与hibernate类似，Spring 提供了SqlMapClientDaoSupport对象，我们的DAO可以继承这个类，通过它所提供的SqlMapClientTemplate对象来操纵数据库。看起来这些概念都与hibernate类似。

 

通过SqlMapClientTemplate来操纵数据库的CRUD是没有问题的，这里面关键的问题是事务处理。Spring提供了强大的声明式事务处理的功能，我们已经清楚hibernate中如何配置声明式的事务，那么在iBATIS中如何获得声明式事务的能力呢？

 

第一，我们需要了解的是spring通过AOP来拦截方法的调用，从而在这些方法上面添加声明式事务处理的能力。典型配置如下：

    <!-- 配置事务特性 --><br /> <tx:advice id="txAdvice" transaction-manager="事务管理器名称"><br /> <tx:attributes><br /> <tx:method name="add*" propagation="REQUIRED"/><br /> <tx:method name="del*" propagation="REQUIRED"/><br /> <tx:method name="update*" propagation="REQUIRED"/><br /> <tx:method name="*" read-only="true"/><br /> </tx:attributes><br /> </tx:advice> </p> <p> <!-- 配置哪些类的方法需要进行事务管理 --><br /> <aop:config><br /> <aop:pointcut id="allManagerMethod" expression="execution(* com.bjsxt.crm.manager.*.*(..))"/><br /> <aop:advisor advice-ref="txAdvice" pointcut-ref="allManagerMethod"/><br /> </aop:config></p> <p>

这些事务都是声明在业务逻辑层的对象上的。

 

 

第二，我们需要一个事务管理器，对事务进行管理。

    <bean id="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"><br /> <property name="dataSource" ref="dataSource"/><br /> </bean><br /> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"><br /> <property name="driverClassName" value="com.mysql.jdbc.Driver"/><br /> <property name="url" value="jdbc:mysql://127.0.0.1/crm"/><br /> <property name="username" value="root"/><br /> <property name="password" value="mysql"/><br /> </bean><br />  
 

 

此后，我们需要让spring来管理SqlMapClient对象：

    <bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean"><br /> <property name="configLocation"><value>classpath:sqlMapConfig.xml</value></property><br /> </bean><br />  
 

 

我们的DAO的编写：

package com.bjsxt.crm.dao.impl.ibatis;</p> <p>import java.util.List;<br /> import org.springframework.orm.ibatis.support.SqlMapClientDaoSupport;<br /> import com.bjsxt.crm.dao.UserDAO;<br /> import com.bjsxt.crm.model.User; </p> <p>public class UserDAOImpl extends SqlMapClientDaoSupport implements UserDAO {<br /> public void delete(User user) {<br /> getSqlMapClientTemplate().delete("delete",user.getId());<br /> } </p> <p> public List findAll() {<br /> return getSqlMapClientTemplate().queryForList("findAll");<br /> } </p> <p> public User findById(int id) {<br /> return (User)getSqlMapClientTemplate().queryForObject("findById", id);<br /> } </p> <p> public void save(User user) {<br /> getSqlMapClientTemplate().insert("save",user);<br /> } </p> <p> public void update(User user) {<br /> getSqlMapClientTemplate().update("update",user);<br /> }<br /> }</p> <p>

 

继承SqlMapClientDaoSupport，要求我们注入SqlMapClient对象，因此，需要有如下的DAO配置：

<bean id="userDAO" class="com.bjsxt.crm.dao.impl.ibatis.UserDAOImpl"><br /> <property name=”sqlMapClient” ref=”sqlMapClient”/><br /> </bean><br />  
 

 

这就是所有需要注意的问题了，此后就可以在业务逻辑层调用DAO对象了！