Ibatis学习笔记

原：http://blog.csdn.net/chjttony/article/details/6026078

 

1.       Ibatis是开源软件组织Apache推出的一种轻量级的对象关系映射(ORM)框架，和Hibernate、Toplink等在java编程的对象持久化方面深受开发人员欢迎。

对象关系映射(ORM)：简单原理是通过面向对象方式操作关系型数据库，目前存储数据最常用最流行的工具是关系型数据库，其操作方式是通过SQL语句操作数据库的表，但是对于Java面向对象编程语言中，所有的操作对象都是对象，因此对象关系映射就是把数据库表和java编程语言中的对象对应起来，把表的列同java对象中的字段对应起来，程序员在程序开发过程中不再是使用原始SQL语句去直接操作数据库，而是通过ORM提供的查询语句操作普通的java对象，ORM将其提供的对普通java对象的查询语句翻译成SQL语句来操作数据库，从而屏蔽了不同数据库SQL语句的差别，简化了程序开发工作，提高了程序的可移植性。

2.       Ibatis开发的准备工作：

(1).将Ibaits相关的jar包添加到工程的类路径下。

(2).Ibatis工程的主要配置文件为：

a.Ibatis的总配置文件SqlMapConfig.xml。

b.Ibatis的实体映射文件。

3．Ibatis总配置文件：

Ibatis的总配置文件主要是配置数据库连接相关信息，和Ibatis实体映射文件。其写法示例如下：

[xhtml] view plaincopy

1. <? xml version=”1.0” encoding=”UTF-8” ?>  
2. <! DOCTYPE sqlMapConfig public “-//ibatis.apache.org//DTD SQL Map Config 2.0//EN”  
3. “http://ibatis.apache.org//dtd//sql-map-config-2.dtd”>  
4. <sqlMapConfig>  
5.        <transactionManager type=”JDBC” commitRequired=”false”>  
6.               <dataSource type=”SIMPLE”>  
7.                      <property name= “JDBC.Driver” value=”数据库的jdbc驱动”/>  
8.                      <property name=”JDBC.ConnectionURL” value=”数据库的url”/>  
9.                      <property name=”JDBC.Username” value=”数据库用户名”/>  
10.                      <property name=”JDBC.Password” value=”数据库的密码”/>  
11.                      ……  
12.               </dataSource>  
13.        </transactionManager>  
14.        <sqlMap resource=”Ibatis的实体映射文件”/>  
15.        ……  
16. </sqlMapConfig>  

 

4.  Ibatis实体映射文件的写法示例：

Ibatis的实体映射文件是Ibatis框架的核心，起作用是将Java的持久化实体对象和关系型数据库映射起来，其内容主要是包括java实体各种增删改查操作对应的数据库语句。其写法示例如下：

[xhtml] view plaincopy

1. <? xml version=”1.0” encoding=”UTF-8” ?>  
2. <! DOCTYPE sqlMap public “-//ibatis.apache.org//DTD SQL Map 2.0//EN”  
3. “http://ibatis.apache.org//dtd//sql-map-2.dtd”>  
4. <sqlMap namespace=”Ibatis命名空间”>  
5.        <typeAlias alias=”实体类类别名” type=”实体类全路径”/>  
6.        <!--restultMap主要是用于Ibatis对数据增删改查操作的返回值结果对于java对象的映射，一般用于所返回的对象可能包含的是一个以上java对象的字段，如果是一个java对象中的字段一般使用resultClass-->  
7.        <resultMap id=”结果集id” class=”实体类别名”>  
8.               <result property=”java实体类中的属性名” column=”数据库表中的列名”/>  
9.               ……  
10.        </resultMap>  
11.        ……  
12. </sqlMap>  

 

5.       读取Ibatis的总配置文件得到SqlMapClient：

[java] view plaincopy

1. private static SqlMapClient sqlMapClient = null;  
2. static{  
3.        try{  
4.        Reader reader = com.ibatis.common.resource.Resources.getResourceAsReader(“Ibatis总配置文件路径”);  
5.        sqlMapClient = com.ibatis.sqlMap.client.SqlMapClientBuilder.builderSqlMapClient(reader);  
6.        reader.close();  
7. }catch(IOException e){  
8.        异常处理…….  
9. }  
10. }  

 

6.       Ibatis的SQL Map：

(1).Ibatis的SQL Map的核心概念是Mapped Statement。Mapped Statement可以使用任意的SQL语句，并拥有parameterMap/parameterClass(输入参数)和resultMap/resultClass(输出结果)。

(2). <statement>元素是个通用的声明，可以用于任何类型的SQL语句，但是通常使用具体的<statement>类型，如：查询使用<select>，添加使用<insert>，更新使用<update>，删除使用<delete>。

7.       Ibatis的增删改查操作简单例子：

(1).实体类必须遵循JavaBean的规范，提供一个无参数的构造方法，字段必须提供get和set方法。

(2).在Ibatis对应的实体映射文件的<sqlMap>标签元素添加如下：

a.Ibatis添加：

[xhtml] view plaincopy

1. <insert id=”Ibatis添加实体操作Id” parameterClass=”参数类型”>  
2.        insert into 实体对应数据库中的表名(实体字段对应的表的列名1, 实体字段对应的表的列名2,……) values(#实体类字段1#,#实体类字段2#......);  
3. </insert>  

 

注意：Ibatis增删改查语句的参数是通过parameterClass或者parameterMap传递的。Ibatis只能传递一个参数，如果又多个参数需要封装在一个对象中。

b. Ibatis删除：

[xhtml] view plaincopy

1. <delete id=”Ibatis删除实体操作Id” parameterClass=”参数类型”>  
2.        delete from 实体对应数据库中的表名 where 列名=#列名对应的实体字段名#;  
3. </delete>  

 

注意：删除和查询时，经常需要根据一定条件操作，有时可能需要模糊查询，对于模糊查询如name like‘%c%’。在Ibatis中有两种写法：

写法1：在java方法中传递参数时写成：”%字段名%”。

写法2：在Ibatis的sql语句中可以写成如：where name=’%$字段名$%’。

a.       Ibatis更新：

[xhtml] view plaincopy

1. <update id=”Ibatis更新实体操作Id” parameterClass=”参数类型”>  
2.        update 实体对应数据库的表名 set 列名1=#字段1#，列名2=#字段2#，…….where ….;  
3. </update>  

 

b.       Ibatis查询

[xhtml] view plaincopy

1. <select id=”Ibatis查询实体操作Id” resultClass=”查询结果类型” >  
2.        select * from 实体对应的表名;  
3. </select>  

 

注意：这里演示的是最简单的查询，其结果是一个实体的集合。

8.       在java对象中使用Ibatis的statement操作：

(1).根据Ibatis总配置文件得到SqlMapClient对象，具体方法参见“5. 读取Ibatis的总配置文件得到SqlMapClient”。

(2).使用SqlMapClient对象的queryForObject()，queryForList()，insert()，delete()，update()方法。这些方法都需要一个传递一个参数：在实体映射文件中定义的操作statementId，如果这些定义的操作还需要输入参数，则还需要传递输入参数对象。简单用法如下：

实体对象类型 对象= sqlMapClient.queryForObject(“实体映射文件命名空间.statementId”, “查询条件参数”);

9.       Ibatis主键自动生成：

通过使用<select>的子元素<selectkey>来支持自动生成主键。对于不同的数据库主键自动生成机制是不同的，Oracle是通过自增序列欲生成的，MS-SQL Server是通过Identity后生成的。这里以Oracle数据库为例简单讲述一下主键自动生成的方法：

(1).首先在Oracle数据库中创建一个自增的序列：

create Sequence 序列名

start with 1

increment 1;

(2).在insert标签中插入selectkey子标签：

[xhtml] view plaincopy

1. <insert id=”添加实体操作Id” parameterClass=”输入参数类型”>  
2.        <selectkey resultClass=”int” keyProperty=”自定义主键名称”>  
3.               select 序列名.nextval from dual;  
4.        </selectkey>  
5.        insert into 表名(主键,列名1,列名2,……)  
6.        values(#自定义主键名称#,#字段1#,#字段2#,…….);  
7. </insert>  

 

注意：selectkey标签中的keyProperty属性是主键赋值的对象。

10.   Ibatis的内嵌参数：

所谓内嵌参数是指，使用Ibatis时，当没有给定参数传递值时，Ibatis会使用默认的值代替。

语法为：#参数值：数据库中数据类型：内嵌参数#

一个简单的例子如下：

[xhtml] view plaincopy

1. <statement id=”insertProduct” parameterClass=”Product”>  
2.        Insert into Product(PRD_ID,PRD_DESC)  
3.        values(#id:Number:-999999#,#desc:varchar:noEntry#);  
4. </statement>  

 

当id没有给定值是数据库中默认为0，当desc没有给定值是数据库默认给定noEntry。

11.   Ibatis对象之间的关系：

Ibatis的输入参数和输出参数只能是一个，因此，当输入参数在一个实体对象时，使用parameterClass，当输入对象也只在一个实体对象中时，使用resultClass。

但是有很多时候输入参数和输出参数可能包含在几个实体对象中，我们不能为了只传递一个参数而专门为这些输入和输出参数组合专门创建类，因此就需要使用parameterMap和resultMap来组合多个实体对象中的字段。

以resultMap为例，使用方法如下：

[xhtml] view plaincopy

1. <resultMap id=”resultMapId”>  
2.        <result property=”……” column=”…….” select=”实体映射文件中的StatementId”/>  
3.        ……  
4. </resultMap>  

 

12.   Ibatis的SQL Map通过<procedure>标签元素调用存储过程：

存储过程是数据库将一组完成特定功能的Sql语句进行编译，每次调用时不必重新编译，因此执行速度和效率都比直接使用Sql语句有很大优势。在Ibatis中通过<procedure>标签元素可以直接调用数据库的存储过程，其过程如下：

(1).定义存储过程所需输入/输出参数，如：

[xhtml] view plaincopy

1. <parameterMap id=”存储过程参数” class=”map”>  
2.        <parameter property=”email1” jdbcType=”varchar” javaType=”java.lang.String” mode=”INOUT”/>  
3.        <parameter property=”email2” jdbcType=”varchar” javaType=”java.lang.String” mode=”INOUT”/>  
4. </parameterMap>  

 

(2).调用存储过程，如：

[xhtml] view plaincopy

1. <procedure id=”Ibatis调用存储过程” parameterMap=” 存储过程参数”>  
2.        {call 存储过程名(?,?)}  
3. </procedure>  

 

注意：Ibatis调用存储过程时，要确保始终只使用JDBC标准的存储过程语法。

13.   Ibatis与Spring集成：

现在Java Web开发中，SSH(Spring,Sturts,Hibernate)三个开源框架组合非常流行，对于一些对Hibernate不熟悉或者怀疑Hibernate性能的人，也可以使用Ibatis代替Hibernate框架，即SSI(Spring,Struts,Ibatis)。Spring和Struts的集成这里不多说了，具体说一下Spring和Ibatis的集成。

(1).对Ibatis工程引入Spring支持，即将Spring相关的jar包加入到类路径中，在/src目录下创建spring配置文件，在web.xml文件中指定spring配置文件并添加spring的WebContext启动监听器。

(2).将对数据库的连接信息放交由spring管理，在spring配置文件中添加数据库连接信息：

[xhtml] view plaincopy

1. <bean id=”dataSource” class=”org.apache.commons.dbcp.BasicDataSource” destroy-method=”close”>  
2.        <property name=”driverClassName” value=”数据库驱动类”/>  
3.        <property name=”url” value=”数据库连接URL”/>  
4.        <property name=”username” value=”数据库连接用户名”/>  
5.        <property name=”password” value=”数据库连接密码”/>  
6. </bean>  

 

(3).在spring配置文件中添加对Ibatis的支持：

[xhtml] view plaincopy

1. <bean id=”sqlMapClient” class=”org.springframework.orm.ibatis.SqlMapClientFactoryBean”>  
2.        <property name=”configLocation” value=”Ibatis总配置文件路径”/>  
3.        <!--为Spring创建的SqlMapClient对象指定数据源-->  
4.        <property name=”dataSource” ref=”dataSource”/>  
5. </bean>  

 

(4).在Ibatis总配置文件中移除关于数据库连接的信息，只需在Ibatis总配置文件中配置实体映射文件即可。

至此，Spring和Ibatis就无缝集成起来，在使用时Spring会读取创建SqlMapClient对象，并为其注入数据源，直接通过spring获得SqlMapClient对象就可以直接使用。

14.   Ibatis优缺点总结：

优势：使用标准的Sql语句，与JDBC相比简单方便，减少了代码量，架构和性能得到增强；与Hibernate等ORM工具相比因为更接近Sql语句，性能可控；sql语句与程序代码分隔，简化了项目分工，大大提高并行开发的可能性。

缺点：还需要写标准的sql语句，不像Hibernate完全屏蔽了底层数据库的差异，程序的可移植性比Hibernate和JPA要差；输入参数和输出参数都只能有一个，程序编写的灵活性不是太高。

15.   这里只是简单总结了Ibatis的入门开发知识，对于实体之间关系等比较深入了解Ibatis相关的知识其实和Hibernate，JPA等类似，这里不再赘述。