1、 IBATIS Developers Guide Version 1.0 September 2, 2004 So many open source projects. Why not Open your Documents? OpenDoc Series iBATIS 2.0 开发指南 V1.0 作者：夏昕 xiaxin(at) So many open source projects. Why not Open your Documents? J IBATIS Developers Guide Version 1.0 September 2, 2004 So many open sourc
2、e projects. Why not Open your Documents? 文档说明 参与人员： 作者 联络 夏昕 xiaxin(at) (at) 为email 符号 发布记录 版本 日期 作者 说明 0.0 2004.8.1 夏昕 第一版 1.0 2004.9.1 夏昕 补充ibatis in Spring部分 OpenDoc版权说明 本文档版权归原作者所有。 在免费、且无任何附加条件的前提下，可在网络媒体中自由传播。 如需部分或者全文引用，请事先征求作者意见。 如果本文对您有些许帮助，表达谢意的最好方式，是将您发现的问题和文档改进意见及时反馈给作者。当然，倘若有时间和能力，能为技术群
3、体无偿贡献自己的所学为最好的回馈。 另外，笔者近来试图就日本、印度的软件开发模式进行一些调研。如果诸位可以赠阅日本、印度软件研发过程中的需求、设计文档以供研究，感激不尽！ IBATIS Developers Guide Version 1.0 September 2, 2004 So many open source projects. Why not Open your Documents? ibatis 开发指南 ibatis Quick Start.5 准备工作.5 构建ibatis基础代码.5 ibatis配置.11 ibatis基础语义.16 XmlSqlMapClientBuild
4、er.16 SqlMapClient .16 SqlMapClient基本操作示例.16 OR映射.19 ibatis高级特性.26 数据关联.26 一对多关联.26 一对一关联.28 延迟加载.30 动态映射.31 事务管理.35 基于JDBC的事务管理机制.35 基于JTA的事务管理机制.36 外部事务管理.38 Cache.39 MEMORY类型Cache与WeakReference .40 LRU型Cache .42 FIFO型Cache .43 OSCache.43 IBATIS Developers Guide Version 1.0 September 2, 2004 So ma
5、ny open source projects. Why not Open your Documents? ibatis 开发指南 相对Hibernate和Apache OJB等“一站式”ORM解决方案而言，ibatis是一种“半自动化”的ORM实现。 所谓“半自动”，可能理解上有点生涩。纵观目前主流的ORM，无论Hibernate还是Apache OJB，都对数据库结构提供了较为完整的封装，提供了从 POJO 到数据库表的全套映射机制。程序员往往只需定义好了POJO到数据库表的映射关系，即可通过Hibernate或者 OJB 提供的方法完成持久层操作。程序员甚至不需要对 SQL 的熟练掌握，
6、 Hibernate/OJB会根据制定的存储逻辑，自动生成对应的SQL并调用JDBC接口加以执行。 大多数情况下（特别是对新项目，新系统的开发而言），这样的机制无往不利，大有一统天下的势头。但是，在一些特定的环境下，这种一站式的解决方案却未必灵光。 在笔者的系统咨询工作过程中，常常遇到以下情况： 1 系统的部分或全部数据来自现有数据库，处于安全考虑，只对开发团队提供几条Select SQL（或存储过程）以获取所需数据，具体的表结构不予公开。 2 开发规范中要求，所有牵涉到业务逻辑部分的数据库操作，必须在数据库层由存储过程实现（就笔者工作所面向的金融行业而言，工商银行、中国银行、交通银行，都在开
7、发规范中严格指定） 3 系统数据处理量巨大，性能要求极为苛刻，这往往意味着我们必须通过经过高度优化的SQL语句（或存储过程）才能达到系统性能设计指标。 面对这样的需求，再次举起Hibernate大刀，却发现刀锋不再锐利，甚至无法使用，奈何？恍惚之际，只好再摸出JDBC准备拼死一搏，说得未免有些凄凉，直接使用JDBC进行数据库操作实际上也是不错的选择，只是拖沓的数据库访问代码，乏味的字段读取操作令人厌烦。 “半自动化”的ibatis，却刚好解决了这个问题。 这里的“半自动化”，是相对 Hibernate等提供了全面的数据库封装机制的“全自动化”ORM实现而言，“全自动”ORM实现了POJO和数据
8、库表之间的映射，以及SQL的自动生成和执行。而ibatis的着力点，则在于POJO与SQL之间的映射关系。也就是说，ibatis并不会为程序员在运行期自动生成 SQL 执行。具体的 SQL 需要程序员编写，然后通过映射配置文件，将SQL所需的参数，以及返回的结果字段映射到指定POJO。 使用ibatis提供的ORM机制，对业务逻辑实现人员而言，面对的是纯粹的Java对象，这一层与通过 Hibernate 实现 ORM而言基本一致，而对于具体的数据操作，Hibernate会自动生成SQL语句，而ibatis则要求开发者编写具体的SQL语句。相对Hibernate等“全自动”ORM机制而言，iba
9、tis以SQL开发的工作量和数据库移植性上的让步，为系统设计提供了更大的自由空间。作为“全自动”ORM实现的一种有益补充，ibatis的出现显得别具意义。 IBATIS Developers Guide Version 1.0 September 2, 2004 So many open source projects. Why not Open your Documents? ibatis Quick Start 准备工作 1. 下载ibatis软件包（http:/）。 2. 创建测试数据库，并在数据库中创建一个t_user表，其中包含三个字段： id(int) name(varchar)
10、sex(int)。 3. 为了在开发过程更加直观，我们需要将ibatis日志打开以便观察ibatis运作的细节。 ibatis采用Apache common_logging，并结合Apache log4j作为日志输出组件。在CLASSPATH中新建log4j.properties配置文件，内容如下： log4j.rootLogger=DEBUG, stdout log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log
11、4j.appender.stdout.layout.ConversionPattern=%c1 - %m%n log4j.logger.java.sql.PreparedStatement=DEBUG 构建ibatis基础代码 ibatis基础代码包括： 1 ibatis实例配置 一个典型的配置文件如下（具体配置项目的含义见后）： IBATIS Developers Guide Version 1.0 September 2, 2004 So many open source projects. Why not Open your Documents? 2 POJO（Plain Ordinar
12、y Java Object） 下面是我们用作示例的一个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.0 September
13、 2, 2004 So many open source projects. 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 映射文件
14、 与Hibernate不同。因为需要人工编写SQL代码，ibatis的映射文件一般采用手动编写（通过Copy/Paste，手工编写映射文件也并没想象中的麻烦）。 针对上面POJO的映射代码如下： INSERT INTO t_user ( name, sex) VALUES ( #name#, #sex# ) delete from t_user where id = #value# 从上面的映射文件可以看出，通过、四个节点，我们分别定义了针对TUser对象的增删改查操作。在这四个节点中，我们指定了对应的SQL语句，以update节点为例： ID 指定了操作ID，之后我们可以在代码中通过指定操作
15、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
16、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方法获
17、取属性值，并用此属性值，对SQL中的参数进行填充后提交数据库执行。 此例对应的应用级代码如下，其中演示了ibatis SQLMap的基本使用方法： String resource =“com/ibatis/sample/SqlMapConfig.xml“; Reader reader; IBATIS Developers Guide Version 1.0 September 2, 2004 So many open source projects. Why not Open your Documents? reader = Resources.getResourceAsReader(reso
18、urce); XmlSqlMapClientBuilder xmlBuilder = new XmlSqlMapClientBuilder(); SqlMapClient sqlMap = xmlBuilder.buildSqlMap(reader); /sqlMap系统初始化完毕，开始执行update操作 try sqlMap.startTransaction(); User user = new User(); user.setId(new Integer(1); user.setName(“Erica“); user.setSex(new Integer(1); sqlMap.updat
19、e(“updateUser“,user); sqlMmitTransaction(); finally sqlMap.endTransaction(); 其中，SqlMapClient是ibatis运作的核心，所有操作均通过SqlMapClient实例完成。 可以看出，对于应用层而言，程序员面对的是传统意义上的数据对象，而非JDBC中烦杂的ResultSet，这使得上层逻辑开发人员的工作量大大减轻，同时代码更加清晰简洁。 数据库操作在映射文件中加以定义，从而将数据存储逻辑从上层逻辑代码中独立出来。 而底层数据操作的SQL可配置化，使得我们可以控制最终的数据操作方式，通过SQL的优化获得最佳的数据库执行效能，这在依赖SQL自动生成的“全自动”ORM机制中是所难以实现的。
