ibatis 3 学习笔记

ibatis 3 学习笔记1

前段时间看了oracle内容，干脆把ibatis结合oracle一块搞了。

准备ibatis环境

oracle 10g express ibatis beta 5

新建工程 在WEBINF\lib下 导入以下包：

..\oraclexe\app\oracle\product\10.2.0\server\jdbc\lib\ojdbc14.jar ibatis-3-core-3.0.0.208.jar

总配置文件SqlMapConfig.xml

-//https://www.360docs.net/doc/cd6918715.html,//DTD Config 3.0//EN"

"https://www.360docs.net/doc/cd6918715.html,/dtd/ibatis-3-config.dtd">

关于每个实体的映射文件（map）Student.xml

PUBLIC "-//https://www.360docs.net/doc/cd6918715.html,//DTD Mapper 3.0//EN"

"https://www.360docs.net/doc/cd6918715.html,/dtd/ibatis-3-mapper.dtd">

select * from Student where id = #{id}

创建Student POJO

package cn.pf.ibatis.domain;

import java.util.Date;

/**

* 学生PO

* @author pf

* @version 2010-3-16下午03:00:00

*/

public class Student {

/**

* 学生编号

*/

private int id;

/**

* 学生姓名

*/

private String name;

/**

* 学生专业

*/

private String major;

/**

* 学生生日

*/

private Date birth;

/**

* 学生分数

*/

private double score;

/**

* ... 构造函数

*/

public Student() {

super();

}

/**

* ... 构造函数

* @param id

* @param name

* @param major

* @param birth

* @param score

*/

public Student(int id, String name, String major, Date birth, double score) {

super();

this.id = id;

https://www.360docs.net/doc/cd6918715.html, = name;

this.major = major;

this.birth = birth;

this.score = score; }

/**

* id getter 方法

* @return the id

*/

public int getId() {

return id;

}

/**

* id setter 方法

* @param id the id to set */

public void setId(int id) {

this.id = id;

}

/**

* name getter 方法

* @return the name

*/

public String getName() {

return name;

}

/**

* name setter 方法

* @param name the name to set

*/

public void setName(String name) {

https://www.360docs.net/doc/cd6918715.html, = name;

}

/**

* major getter 方法

* @return the major

*/

public String getMajor() {

return major;

}

/**

* major setter 方法

* @param major the major to set

*/

public void setMajor(String major) { this.major = major;

}

/**

* birth getter 方法

* @return the birth

*/

public Date getBirth() {

return birth;

}

/**

* birth setter 方法

* @param birth the birth to set

*/

public void setBirth(Date birth) {

this.birth = birth;

}

/**

* score getter 方法

* @return the score

*/

public double getScore() {

return score;

}

/**

* score setter 方法

* @param score the score to set

*/

public void setScore(double score) { this.score = score;

}

/**

* 转换对象为字符串

* @return 对象转换后的字符串

* @see https://www.360docs.net/doc/cd6918715.html,ng.Object#toString() */

@Override

public String toString() { +return "Student [birth=" + birth + ", id=" + id + ", major=" + major ", name=" + name + ", score=" + score + "]"; }

}

test.java

String resource = "SqlMapConfig.xml "; Reader reader = null ; try { //使用ibatis 提供的Resources 类读取资源文件 reader = Resources.getResourceAsReader(resource); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); }

//根据资源文件内容建立session 工厂

SqlSessionFactory sqlMapper = new SqlSessionFactoryBuilder().build(reader);

//session工厂打开一个session

SqlSession session = sqlMapper.openSession(true);

Student student;

try{

student = (Student)session.selectOne("cn.pf.ibatis.domain.StudentMapper.selectStudent", 1);

}finally{

session.close();

}

System.out.println(student.toString());

ibatis 3 果然改动很大，调试花了不少时间，很多细小的错误耽误了很久。那个ibatis 3 user guide缺少完整的实例真是不爽，自己一点点试探过来，继续研究各种配置，下一步完成一个基本的crud操作。

上篇简单调试了一个实例，现在仔细看看ibatis 3 user guide上的内容，接下来的几篇准备整理user guide上的内容，最后通过一个综合的例子来实践。

关于实体映射文件中namespace，以前的版本是可选的内容，现在被用来与接口绑定，也就是说把接口的实现转移到xml文件中来了，以后的维护会相当的方便。

第一篇的根据id查询学生的例子中，稍做修改：

建立StudentDAO接口

package cn.pf.ibatis.dao;

import java.util.List;

import cn.pf.ibatis.domain.Student;

/**

* StudentDAO接口

* @author pf

* @version 2010-3-16下午03:05:36

*/

public interface StudentDAO {

public Student queryStudentById(int id);

}

更改 student.xml中的mapper元素namespace属性

test.java中调用改为

Student student;

StudentDAO studentDAO = session.getMapper(StudentDAO.class); try{

//student = (Student)session.selectOne("cn.pf.ibatis.domain.StudentMapper.selectStudent", 1);

student = studentDAO.queryStudentById(1);

}finally{

session.close();

}

System.out.println(student.toString());

生命周期

SqlSessionFactoryBuilder：

用于建立SqlSessionFactory的工具类，在创建SqlSessionFactory以后无需再让它存在于应用程序中，文档上说它的生命周期最好在局部方法内，所以在代码中看到

//根据资源文件内容建立session工厂

SqlSessionFactory sqlMapper = new SqlSessionFactoryBuilder().build(reader);

没用引用指向SqlSessionFactoryBuilder，会被gc回收。

SqlSessionFactory：

一旦建立，SqlSessionFactory就应该存在于整个应用程序生命周期，因为根据 资源文件建立SqlSessionFactory对象需要很大的开销，所以保留在整个应用的生命周期中，最佳实践中推荐使用spring等依赖注入的框架 从而管理SqlSessionFactory的单例生命周期。

SqlSession：

每一个线程都应该有自己的SqlSession对象，SqlSession对象不是线程安全的所以不应该被 共享，如果使用web框架，应该将SqlSession的生命周期看作HTTP Request的生命周期，在返回HTTP Response的时候关闭SqlSession

SqlSession session = sqlSessionFactory.openSession();

try {

// do work

} finally {

session.close();

}

Mapper Instances:

Mapper Instances是绑定ibatis映射文件实现的接口，Mapper Instances的生命周期应该与SqlSession一样，但是Mapper Instances 最好在一个方法中被创建，在方法结束时被销毁。

SqlSession session = sqlSessionFactory.openSession();

try {

BlogMapper mapper = session.getMapper(BlogMapper.class);

// do work

} finally {

session.close();

}

配置文件

配置文件的层次结构如下：

? configuration

o properties

o settings

o typeAliases

o typeHandlers

o objectFactory

o plugins

o environments

environment

? transactionManager

? dataSource

o mappers

1 properties：

用来定义外部properties配置文件信息。比如

properties>

…

dataSource>

那么username和password被替换成dev_user和F2Fa3!33TYyg，而drive和url属性将读取config.properties中的内容从而取得具体值

properties还可以通过SqlSessionFactoryBuilder的build方法作为参数传入:

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, props);

// ... or ...

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, props);

property加载顺序：

1、properties元素内部

2、外部properties文件

3、SqlSessionFactoryBuilder的build方法参数

也就是说，build方法参数中的properties优先级高于前两个，因为它是最后被加载，所以会覆盖前两种加载方法加载的properties 值。

2 settings

Setting描述合法值默认值

cacheEnabled 是否使用全局缓存 true|false true

lazyLoadingEnabled 是否使用全局懒加载 true|false true

multipleResultSetsEnabled 是否允许返回多个结果集合（需要兼容的驱动） true|false true

useColumnLabel 使用列标签取代列名（不同驱动表现不同） true|false true

useGeneratedKeys 允许jdbc自动生成主键 true|false false

enhancementEnabled（该属性在测试的时候报错，提示不存在，查阅资料好像文档里写错全局性地启用或禁用运行时字节码增强，以优化enhancementEnabled访问Java Bean属性的性能，

同时优化延迟加载的性能。

true|false false

了，这个属性已经取消） defaultExecutorType

配置默认执行方式 SIMPLE： nothing special REUSE： reuses prepared statemets BATCH：reuses statements and batches updates

SIMPLE REUSE BATCH SIMPLE

defaultStatementTimeout 数据库超时时间

Any positive integer

Not Set (null) 例子：

cacheEnabled" value="true "/>

lazyLoadingEnabled" value="true "/>

multipleResultSetsEnabled" value="true "/> useColumnLabel" value="true "/> useGeneratedKeys" value="false "/> enhancementEnabled" value="false "/> defaultExecutorType" value="SIMPLE "/> defaultStatementTimeout" value="25000"/> 3 typeAliases java 类别名

typeAliases>

4 typeHandlers

Type Handler Java Types JDBC Types

BooleanTypeHandler Boolean,boolean Any compatible BOOLEAN ByteTypeHandler Byte,byte Any compatible NUMERIC or BYTE

ShortTypeHandler Short,short Any compatible NUMERIC or SHORT

INTEGER

IntegerTypeHandler Integer,int Any compatible NUMERIC or INTEGER LongTypeHandler Long,long Any compatible NUMERIC or LONG INTEGER FloatTypeHandler Float,float Any compatible NUMERIC or FLOAT DoubleTypeHandler Double,double Any compatible NUMERIC or DOUBLE BigDecimalTypeHandler BigDecimal Any compatible NUMERIC or DECIMAL StringTypeHandler String CHAR,VARCHAR

ClobTypeHandler String CLOB,LONGVARCHAR NStringTypeHandler String NVARCHAR,NCHAR

NClobTypeHandler String NCLOB

ByteArrayTypeHandler byte[] Any compatible byte stream type BlobTypeHandler byte[] BLOB,LONGVARBINARY DateTypeHandler Date(java.util) TIMESTAMP

DateOnlyTypeHandler Date(java.util) DATE

TimeOnlyTypeHandler Date(java.util) TIME

SqlTimestampTypeHandler Timestamp(java.sql)TIMESTAMP

SqlDateTypeHadler Date(java.sql) DATE

SqlTimeTypeHandler Time(java.sql) TIME

ObjectTypeHandler Any OTHER,or unspecified

EnumTypeHandler Enumeration Type VARCHAR – any string compatible

type,as the code is stored(not the

index)

也可以通过实现TypeHandler接口来实现自定义的类型转换器

// ExampleTypeHandler.java

public class ExampleTypeHandler implements TypeHandler {

public void setParameter(

PreparedStatement ps, int i, Object parameter,JdbcType jdbcType) throws SQLException {

ps.setString(i, (String) parameter);

}

public Object getResult(

ResultSet rs, String columnName)

throws SQLException {

return rs.getString(columnName);

}

public Object getResult(

CallableStatement cs, int columnIndex)

throws SQLException {

return cs.getString(columnIndex);

}

}

// MapperConfig.xml

String" jdbcType="VARCHAR"

handler="org.apache.ibatis.example.ExampleTypeHandler"/>

这样会覆盖原来ibatis默认的string varchar转换器

5 objectFactory

ibatis使用objectFactory去创建result object的实例对象,这里可以自己继承DefaultObjectFactory类实现自己的ObjectFactory

// ExampleObjectFactory.java

public class ExampleObjectFactory extends DefaultObjectFactory {

public Object create(Class type) {

return super.create(type);

}

public Object create(

Class type,

List constructorArgTypes,

List<> constructorArgs) {

return super.create(type, constructorArgTypes, constructorArgs);

}

public void setProperties(Properties properties) {

super.setProperties(properties);

}

}

// MapperConfig.xml

org.apache.ibatis.example.ExampleObjectFactory">

someProperty" value="100"/>

6 plugins

ibatis允许插件截断以下方法调用

Executor(update,query,flushStatements,commit,rollback,getTransaction,close,isClosed) ParameterHandler(getParameterObject,setParameters)

ResultSetHandler(handleResultSets,handleOutputParameters)

StatementHandler(prepare,parameterize,batch,update,query)

必须在理解这些方法的基础上很小心的使用插件，不然很容易破坏ibatis的核心

// ExamplePlugin.java

@Intercepts({@Signature(

type= Executor.class,

method = "update",

args = {MappedStatement.class,Object.class})})

public class ExamplePlugin implements Interceptor {

public Object intercept(Invocation invocation) throws Throwable {

return invocation.proceed();

}

public Object plugin(Object target) {

return Plugin.wrap(target, this);

}

public void setProperties(Properties properties) {

}

}

// MapperConfig.xml

org.apache.ibatis.example.ExamplePlugin">

someProperty" value="100"/>

7 environments

这个是ibatis 3非常好的一个配置，允许配置多个不懂运行环境参数，不过每个SqlSessionFactory只可以在一种环境下被创建。 利用SqlSessionFactory的build函数

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,environment);

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader,environment,properties);