IBATIS入门

来源:互联网 发布:新用户软件 编辑:程序博客网 时间:2024/05/01 04:13

iBatis是又一个O/R Mapping解决方案,j2ee的O/R方案真是多,和Hibernate相比,iBatis最大的特点就是小巧,上手很快。如果你不需要太多复杂的功能,iBatis是能满足你的要求又足够灵活的最简单的解决方案。

iBatis最大的特点是简单,最新版本2.0(下载),和1.0相比,主要改动在XML配置文件上,不过,只要有SQL基础,相信你不用教程也能看明白。下面我们看一个最简单的例子入门。

我们先建一个表Account,包括字段username, varchar(20), pk和password, varchar(20),随便填入一些数据。然后编写iBatis必须的配置文件sql-map-config.xml,文件名随意,内容如下:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMapConfig
  PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN"
  "
http://www.ibatis.com/dtd/sql-map-config-2.dtd">
<sqlMapConfig>
  <settings
    cacheModelsEnabled="true"     //
    enhancementEnabled="true"      
    lazyLoadingEnabled="true"
    maxRequests="32"            //同一时间内执行sql语句的次数
    maxSessions="10"            //同一时间内能起作用的session数
    maxTransactions="5"         //同一时间内执行的事物的次数
    useStatementNamespaces="false"
  />
  <transactionManager type="JDBC" >
    <dataSource type="SIMPLE">
      <property name="JDBC.Driver" value="sun.jdbc.odbc.JdbcOdbcDriver"/>
      <property name="JDBC.ConnectionURL" value="jdbc:odbc:Blog"/>
      <property name="JDBC.Username" value="admin"/>
      <property name="JDBC.Password" value=""/>
    </dataSource>

  </transactionManager>
  <sqlMap resource="Account.xml" />
</sqlMapConfig>


其他部分你不用管它,我是直接copy的示例配置,只需注意红色部分,配置好数据源即可。我用的是Access,所以用JdbcOdbc驱动。如果你用MySQL或其他数据库,更改相应的属性。

然后注意到这个配置文件还引用了一个Account.xml,没错,iBatis把每个需要O/R Mapping的Java对象关联到一个xml配置文件,我们需要把一个Account表映射到一个Account类:

package example;
public class Account {
    private String username;
    private String password;

    public String getUsername() { return username; }
    public void setUsername(String username) { this.username=username; }

    public String getPassword() { return password; }
    public void setPassword(String password) { this.password=password; }
}


编写Account.xml文件:

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMap
  PUBLIC "-//iBATIS.com//DTD SQL Map 2.0//EN"
  "
http://www.ibatis.com/dtd/sql-map-2.dtd">
<sqlMap namespace="Account">

  <select id="getAccount" parameterClass="java.lang.String" resultClass="example.Account">
    select * from Account where username = #value#
  </select>


  <insert id="createAccount" parameterClass="example.Account">
    insert into Account (username, password)
    values ( #username#, #password# )
  </insert>

</sqlMap>

我们主要关心红色部分。以<select ...>为例,这里定义了一个查询方法,名字为getAccount,传入参数为String,返回类型resultClass就是example.Account类,select语句相信你已经很熟悉了,#value#是我们将要传进去的String。

<insert...>与之类似,不过注意到#username#和#password#,由于参数是Account类,它们将被Account.getUsername()和Account.getPassword()替换。所以,只要你会写SQL,就能非常容易地写出配置文件。

最后便是如何使用iBatis实现O/R映射。首先初始化iBatis获得一个SqlMapClient对象:

    com.ibatis.sqlmap.client.SqlMapClient sqlMap = null;
    try {
        java.io.Reader reader = om.ibatis.common.resources.Resources.getResourceAsReader ("sql-map-config.xml");
        sqlMap = SqlMapClientBuilder.buildSqlMapClient(reader);
    } catch (Exception e) {
        e.printStackTrace();
    }


然后就可以异常方便地使用O/R Mapping了,比如查询username=admin的Account:

    try {
        Account accout = (Account)sqlMap.queryForObject("getAccount", "admin");
        ...
    }


或者创建一个新的Account:

    try {
        Account account = new Account();
        account.setUsername("micheal");
        account.setPassword("1234");
        sqlMap.insert("createAccount", account);
    }


运行时把两个配置文件和iBatis的3个jar包放到classpath中,要求jdk1.4版本。

总结:iBatis确实简单灵活,上手容易,代码很少,配置稍嫌复杂。不足之处一是没有方便的工具来自动生成xml配置文件,二是不管是query还是insert都只能传入一个参数,有时不得不把两个参数包装成一个类传进去。另外对常见的1:1,1:N关系的支持不如Hibernate。不过,大多数时候iBatis已经完全可以满足我们的需求。Spring很好的集成了iBatis,你可以参考Spring的JPetStore示例。需要注意的是使用iBatis 2.0和1.0有较大区别,主要体现在配置文件上,iBatis 2.0新增了DAO框架,不需要Spring提供的DAO也能很方便地实现DAO模式。

=======================================下面是关于ibatis的一些配置简单介绍

二、 现在介绍使用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表示缺省值