iBATIS开发指南.docx

1、iBATIS开发指南IBATIS Developers Guide Version 1.0September 2, 2004 So many open source projects. Why not Open your Documents?OpenDoc SeriesiBATIS 2.0开发指南ibatis 开发指南ibatis Quick Start.5准备工作.5构建ibatis基础代码.5ibatis配置. 11ibatis基础语义.16XmlSqlMapClientBuilder.16SqlMapClient .16SqlMapClient基本操作示例.16OR映射.19ibatis

2、高级特性.26数据关联.26一对多关联.26一对一关联.28延迟加载.30动态映射.31事务管理.35基于JDBC的事务管理机制.35基于JTA的事务管理机制.36外部事务管理.38Cache.39MEMORY类型Cache与WeakReference .40LRU型Cache .42FIFO型Cache .43OSCache.43IBATIS Developers Guide Version 1.0September 2, 2004 So many open source projects. Why not Open your Documents?ibatis 开发指南相对Hibernate

3、和Apache OJB 等“一站式”ORM解决方案而言，ibatis 是一种“半自动化”的ORM实现。所谓“半自动”，可能理解上有点生涩。纵观目前主流的ORM，无论Hibernate 还是Apache OJB，都对数据库结构提供了较为完整的封装，提供了从POJO 到数据库表的全套映射机制。程序员往往只需定义好了POJO 到数据库表的映射关系，即可通过Hibernate或者OJB 提供的方法完成持久层操作。程序员甚至不需要对SQL 的熟练掌握，Hibernate/OJB 会根据制定的存储逻辑，自动生成对应的SQL 并调用JDBC 接口加以执行。大多数情况下（特别是对新项目，新系统的开发而言），这

4、样的机制无往不利，大有一统天下的势头。但是，在一些特定的环境下，这种一站式的解决方案却未必灵光。在笔者的系统咨询工作过程中，常常遇到以下情况：1 系统的部分或全部数据来自现有数据库，处于安全考虑，只对开发团队提供几条Select SQL（或存储过程）以获取所需数据，具体的表结构不予公开。2 开发规范中要求，所有牵涉到业务逻辑部分的数据库操作，必须在数据库层由存储过程实现（就笔者工作所面向的金融行业而言，工商银行、中国银行、交通银行，都在开发规范中严格指定）3 系统数据处理量巨大，性能要求极为苛刻，这往往意味着我们必须通过经过高度优化的SQL语句（或存储过程）才能达到系统性能设计指标。面对这样的

5、需求，再次举起Hibernate 大刀，却发现刀锋不再锐利，甚至无法使用，奈何？恍惚之际，只好再摸出JDBC 准备拼死一搏，说得未免有些凄凉，直接使用JDBC进行数据库操作实际上也是不错的选择，只是拖沓的数据库访问代码，乏味的字段读取操作令人厌烦。“半自动化”的ibatis，却刚好解决了这个问题。这里的“半自动化”，是相对Hibernate等提供了全面的数据库封装机制的“全自动化”ORM 实现而言，“全自动”ORM 实现了POJO 和数据库表之间的映射，以及SQL 的自动生成和执行。而ibatis 的着力点，则在于POJO 与SQL之间的映射关系。也就是说，ibatis并不会为程序员在运行期自

6、动生成SQL 执行。具体的SQL 需要程序员编写，然后通过映射配置文件，将SQL所需的参数，以及返回的结果字段映射到指定POJO。使用ibatis 提供的ORM机制，对业务逻辑实现人员而言，面对的是纯粹的Java对象，这一层与通过Hibernate 实现ORM 而言基本一致，而对于具体的数据操作，Hibernate会自动生成SQL 语句，而ibatis 则要求开发者编写具体的SQL 语句。相对Hibernate等“全自动”ORM机制而言，ibatis 以SQL开发的工作量和数据库移植性上的让步，为系_统设计提供了更大的自由空间。作为“全自动”ORM 实现的一种有益补充，ibatis 的出现显得

7、别具意义。IBATIS Developers Guide Version 1.0September 2, 2004 So many open source projects. Why not Open your Documents?ibatis Quick Start准备工作1. 下载ibatis软件包（）。2. 创建测试数据库，并在数据库中创建一个t_user 表，其中包含三个字段： id(int) name(varchar) sex(int)。3. 为了在开发过程更加直观，我们需要将ibatis日志打开以便观察ibatis运作的细节。ibatis 采用Apache common_loggi

8、ng，并结合Apache log4j 作为日志输出组件。在CLASSPATH 中新建log4j.properties配置文件，内容如下：log4j.rootLogger=DEBUG, stdoutlog4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=%c1 - %m%nlog4j.logger.java.sql.PreparedSt

9、atement=DEBUG构建 ibatis基础代码ibatis 基础代码包括：1 ibatis 实例配置一个典型的配置文件如下（具体配置项目的含义见后）：!DOCTYPE sqlMapConfigPUBLIC -/iBATIS.com/DTD SQL Map Config 2.0/ENIBATIS Developers Guide Version 1.0September 2, 2004 So many open source projects. Why not Open your Documents?2 POJO（Plain Ordinary Java Object）下面是我们用作示例的一

10、个POJO:public class User implements Serializable private Integer id;private String name;private Integer sex;private Set addresses = new HashSet();/* default constructor */public User() public Integer getId() return this.id;IBATIS Developers Guide Version 1.0September 2, 2004 So many open source proje

11、cts. Why not Open your Documents?public void setId(Integer id) this.id = id;public String getName() return this.name;public void setName(String name) this.name = name;public Integer getSex() return this.sex;public void setSex(Integer sex) this.sex = sex;3 映射文件与 Hibernate 不同。因为需要人工编写SQL 代码，ibatis 的映射

12、文件一般采用手动编写（通过Copy/Paste，手工编写映射文件也并没想象中的麻烦）。针对上面POJO 的映射代码如下：!DOCTYPE sqlMapPUBLIC -/iBATIS.com/DTD SQL Map 2.0/ENINSERT INTO t_user (name,sex)VALUES (#name#,#sex#)delete from t_userwhere id = #value#从上面的映射文件可以看出，通过、四个节点，我们分别定义了针对TUser 对象的增删改查操作。在这四个节点中，我们指定了对应的SQL 语句，以update节点为例： ID指定了操作ID，之后我们可以在代码

13、中通过指定操作id 来执行此节点所定义的操作，如：sqlMap.update(updateUser,user);ID设定使得在一个配置文件中定义两个同名节点成为可能（两个update节点，以不同id区分） parameterClass指 定 了操作所需的参数类型， 此例中update 操作以com.ibatis.sample.User 类型的对象作为参数，目标是将提供的User实例更新到数据库。parameterClass=user中，user为“com.ibatis.sample.User”类的别名，别名可通过typeAlias节点指定，如示例配置文件中的： 通过节点，可以避免SQL 中与X

14、ML 规范相冲突的字符对XML映射文件的合法性造成影响。 执行更新操作的SQL，这里的SQL 即实际数据库支持的SQL 语句，将由ibatis填入参数后交给数据库执行。 SQL中所需的用户名参数，“#name#”在运行期会由传入的user对象的name属性填充。 SQL 中所需的用户性别参数“#sex#”，将在运行期由传入的user 对象的sex属性填充。 SQL中所需的条件参数“#id#”，将在运行期由传入的user对象的id属性填充。对于这个示例，ibatis在运行期会读取id 为“updateUser”的update节点的SQL定义，并调用指定的user对象的对应getter方法获取属性

15、值，并用此属性值，对SQL中的参数进行填充后提交数据库执行。此例对应的应用级代码如下，其中演示了ibatis SQLMap的基本使用方法：String resource =com/ibatis/sample/SqlMapConfig.xml;Reader reader;IBATIS Developers Guide Version 1.0September 2, 2004 So many open source projects. Why not Open your Documents?reader = Resources.getResourceAsReader(resource);XmlSq

16、lMapClientBuilder xmlBuilder =new XmlSqlMapClientBuilder();SqlMapClient sqlMap = xmlBuilder.buildSqlMap(reader);/sqlMap系统初始化完毕，开始执行update操作trysqlMap.startTransaction();User user = new User();user.setId(new Integer(1);user.setName(Erica);user.setSex(new Integer(1);sqlMap.update(updateUser,user);sqlMmitTransaction();finallysqlMap.endTransaction();其中，SqlMapClient是ibatis运作的核心，所有操作均通过SqlMapClient实例完成。可以看出，对于应用层而言，程序员面对的是传统意义上的数据对象，而非JDBC中烦杂的ResultSet，这使得上层逻辑开发人员的工作量大大减轻，同时代码更加清晰简洁。数据库操作在映射文件中加以定义，从而将数据存储逻辑从上层逻辑代码中独立出来。而底层数据操作的SQL可配置化，使