iBatis入门例子

Batis 是一个 O/R Mapping 解决方案， iBatis 最大的特点就是小巧，上手很快。如果你不需要太多复杂的功能， iBatis 是能满足你的要求又足够灵活的最简单的解决方案。下面我们看一个最简单的入门例子，是《 ibatis 开发指南》上的例子改的，不过上面讲的不仔细，我开始学的时候搞了一个晚上才把那个例子跑起来的，相信一些朋友也和我一样，在入门的时候有一点小郁闷，我把整个工程项目打包了供朋友 下载 ，工具是 eclipse3.2+myeclipse5.0 ，导入即可运行，数据库用的是 MySQL 。也可以改用别的数据库！<o:p></o:p> <o:p> </o:p>

先建数据库和表吧； sql 语句我导出来了：

  /**/ /* 

SQLyog 企业版 - MySQL GUI v4.1

主机 - 5.0.7-beta-nt : 数据库 - sample

*********************************************************************

服务器版本 : 5.0.7-beta-nt

create database if not exists `sample`;

USE `sample`;

/* 数据表 `t_user` 的表结构 */ 

 drop   table   if   exists  `t_user`;

 CREATE   TABLE  `t_user` (

  `id`  int  ( 11 )  NOT   NULL  auto_increment,

  ` name `  varchar  ( 50 )  default   NULL  ,

  `sex`  int  ( 11 )  default   NULL  ,

   PRIMARY   KEY    (`id`)

) ENGINE = InnoDB  DEFAULT  CHARSET = latin1;

 /**/ /*  数据表 `t_user` 的数据 */ 

 insert   into  `t_user`  values  ( 1 ,  ' zhupan '  , 1 ),( 2 ,  ' zhupan '  , 2 ),( 3 ,  ' 3 '  , 3 ),( 4 ,  ' 4 '  , 4 ),( 5 ,  ' 5 '  , 5 ); 

整个工程目录结构如下：

 <o:p> </o:p>

下面开始编写每个文件： <o:p> </o:p>

编写 iBatis 必须的配置文件 SqlMapConfig.xml ，放在包 com.ctgusec.zhupan.maps 下，文件名可以任意改，内容如下： 

xml 代码

1. xml version="1.0" encoding="UTF-8" ?>  
3.     PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN"    
4.     "http://www.ibatis.com/dtd/sql-map-config-2.dtd">  
5.   
6. <sqlMapConfig>  
7.   
8.     <settings cacheModelsEnabled="true" enhancementEnabled="true"  
9.         lazyLoadingEnabled="true" errorTracingEnabled="true" maxRequests="32"  
10.         maxSessions="10" maxTransactions="5" useStatementNamespaces="false" />  
11.   
12.     <transactionManager type="JDBC">  
13.         <dataSource type="SIMPLE">  
14.             <property name="JDBC.Driver" value="com.mysql.jdbc.Driver" />  
15.             <property name="JDBC.ConnectionURL"  
16.                 value="jdbc:mysql://localhost/sample" />  
17.             <property name="JDBC.Username" value="root" />  
18.             <property name="JDBC.Password" value="" />  
19.             <property name="Pool.MaximumActiveConnections" value="10" />  
20.             <property name="Pool.MaximumIdleConnections" value="5" />  
21.             <property name="Pool.MaximumCheckoutTime" value="120000" />  
22.             <property name="Pool.TimeToWait" value="500" />  
23.             <property name="Pool.PingQuery"  
24.                 value="select 1 from sample" />  
25.             <property name="Pool.PingEnabled" value="false" />  
26.             <property name="Pool.PingConnectionsOlderThan" value="1" />  
27.             <property name="Pool.PingConnectionsNotUsedFor" value="1" />  
28.         dataSource>  
29.     transactionManager>  
30.   
31.     <sqlMap resource="com/ctgusec/zhupan/maps/User.xml" />  
32. sqlMapConfig>  

如果不用 mysql 数据库，需要重新配置数据源，更改相应的属性即可。 

然后注意到这个配置文件还引用了一个 User.xml ， iBatis 把每个需要 O/R Mapping 的 Java 对象关联到一个 xml 配置文件，我们需要把 t_user 表映射到一个 User 类： <o:p></o:p>

 

java 代码

1. package com.ctgusec.zhupan.model;   
2.   
3. import java.io.Serializable;   
4.   
5. public class User implements Serializable {   
6.   
7.     /** */  
8.     /**  
9.      *   
10.      * @author zhupan  
11.      *   
12.      */  
13.   
14.     private static final long serialVersionUID = 1L;   
15.   
16.     private Integer id;   
17.   
18.     private String name;   
19.   
20.     private Integer sex;   
21.   
22.     public User() {   
23.   
24.     }   
25.   
26.     public Integer getId() {   
27.   
28.         return this.id;   
29.   
30.     }   
31.   
32.     public void setId(Integer id) {   
33.   
34.         this.id = id;   
35.   
36.     }   
37.   
38.     public String getName() {   
39.   
40.         return this.name;   
41.   
42.     }   
43.   
44.     public void setName(String name) {   
45.   
46.         this.name = name;   
47.   
48.     }   
49.   
50.     public Integer getSex() {   
51.   
52.         return this.sex;   
53.   
54.     }   
55.   
56.     public void setSex(Integer sex) {   
57.   
58.         this.sex = sex;   
59.   
60.     }   
61.   
62. }   

编写 User.xml 文件： <o:p></o:p>

xml 代码

1. xml version="1.0" encoding="UTF-8"?>  
2.   
4.     PUBLIC "-//iBATIS.com//DTD SQL Map 2.0//EN"    
5.     "http://www.ibatis.com/dtd/sql-map-2.dtd">  
6.   
7. <sqlMap namespace="User">  
8.   
9.     <typeAlias alias="user" type="com.ctgusec.zhupan.model.User" />  
10.     <select id="getUser" parameterClass="java.lang.String"  
11.         resultClass="user">  
12.          
13.     select   
14.       name,   
15.       sex   
16.     from t_user   
17.     where name = #name#   
18.     ]]>  
19.     select>  
20.   
21.     <select id="getAllUser" resultClass="user">  
22.          
23.     select   
24.       name,   
25.       sex   
26.     from t_user   where name = #name#    
27.     ]]>  
28.     select>  
29.   
30.     <update id="updateUser" parameterClass="user">  
31.          
32.     UPDATE t_user   
33.     SET    
34.       name=#name#,   
35.       sex=#sex#   
36.   WHERE id = #id#   
37. ]]>  
38.     update>  
39.   
40.     <insert id="insertUser" parameterClass="user">  
41.         INSERT INTO t_user ( name, sex) VALUES ( #name#, #sex# )   
42.     insert>  
43.   
44.     <delete id="deleteUser" parameterClass="java.lang.String">  
45.         delete from t_user where id=#value#   
46.     delete>  
47.   
48. sqlMap>  

通过insert、delete、update、select节点，分别定义了针对 TUser 对象的增删改查操作。在这些节点中，我们指定了对应的 SQL 语句：ID 指定了操作 ID，之后我们可以在代码中通过指定操作 id 来执行此节点所定义的操作，如： sqlMap.update("updateUser",user);   ID设定使得在一个配置文件中定义两个同名节点成为可能（两个update节点，以不同id区分） parameterClass 指定 了 操 作 所 需的 参 数 类型 ， 此例 中 update 操 作 以com.ctgusec.zhupan.model.User 类型的对象作为参数，目标是将提供的 User实例更新到数据库。 parameterClass="user"中，user为“com.ctgusec.zhupan.model.User”类的别名，别名可通过typeAlias节点指定，如示例配置文件中的：<typealias alias="user" type="com.ctgusec.zhupan.model.User"></typealias>“#name#”在运行期会由传入的user对象的name属性填充。 “#sex#”，将在运行期由传入的 user 对象的sex属性填充。“#id#”，将在运行期由传入的user对象的id属性填充。<o:p></o:p> <o:p> </o:p>

只要你会写SQL，就能非常容易地写出配置文件。

最后便是如何使用iBatis实现O/R映射,测试给个例子：
运行时把 lib 包下的所有 .jar 构建到路径中，操作如下： 
 

java 代码 

1. package com.ctgusec.zhupan;   
2.   
3. import java.sql.SQLException;   
4. import java.util.List;   
5.   
6. import com.ctgusec.zhupan.model.User;   
7. import com.ibatis.sqlmap.client.SqlMapClientBuilder;   
8.   
9. /**  
10.  *   
11.  * @author zhupan  
12.  */  
13. public class ExampleMain {   
14.   
15.     public static void update() {   
16.         //首先初始化iBatis获得一个SqlMapClient对象   
17.         String resource = "com/ctgusec/zhupan/maps/SqlMapConfig.xml";   
18.         com.ibatis.sqlmap.client.SqlMapClient sqlMap = null;   
19.         try {   
20.             java.io.Reader reader = com.ibatis.common.resources.Resources   
21.                     .getResourceAsReader(resource);   
22.             sqlMap = SqlMapClientBuilder.buildSqlMapClient(reader);   
23.         } catch (Exception e) {   
24.             e.printStackTrace();   
25.         }   
26.         // sqlMap系统初始化完毕，开始执行update操作   
27.         try {   
28.             sqlMap.startTransaction();   
29.             User user = new User();   
30.             user.setId(new Integer(1));   
31.             user.setName("zhupan");   
32.             user.setSex(new Integer(1));   
33.             sqlMap.update("updateUser", user);   
34.             sqlMap.commitTransaction();   
35.         } catch (SQLException e) {   
36.             System.out.println(e.getMessage());   
37.         } finally {   
38.             try {   
39.                 sqlMap.endTransaction();   
40.             } catch (SQLException e) {   
41.                 e.printStackTrace();   
42.             }   
43.         }   
44.     }   
45.     public static List getUser() {   
46. //      首先初始化iBatis获得一个SqlMapClient对象   
47.         String resource = "com/ctgusec/zhupan/maps/SqlMapConfig.xml";   
48.         com.ibatis.sqlmap.client.SqlMapClient sqlMap = null;   
49.         List user=null;   
50.         try {   
51.             java.io.Reader reader = com.ibatis.common.resources.Resources   
52.                     .getResourceAsReader(resource);   
53.             sqlMap = SqlMapClientBuilder.buildSqlMapClient(reader);   
54.         } catch (Exception e) {   
55.             e.printStackTrace();   
56.         }   
57.         // sqlMap系统初始化完毕，开始执行getAllUser操作   
58.         try {   
59.             sqlMap.startTransaction();                 
60.             user=sqlMap.queryForList("getAllUser", null);   
61.             sqlMap.commitTransaction();   
62.         } catch (SQLException e) {   
63.             System.out.println(e.getMessage());   
64.         } finally {   
65.             try {   
66.                 sqlMap.endTransaction();   
67.             } catch (SQLException e) {   
68.                 e.printStackTrace();   
69.             }   
70.         }   
71.         return user;   
72.     }   
73.     public static void main(String[] args) {   
74.         update();   
75.         List user=getUser();       
76.         for(int i=0;i
77.         {   
78.             System.out.println(((User)user.get(i)).getName());   
79.         }   
80.   
81.     }   
82. }  

总结：iBatis确实简单灵活，上手容易，代码很少，配置稍嫌复杂。动态SQL的确是个强点，熟悉后感觉很不错。iBatis中所有的DAO方法都只传一个值对象，复杂查询当然也不例外。另外对常见的1:1，1:N关系的支持不如Hibernate。使用iBatis 2.0和1.0有较大区别，主要体现在配置文件上，iBatis 2.0新增了DAO框架，不需要Spring提供的DAO也能很方便地实现DAO模式。持久层使用了iBatis后，团队中以前乱七八糟的jdbc包装不见了，大家的编码风格统一了，可以集中精力进行业务组件的编写！ 

源文件下载见附件

Ps ：结合《 ibatis 开发指南》会更容易明白！