MyBatis xml配置文件详解

MyBatis xml配置文件详解

一、MyBatis 配置文件基本结构

在使用mybatis框架时，首先导入其对应的jar包，并进行相应的配置，所以得对配置文件的每个参数都得了解。一个完全的mybatis配置文件结构如下：

[html] view plain copy

PUBLIC "-//https://www.wendangku.net/doc/f517966957.html,//DTD Config 3.0//EN"

"https://www.wendangku.net/doc/f517966957.html,/dtd/mybatis-3-config.dtd">

properties

properties元素主要是用来定义配置外在化，比如数据库的连接属性等。这些属性都是可外部配置且可动态替换的，既可以在典型的Java属性文件中配置，亦可以通过properties元素的子元素来传递。例如：

[html] view plain copy

其中的属性就可以在整个配置文件中使用来替换需要动态配置的属性值。比如在数据源中使用的例子：

[html] view plain copy

这个例子中的username和password将会由properties元素中设置的相应值来替换。driver和url属性将会由config.properties文件中对应的值来替换。这样就为配置提供了诸多灵活选择。属性也可以被传递到SqlSessionBuilder.build()方法中。例如：

[html] view plain copy

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

// ... or ...

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

但是，这也就涉及到了优先级的问题，如果属性不只在一个地方配置，那么mybatis将会按照下面的顺序来加载：

在properties元素体内指定的属性首先被读取。

然后根据properties元素中的resource属性读取类路径下属性文件或根据url属性指定的路径读取属性文件，并覆盖已读取的同名属性。

最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url属性中指定的配置文件次之，最低优先级的是properties属性中指定的属性。settings

setting是指定MyBatis的一些全局配置属性，这是MyBatis中极为重要的调整设置，它们会改变MyBatis的运行时行为，所以我们需要清楚的知道这些属性的作用及默认值。

设置参数描述有效值默认值

cacheEnabled 该配置影响的所有映射器中配置的缓存的全局开关true | false true

lazyLoadingEnabled 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置fetchType属性来覆盖该项的开关状态 true | false false

aggressiveLazyLoading 当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载。true | false true

multipleResultSetsEnabled 是否允许单一语句返回多结果集（需要兼容驱动）。 true | false true

useColumnLabel 使用列标签代替列名。不同的驱动在这方面会有不同的表现，具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。true | false true

useGeneratedKeys 允许JDBC 支持自动生成主键，需要驱动兼容。如果设置为true 则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如Derby）。true | false False

autoMappingBehavior 指定MyBatis 应如何自动映射列到字段或属性。NONE 表示取消自动映射；PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。FULL 会自动映射任意复杂的结果集（无论是否嵌套）。NONE, PARTIAL, FULL PARTIAL

defaultExecutorType 配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（prepared statements）；BATCH 执行器将重用语句并执行批量更新。SIMPLE REUSE BATCH SIMPLE

defaultStatementTimeout 设置超时时间，它决定驱动等待数据库响应的秒数。Any positive integer Not Set (null)

defaultFetchSize Sets the driver a hint as to control fetching size for return results. This parameter value can be override by a query setting. Any positive integer Not Set (null)

safeRowBoundsEnabled 允许在嵌套语句中使用分页（RowBounds）。t rue | false False

mapUnderscoreToCamelCase 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名A_COLUMN 到经典Java 属性名aColumn 的类似映射。true | false False

localCacheScope MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。默认值为SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为STATEMENT，本地会话仅用在语句执行上，对相同SqlSession 的不同调用将不会共享数据。SESSION | STATEMENT SESSION

jdbcTypeForNull 当没有为参数提供特定的JDBC 类型时，为空值指定JDBC 类型。某些驱动需要指定列的JDBC 类型，多数情况直接用一般类型即可，比如NULL、VARCHAR 或OTHER。JdbcType enumeration. Most common are: NULL, VARCHAR and OTHER OTHER lazyLoadTriggerMethods 指定哪个对象的方法触发一次延迟加载。 A method name list separated by commas equals,clone,hashCode,toString

defaultScriptingLanguage 指定动态SQL 生成的默认语言。 A type alias or fully qualified class name.

org.apache.ibatis.scripting.xmltags.XMLDynamicLanguageDriver

callSettersOnNulls 指定当结果集中值为null 的时候是否调用映射对象的setter（map 对象时为put）方法，这对于有Map.keySet() 依赖或null 值初始化的时候是有用的。注意基本类型（int、boolean等）是不能设置成null 的。true | false false

logPrefix 指定MyBatis 增加到日志名称的前缀。Any String Not set

logImpl 指定MyBatis 所用日志的具体实现，未指定时将自动查找。SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING Not set

proxyFactory 指定Mybatis 创建具有延迟加载能力的对象所用到的代理工具。CGLIB | JAVASSIST JAVASSIST (MyBatis 3.3 or above)

一个完整的settings元素示例如下：

[html] view plain copy

typeAliases

类型别名是为Java类型设置一个短的名字。它只和xml配置有关，存在的意义仅在于用来减少类完全限定名的冗余，例如：

[html] view plain copy

当这样配置时，Blog可以用在任何使用domain.blog.Blog的地方。

也可以指定一个包名，MyBatis会在包名下搜索需要的JavaBean，比如：

[html] view plain copy

每一个在包domain.blog中的JavaBean，在没有注解的情况下，会使用Bean的首字母小写的非限类名来作为它的别名。比如domain.blog.Author的别名为author；若有注解，则别名为注解值。看下面的例子：

[html] view plain copy

@Alias("author") public class Author

{

...}

已经为许多常见的Java类型内建了相应的类型别名。它们都是大小写不敏感的，需要注意的是有基本类型名称重复导致的特殊处理。

别名映射的类型

_byte byte

_long long

_short short

_int int

_integer int

_double double

_float float

_boolean boolean

string String

byte Byte

long Long

short Short

int Integer

integer Integer

double Double

float Float

boolean Boolean

date Date

decimal B igDecimal

bigdecimal BigDecimal

object Object

map Map

hashmap HashMap

list List

arraylist ArrayList

collection Collection

iterator Iterator

typeHandlers

无论是MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成Java 类型。下表描述了一些默认的类型处理器。

类型处理器Java 类型JDBC 类型

BooleanTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Boolean, boolean 数据库兼容的BOOLEAN

ByteTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Byte, byte 数据库兼容的NUMERIC 或BYTE

ShortTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Short, short 数据库兼容的NUMERIC 或SHORT INTEGER

IntegerTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Integer, int 数据库兼容的NUMERIC 或INTEGER

LongTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Long, long 数据库兼容的NUMERIC 或LONG INTEGER

FloatTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Float, float 数据库兼容的NUMERIC 或FLOAT

DoubleTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.Double, double 数据库兼容的NUMERIC 或DOUBLE

BigDecimalTypeHandler j ava.math.BigDecimal 数据库兼容的NUMERIC 或DECIMAL

StringTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.String CHAR, VARCHAR

ClobTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.String CLOB, LONGVARCHAR

NStringTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.String NVARCHAR, NCHAR

NClobTypeHandler https://www.wendangku.net/doc/f517966957.html,ng.String NCLOB

ByteArrayTypeHandler byte[] 数据库兼容的字节流类型

BlobTypeHandler byte[] BLOB, LONGVARBINARY

DateTypeHandler java.util.Date TIMESTAMP

DateOnlyTypeHandler java.util.Date DATE

TimeOnlyTypeHandler java.util.Date TIME

SqlTimestampTypeHandler java.sql.Timestamp TIMESTAMP

SqlDateTypeHandler java.sql.Date DATE

SqlTimeTypeHandler java.sql.Time TIME

ObjectTypeHandler Any OTHER 或未指定类型

EnumTypeHandler Enumeration Type VARCHAR-任何兼容的字符串类型，存储枚举的名称（而不是索引）

EnumOrdinalTypeHandler Enumeration Type 任何兼容的NUMERIC 或DOUBLE 类型，存储枚举的索引（而不是名称）。

可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。具体的做法为：实现org.apache.ibatis.type.TypeHandler接口，或继承一个很便利的类org.apache.ibatis.type.BaseTypeHandler,然后可以选择性地将它映射到一个JDBC类型。比如：

[html] view plain copy

//

ExampleTypeHandler.java

@MappedJdbcTypes(JdbcType.VARCHAR) public class ExampleTypeHandler extends BaseTypeHandler

{

@Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException

{ ps.setString(i,

parameter)

;

}

@Override public String getNullableResult(ResultSet rs, String columnName) throws SQLException

{ return

rs.getString(columnName)

;

}

@Override public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException

{ return

rs.getString(columnIndex)

;

}

@Override public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException

{ return

cs.getString(columnIndex);

}}

并且还需要在配置文件里面加上：

[html] view plain copy

使用这个的类型处理器将会覆盖已经存在的处理Java的String类型属性和VARCHAR参数及结果的类型处理器。要注意MyBatis不会窥探数据库元信息来决定使用哪种类型，所以必须在参数和结果映射中指明是VARCHAR类型字段，以使其能绑定到正确的类型处理器上。这是因为，MyBatis直到语句被执行才清楚数据类型。

通过类型处理器的泛型，MyBatis可以得知该类型处理器的Java类型，不过这种行为可以通过两种方法改变：

在类型处理器的元素（typeHandler element）上增加一个javaType属性（比如，javaType="String"）;

在类型处理器的类上（TypeHandler class）增加一个@MappedTypes注解来指定与其关联的Java类型列表。如果在javaType属性中也同时制定，则注解方式将被忽略。

可以通过两种方式来指定被关联的JDBC类型：

在类型处理器的配置元素上增加一个javaType属性（比如：javaType="VARCHAR"）;

在类型处理器的类上（TypeHandler class）增加一个@MappedJdbcTypes注解来指定与其关联的JDBC类型列表。如果在javaType属性中也同时指定，则注解方式将被忽略。

最后，还可以让MyBatis查找类型处理器：

[html] view plain copy

注意在使用自动检索（autodiscovery）功能的时候，只能通过注解的方式来指定JDBC类型。

你能创建一个泛型类型处理器，它可以处理多于一个类。为达到此目的，需要增加一个接收该类作为参数的构造器，这样在构造一个类型处理器的时候MyBatis就会传入一个具体的类。

[html] view plain copy

//GenericTypeHandler.java public class GenericTypeHandler extends BaseTypeHandler

{ private Class

type; public GenericTypeHandler(Class type){

if (type == null) throw new IllegalArgumentException("Type argument cannot be null");

this.type =

type;}

...

EnumTypeHandler和EnumOrdinalTypeHandler都是泛型处理器（generic TypeHandlers），接下来的部分详细探讨。

处理枚举类型

若想映射枚举类型Enum，则需要从EnumTypeHandler或者EnumOrdinalTypeHandler中选一个来使用

比如说我们想存储近似值时用到的舍入模式。默认情况下，MyBatis会利用EnumTypeHandler来把Enum值转换成对应的名字。

注意EnumTypeHandler在某种意义上来说是比较特别的，其他的处理器只针对某个特定的类，而它不同，它会处理任意继承了Enum的类。

不过，我们可能不想存储名字，相反我们的DBA会坚持使用整形值代码。那也一样轻而易举；在配置文件中把EnumOrdinalTypeHandler加到typeHandlers中即可，这样每个RoundingMode将通过他们的序数值来映射成对应的整形。

[html] view plain copy

但是怎么样能将同样的Enum既映射成字符串又映射成整形呢？

自动映射器（auto-mapper）会自动选用EnumOrdinalTypeHandler来处理，所以如果我们想用普通的EnumTypeHandler，就非要为那些SQL语句显示地设置要用到的类型处理器不可。

[html] view plain copy

PUBLIC "-//https://www.wendangku.net/doc/f517966957.html,//DTD Mapper 3.0//EN"

"https://www.wendangku.net/doc/f517966957.html,/dtd/mybatis-3-mapper.dtd">

select * from users

"insert"> insert into users (id, name, funkyNumber, roundingMode) values

( #{id}, #{name}, #{funkyNumber},

#{roundingMode})

select * from users2

"insert2"> insert into users2 (id, name, funkyNumber, roundingMode) values(

#{id}, #{name}, #{funkyNumber}, #{roundingMode, typeHandler=

org.apache.ibatis.type.EnumTypeHandler})

注意，这里的select语句强制使用resultMap来代替resultType。

对象工厂（objectFactory）

MyBatis每次创建结果对象的新实例时，它都会使用一个对象工厂（ObjectFactory）实例来完成。默认的对象工厂需要做的仅仅是实例化目标类，要么通过默认构造方法，要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的行为，则可以通过创建自己的对象工厂来实现，比如：

[html] view plain copy

//

xampleObjectFactory.java public class ExampleObjectFactory extends DefaultObjectFactory

{ public Object create(Class type)

{ return

super.create(type);

} public Object create(Class type, List constructorArgTypes, List