iBATIS开发指南:从入门到精通

4星 · 超过85%的资源 需积分: 22 6 下载量 15 浏览量 更新于2024-07-29 收藏 983KB PDF 举报
"ibatis开发指南(中文版).pdf 是一本详细介绍iBATIS SQL Maps的开发手册,由Clinton Begin撰写并由刘涛翻译。该指南适用于Java开发人员,旨在帮助他们理解和使用iBATIS这一轻量级的数据库访问技术。iBATIS相对于更复杂的Hibernate框架,因其简洁性和灵活性在企业应用中广泛采用。" 在本文档中,作者首先介绍了SQLMap的基本概念,阐述了SQLMap的工作原理。SQLMap是iBATIS的核心组件,负责管理SQL语句和数据映射。安装过程中,用户需要了解相关的JAR文件及依赖,并可能涉及从旧版本升级的步骤。 升级部分提到了从iBATIS 1.x到2.0的转换,包括XML配置文件的更新和新JAR文件的使用。XML配置文件包含多个关键元素,如`<properties>`用于管理外部属性文件,`<setting>`用于设置全局属性,`<typeAlias>`用于简化类名引用,`<transactionManager>`和`<datasource>`则分别用于事务管理和数据源配置,而`<sqlMap>`元素定义了具体的SQL映射文件。 SQL映射文件是iBATIS的核心,包含了各种MappedStatements,这些声明可以是SQL语句、存储过程,或者是自动生成主键的逻辑。其中,`<parameterClass>`和`<resultClass>`用于指定输入输出参数的类,`<parameterMap>`和`<resultMap>`则用于定义参数和结果的映射关系。`<inlineParameterMap>`允许内联参数,提供更便捷的调用方式。对于存储过程,可以通过`<procedure>`元素进行声明。 文档还深入探讨了不同类型的参数处理,包括基本类型、Map类型以及复杂类型。同时,ResultMap的使用,尤其是对于复杂类型属性的映射,如1:1、1:M和M:N关系的处理,是解决N+1 Select问题的关键。文中特别强调了延迟加载和联合查询在优化性能上的选择。 "ibatis开发指南(中文版).pdf"是学习和掌握iBATIS SQL Maps的重要参考资料,它详细解析了iBATIS的配置、映射和数据操作,对Java开发人员在实际项目中运用iBATIS提供了全面的指导。
2007-07-31 上传
ibatis 开发指南ibatis Quick Start............................................................................................ 5 准备工作.......................................................................................................... 5 构建ibatis 基础代码.................................................................................... 5 ibatis 配置........................................................................................................... 11 ibatis 基础语义...................................................................................................... 16 XmlSqlMapClientBuilder................................................................... 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 开发指南相对Hibernate 和Apache OJB 等“一站式”ORM 解决方案而言,ibatis 是一种“半自动化”的ORM 实现。所谓“半自动”,可能理解上有点生涩。纵观目前主流的ORM ,无论Hibernate 还是Apache OJB,都对数据库结构提供了较为完整的封装,提供了从POJO 到数据库表的全套映射机制。程序员往往只需定义好了POJO 到数据库表的映射关系,即可通过Hibernate 或者OJB 提供的方法完成持久层操作。程序员甚至不需要对SQL 的熟练掌握, Hibernate/OJB 会根据制定的存储逻辑,自动生成对应的SQL 并调用JDBC 接口加以执行。大多数情况下( 特别是对新项目,新系统的开发而言),这样的机制无往不利,大有一统天下的势头。但是,在一些特定的环境下,这种一站式的解决方案却未必灵光。在笔者的系统咨询工作过程中,常常遇到以下情况: 1. 系统的部分或全部数据来自现有数据库,处于安全考虑,只对开发团队提供几条Select SQL(或存储过程)以获取所需数据,具体的表结构不予公开。2. 开发规范中要求, 所有牵涉到业务逻辑部分的数据库操作,必须在数据库层由存储过程实现(就笔者工作所面向的金融行业而言,工商银行、中国银行、交通银行,都在开发规范中严格指定)3. 系统数据处理量巨大,性能要求极为苛刻,这往往意味着我们必须通过经过高度优化的SQL 语句(或存储过程)才能达到系统性能设计指标。面对这样的需求,再次举起Hibernate 大刀,却发现刀锋不再锐利,甚至无法使用,奈何?恍惚之际,只好再摸出JDBC 准备拼死一搏……,说得未免有些凄凉,直接使用JDBC 进行数据库操作实际上也是不错的选择,只是拖沓的数据库访问代码,乏味的字段读取操作令人厌烦。“半自动化”的ibatis,却刚好解决了这个问题。这里的“半自动化”,是相对Hibernate 等提供了全面的数据库封装机制的“全自动化”ORM 实现而言,“全自动”ORM 实现了POJO 和数据库表之间的映射,以及SQL 的自动生成和执行。而ibatis 的着力点,则在于POJO 与SQL 之间的映射关系。也就是说,ibatis 并不会为程序员在运行期自动生成SQL 执行。具体的SQL 需要程序员编写,然后通过映射配置文件,将SQL 所需的参数,以及返回的结果字段映射到指定POJO 。使用ibatis 提供的ORM 机制,对业务逻辑实现人员而言,面对的是纯粹的Java 对象, 这一层与通过Hibernate 实现ORM 而言基本一致,而对于具体的数据操作,Hibernate 会自动生成SQL 语句,而ibatis 则要求开发者编写具体的SQL 语句。相对Hibernate 等“全自动”ORM 机制而言,ibatis 以SQL 开发的工作量和数据库移植性上的让步,为系统设计提供了更大的自由空间。作为“全自动”ORM 实现的一种有益补充,ibatis 的出现显得别具意义。ibatis Quick Start 准备工作1. 下载ibatis 软件包(http://www.ibatis.com)。2. 创建测试数据库,并在数据库中创建一个t_user 表,其中包含三个字段: . id(int) . name(varchar) . 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 log4j.appender.stdout.layout.ConversionPattern=%c{1} -%m%n log4j.logger.java.sql.PreparedStatement=DEBUG 构建ibatis 基础代码ibatis 基础代码包括: 1. ibatis 实例配置一个典型的配置文件如下(具体配置项目的含义见后): <!DOCTYPE sqlMapConfigPUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN""http://www.ibatis.com/dtd/sql-map-config-2.dtd"><settingscacheModelsEnabled="true"enhancementEnabled="true"lazyLoadingEnabled="true"errorTracingEnabled="true"maxRequests="32"maxSessions="10"maxTransactions="5"useStatementNamespaces="false" /> <property name="JDBC.Driver" value="com.p6spy.engine.spy.P6SpyDriver"/> <property name="JDBC.ConnectionURL" value="jdbc:mysql://localhost/sample"/> <property name=value="10"/> <property name=value="120000"/> <property name="Pool.PingQuery" ="select 1 from ACCOUNT"/> <property name=value="1"/> <property name=value="1"/> valuevalue"Pool.MaximumActiveConnections" "Pool.MaximumIdleConnections" "Pool.MaximumCheckoutTime" valuevaluevalue"Pool.PingConnectionsOlderThan" "Pool.PingConnectionsNotUsedFor" 2. POJO(Plain Ordinary 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; } 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 的映射文件一般采用手动编写(通过Copy/Paste,手工编写映射文件也并没想象中的麻烦)。针对上面POJO 的映射代码如下:<!DOCTYPE sqlMapPUBLIC "-//iBATIS.com//DTD SQL Map 2.0//EN""http://www.ibatis.com/dtd/sql-map-2.dtd"><select id="getUser"parameterClass="java.lang.String"resultClass="user"><![CDATA[select name, sex from t_user where name = #name# ]]><update id="updateUser"parameterClass="user"> <![CDATA[UPDATE t_user SETname=#name#, sex=#sex# WHERE id = #id# ]]><insert id="insertUser"parameterClass="user">INSERT INTO t_user ( name, sex)VALUES ( #name#,#sex# ) <delete id="deleteUser"parameterClass="java.lang.String">delete from t_user where id = #value# 从上面的映射文件可以看出,通过、、、四个节点,我们分别定义了针对TUser 对象的增删改查操作。在这四个节点中,我们指定了对应的SQL 语句,以update 节点为例: ……<update id="updateUser" ⑴ parameterClass="user"> ⑵ <![CDATA[ ⑶ UPDATE t_user ⑷ SET ( IBATIS Developer’s Guide Version 1.0 name=#name#, ⑸ sex=#sex# ⑹ ) WHERE id = #id# ⑺ ]]> …… ⑴ ID 指定了操作ID,之后我们可以在代码中通过指定操作id 来执行此节点所定义的操作,如:sqlMap.update("updateUser",user); ID 设定使得在一个配置文件中定义两个同名节点成为可能(两个update 节点,以不同id 区分) ⑵ parameterClass 指定了操作所需的参数类型,此例中update 操作以com.ibatis.sample.User 类型的对象作为参数,目标是将提供的User 实例更新到数据库。parameterClass="user"中,user 为“com.ibatis.sample.User” 类的别名,别名可通过typeAlias 节点指定,如示例配置文件中的:⑶ 通过节点,可以避免SQL 中与XML 规范相冲突的字符对XML 映射文件的合法性造成影响。⑷ 执行更新操作的SQL,这里的SQL 即实际数据库支持的SQL 语句, 将由ibatis 填入参数后交给数据库执行。⑸ SQL 中所需的用户名参数,“#name#”在运行期会由传入的user 对象的name 属性填充。⑹ SQL 中所需的用户性别参数“#sex#”, 将在运行期由传入的user 对象的sex 属性填充。⑺ SQL 中所需的条件参数“#id#”, 将在运行期由传入的user 对象的id 属性填充。对于这个示例,ibatis 在运行期会读取id 为“updateUser”的update 节点的SQL 定义,并调用指定的user 对象的对应getter 方法获取属性值,并用此属性值,对SQL 中的参数进行填充后提交数据库执行。此例对应的应用级代码如下,其中演示了的基本使用方法:String resource ="com/ibatis/sample/SqlMapConfig.xml"; Reader reader; ibatis SQLMap reader = Resources.getResourceAsReader(resource); 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.update("updateUser",user); sqlMap.commitTransaction(); finally{ sqlMap.endTransaction(); } 其中,SqlMapClient 是ibatis 运作的核心,所有操作均通过SqlMapClient 实例完成。可以看出,对于应用层而言,程序员面对的是传统意义上的数据对象,而非JDBC 中烦杂的ResultSet,这使得上层逻辑开发人员的工作量大大减轻,同时代码更加清晰简洁。数据库操作在映射文件中加以定义,从而将数据存储逻辑从上层逻辑代码中独立出来。而底层数据操作的SQL 可配置化,使得我们可以控制最终的数据操作方式,通过SQL 的优化获得最佳的数据库执行效能,这在依赖SQL 自动生成的“全自动”ORM 机制中是所难以实现的。ibatis 配置结合上面示例中的ibatis 配置文件。下面是对配置文件中各节点的说明: PUBLIC "> <settings ⑴cacheModelsEnabled=enhancementEnabled=lazyLoadingEnabled=errorTracingEnabled=maxRequests=maxSessions=maxTransactions=useStatementNamespaces=/> ⑵ ⑶<property name="JDBC.Driver" value="com.p6spy.engine.spy.P6SpyDriver"/> <property name="JDBC.ConnectionURL" value="jdbc:mysql://localhost/sample"/> <property name=value="10"/> <property name=value="120000"/> <property name="Pool.PingQuery" ="select 1 from ACCOUNT"/> <property name=value="1"/> <property name=value="1"/> <!DOCTYPE sqlMapConfig "-//iBATIS.com//DTD SQL Map Config 2.0//EN" "http://www.ibatis.com/dtd/sql-map-config-2.dtd"true" "true" "true" "true" "32" "10" "5" "false" valuevalue"Pool.MaximumActiveConnections" "Pool.MaximumIdleConnections" "Pool.MaximumCheckoutTime" valuevaluevalue"Pool.PingConnectionsOlderThan" "Pool.PingConnectionsNotUsedFor" ⑷ ⑴ Settings 节点参数描述cacheModelsEnabled 是否启用SqlMapClient 上的缓存机制。建议设为"true" enhancementEnabled 是否针对POJO 启用字节码增强机制以提升getter/setter 的调用效能,避免使用Java Reflect 所带来的性能开销。同时,这也为Lazy Loading 带来了极大的性能提升。建议设为"true" errorTracingEnabled 是否启用错误日志,在开发期间建议设为"true" 以方便调试lazyLoadingEnabled 是否启用延迟加载机制,建议设为"true" maxRequests 最大并发请求数(Statement 并发数) maxTransactions 最大并发事务数maxSessions 最大Session 数。即当前最大允许的并发SqlMapClient 数。maxSessions 设定必须介于maxTransactions 和maxRequests 之间,即maxTransactions<maxSessions=< maxRequests useStatementNamespaces 是否使用Statement 命名空间。这里的命名空间指的是映射文件中,sqlMap 节点的namespace 属性,如在上例中针对t_user 表的映射文件sqlMap 节点: 这里,指定了此sqlMap 节点下定义的操作均从属于"User"命名空间。在useStatementNamespaces="true"的情况下,Statement 调用需追加命名空间,如:⑵ transactionManager 节点sqlMap.update("User.updateUser",use r); 否则直接通过Statement 名称调用即sqlMap.update("updateUser",user); 但请注意此时需要保证所有映射定义无重名。可,如:文件中,Statement transactionManager 节点定义了ibatis 的事务管理器,目前提供了以下几种选择: . JDBC 通过传统JDBC Connection.commit/rollback 实现事务支持。. JTA 使用容器提供的JTA 服务实现全局事务管理。. EXTERNAL 外部事务管理, 如在EJB 中使用ibatis,通过EJB 的部署配置即可实现自动的事务管理机制。此时ibatis 将把所有事务委托给外部容器进行管理。此外,通过Spring 等轻量级容器实现事务的配置化管理也是一个不错的选择。关于结合容器实现事务管理,参见“高级特性”中的描述。⑶ dataSource 节点dataSource 从属于transactionManager 节点,用于设定ibatis 运行期使用的DataSource 属性。type 属性: dataSource 节点的type属性指定了dataSource 的实现类型。可选项目: . SIMPLE: SIMPLE 是ibatis 内置的dataSource 实现,其中实现了一个简单的数据库连接池机制,对应ibatis 实现类为com.ibatis.sqlmap.engine.datasource.SimpleDataSourceFactory 。. DBCP: 基于Apache DBCP 连接池组件实现的DataSource 封装,当无容器提供DataSource 服务时,建议使用该选项,对应ibatis 实现类为com.ibatis.sqlmap.engine.datasource.DbcpDataSourceFactory 。. JNDI: 使用J2EE 容器提供的DataSource 实现,DataSource 将通过指定的JNDI Name 从容器中获取。对应ibatis 实现类为com.ibatis.sqlmap.engine.datasource.JndiDataSourceFacto ry。dataSource 的子节点说明(SIMPLE