MyBatis3.2.2中文官方文档

MyBatis用户指南中文版

version 3.2.2

MyBatis用户指南中文版

最近更新: 02 四月2013

Version: 3.2.2PDF Creator :Esin.z2013/04/10内容目录1简介........................................................................3什么是 MyBatis?...........................................................3Help make this documentation better….....................................3关于翻译..................................................................3入门........................................................................3从 XML 中构建 .3不使用 XML 构建 4从 SqlSessionFactory 中获取 .5探究已映射的 SQL 语句.....................................................5范围和生命周期............................................................7XML 映射配置文件.............................................................25Mapper XML 文件............................................................26

Copyright © 2010-2013 g . All Rights Reserved. 1/79

MyBatis用户指南中文版

version 3.2.2

27insert, update 49缓存.....................................................................50动态 53choose, when, 53trim, where, 56Multi-db 57Pluggable Scripting Languages For 58应用目录结构.............................................................77

Copyright © 2010-2013 g . All Rights Reserved. 2/79

MyBatis用户指南中文版

version 3.2.2

简介什么是 MyBatis?MyBatis

是支持普通

SQL

查询,存储过程和高级映射的优秀持久层框架。MyBatis

消除 了几乎所有的

JDBC

代码和参数的手工设置以及结果集的检索。MyBatis

使用简单的

XML

或注解用于配置和原始映射,将接口和

Java

的

POJOs(Plan Old Java Objects,普通的

Java

对象)映射成数据库中的记录。

Help make this documentation better…如果你发现了本文档的遗漏之处,

或者丢失

MyBatis

特性的说明时,

那么最好的方法就 是了解一下这个遗漏之处然后把它记录下来。

Sources of this manual are available in xdoc format at project's GitHub . Check

them out, update them and send your patch to the tracker .

你也是本文档的最佳作者,其他用户也会来阅读它的。

关于翻译MyBatis 3

的用户指南翻译由南磊完成,若对翻译质量有任何意见和建议,请联系

nanlei1987@,愿和大家共同提高,共同进步。

入门每 一 个

MyBatis

的 应 用 程 序 都 以 一 个

SqlSessionFactory

对 象 的 实 例 为 核 心 。SqlSessionFactory

对 象 的 实 例 可 以 通 过

SqlSessionFactoryBuilder

对 象 来 获 得 。

SqlSessionFactoryBuilder

对象可以从

XML

配置文件,或从

Configuration

类的习惯准备的实例中构建

SqlSessionFactory

对象。

从 XML 中构建 SqlSessionFactory从

XML

文件中构建

SqlSessionFactory

的实例非常简单。这里建议你使用类路径下的资 源文件来配置,但是你可以使用任意的

Reader

实例,这个实例包括由文字形式的文件路径 或

URL

形式的文件路径

file://来创建。MyBatis

包含了一些工具类,称作为资源,这些工具 类包含一些方法,这些方法使得从类路径或其他位置加载资源文件更加简单。

Copyright © 2010-2013 g . All Rights Reserved. 3/79

MyBatis用户指南中文版

version 3.2.2

String resource = "org/mybatis/example/";InputStream inputStream = ourceAsStream(resource);sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);XML

配置文件包含对

MyBatis

系统的核心设置,包含获取数据库连接实例的数据源和 决定事务范围和控制的事务管理器。关于

XML

配置文件的详细内容可以在文档后面找到,

这里给出一个简单的示例:

当然, XML

配置文件中还有很多可以配置的,

在 上面的示例指出的则是最关键的部分。 要注意

XML

头部的声明,需要用来验证

XML

文档正确性。environment

元素体中包含对事 务管理和连接池的环境配置。

mappers

元素是包含所有

mapper

映射器) (

的列表,

这些

mapper

的

XML

文件包含

SQL代码和映射定义信息。

不使用 XML 构建 SqlSessionFactory如果你喜欢从

Java

程序而不是

XML

文件中直接创建配置实例,

或创建你自己的配置构 建器,MyBatis

也提供完整的配置类,提供所有从

XML

文件中加载配置信息的选项。

DataSource dataSource = gDataSource();TransactionFactory transactionFactory = new JdbcTransactionFactory();Environment environment = new Environment("development", transactionFactory, dataSource);Configuration configuration = new Configuration(environment);per();SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);注意这种情况下配置是添加映射类。映射类是

Java

类,这些类包含

SQL

映射语句的注 解从而避免了

Copyright © 2010-2013 g . All Rights Reserved. 4/79

MyBatis用户指南中文版

version 3.2.2

XML

文件的依赖, XML

映射仍然在大多数高级映射

(比如:

嵌套

Join

映射)

时需要。出于这样的原因,如果存在

XML

配置文件的话,MyBatis

将会自动查找和加载一 个对等的

XML

文件(这种情况下,基于类路径下的

类的类名,那么

将会被加载)。后面我们会了解更多。

从 SqlSessionFactory 中获取 SqlSession现在,我们已经知道如何获取

SqlSessionFactory

对象了,基于同样的启示,我们就可以 获得

SqlSession

的实例了。

SqlSession

对象完全包含以数据库为背景的所有执行

SQL

操作的 方法。你可以用

SqlSession

实例来直接执行已映射的

SQL

语句。例如:

SqlSession session = ssion();try { Blog blog = (Blog) One("Blog", 101);} finally { ();}这种方法起到的作用,

和我们使用之前的

MyBatis

版本是相似的,

现在有一种更简洁的 方法。使用合理描述参数和

SQL

语句返回值的接口(比如

) ,这样现在就 可以至此那个更简单,更安全的代码,没有容易发生的字符串文字和转换的错误。

例如:

SqlSession session = ssion();try { BlogMapper mapper = per(); Blog blog = Blog(101);} finally { ();}现在我们来探究一下这里到底执行了什么。

探究已映射的 SQL 语句这里你也许想知道通过

SqlSession

和

Mapper

对象到底执行了什么操作。已映射的

SQL

语句是一个很大的主题,

而且这个主题会贯穿本文档的大部分内容。 为了给出一个宏观的概 念,这里有一些示例。 上面提到的任何一个示例,语句是通过

XML

或注解定义的。我们先来看看

XML。使 用基于

XML

的映射语言,在过去的几年中使得

MyBatis

非常流行,他为

MyBatis

提供所有 的特性设置。如果你以前用过

MyBatis,这个概念应该很熟悉了,但是

XML

映射文件也有 很多的改进,后面我们会详细来说。这里给出一个基于

XML

映射语句的示例,这些语句应 该可以满足上述示例中

SqlSession

对象的调用。

Copyright © 2010-2013 g . All Rights Reserved. 5/79

MyBatis用户指南中文版

version 3.2.2

select * from Blog where id = #{id} 这个简单的例子中看起来有很多额外的东西,

但是也相当简洁了。 你可以在一个单独的

XML

映射文件中定义很多的映射语句,除

XML

头部和文档类型声明之外,你可以得到很 多 方 便 之 处 。 在 文 件的 剩 余 部 分 是 很 好 的 自 我 解 释 。 在 命 名 空 间

“pper”中,它定义了一个名为“selectBlog”的映射语句,这 样它允许你使用完全限定名 “Blog”

来调用映射语句,

我们下面示例中所有的写法也是这样的。

Blog blog = (Blog) One("Blog", 101);要注意这个使用完全限定名调用

Java

对象的方法是相似的,这样做是有原因的。这个 命名可以直接给相同命名空间下的的映射类,

使用一个名称,

参数和返回值和已映射的查询 语句都一样的方法即可。

这就允许你非常容易地调用映射器接口中的方法,

这和你前面看到 的是一样的,下面这个示例中它又出现了。

BlogMapper mapper = per();Blog blog = Blog(101);第二种方式有很多有点,首先它不是基于文字的,那就更安全了。第二,如果你的

IDE

有代码补全功能,那么你可以利用它来操纵已映射的

SQL

语句。第三,不需要强制类型转 换,同时

BlogMapper

接口可以保持简洁,返回值类型很安全(参数类型也很安全)

。

重要 命名空间的一点注释

命名空间 在之前版本的

MyBatis

中是可选项,非常混乱也没有帮助。现在,命名空间 是必须的,而且有一个目的,它使用更长的完全限定名来隔离语句。

命名空间使得接口绑定成为可能,就像你看到的那样,如果之前不了解,那么现在你 就会使用它们了,你应该按照下面给出示例的来练习,以免改变自己的想法。使用命名空 间,并将它放在合适的

Java

包空间之下,将会使你的代码变得简洁,在很长的时间内提高

MyBatis

的作用。

命名解析:

为了减少输入量,MyBatis

对所有的命名配置元素使用如下的命名解析规 则,包括语句,结果映射,缓存等。

•直接查找完全限定名(比如“AllThings”,如果

)

发现就使用。

•短名称(比如“selectAllThings” )可以用来引用任意含糊的对象。而如果有两个 或两个以上的(比如“AllThings ”和“AllThings” ),

那么就会得到错误报告,说短名称是含糊的,因此就必须使用完全限定名。

Copyright © 2010-2013 g . All Rights Reserved. 6/79

MyBatis用户指南中文版

version 3.2.2

如

BlogMapper

这样的映射器类来说,还有一个妙招。它们中间映射的语句可以不需要 在

XML

中来写,而可以使用

Java

注解来替换。比如,上面的

XML

示例可以如下来替换:

package e;public interface BlogMapper { @Select("SELECT * FROM blog WHERE id = #{id}") Blog selectBlog(int id);}对于简单语句来说,使用注解代码会更加清晰,然而

Java

注解对于复杂语句来说就会 混乱,

应该限制使用。 因此,

如果你不得不做复杂的事情,

那么最好使用

XML

来映射语句。

当然这也取决于你和你的项目团队的决定,

看哪种更适合你来使用,

还有以长久方式来 使用映射语句的重要性。也就是说,不要将自己局限在一种方式中。你可以轻松地将注解换 成

XML

映射语句,反之亦然。

范围和生命周期理解我们目前已经讨论过的不同范围和生命周期类是很重要的。 不正确的使用它们会导 致严重的并发问题。

SqlSessionFactoryBuilder这个类可以被实例化,使用和丢弃。一旦你创建了

SqlSessionFactory

后,这个类就不需 要存在了。因此

SqlSessionFactoryBuilder

实例的最佳范围是方法范围

(也就是本地方法变量)。 你可以重用

SqlSessionFactoryBuilder

来创建多个

SqlSessionFactory

实例,

但是最好的方式是 不需要保持它一直存在来保证所有

XML

解析资源,因为还有更重要的事情要做。

SqlSessionFactory一旦被创建,SqlSessionFactory

应该在你的应用执行期间都存在。没有理由来处理或重 新创建它。

使用

SqlSessionFactory

的最佳实践是在应用运行期间不要重复创建多次。 这样的 操作将被视为是非常糟糕的。 因此

SqlSessionFactory

的最佳范围是应用范围。 有很多方法可 以做到,

最简单的就是使用单例模式或者静态单例模式。

SqlSession每个线程都应该有它自己的

SqlSession

实例。SqlSession

的实例不能被共享,也是线程 不安全的。因此最佳的范围是请求或方法范围。绝对不能将

SqlSession

实例的引用放在一个 类的静态字段甚至是实例字段中。 也绝不能将

SqlSession

实例的引用放在任何类型的管理范 围中,

比如

Serlvet

架构中的

HttpSession。 如果你现在正用任意的

Web

框架,

要考虑

SqlSession

放在一个和

HTTP请求对象相似的范围内。换句话说,基于收到的

HTTP

请求,你可以打开 了一个

SqlSession,然后返回响应,就可以关闭它了。关闭

Session

很重要,你应该确保使 用

finally

块来关闭它。下面的示例就是一个确保

SqlSession

关闭的基本模式:

Copyright © 2010-2013 g . All Rights Reserved. 7/79

MyBatis用户指南中文版

version 3.2.2

SqlSession session = ssion();try { // do work} finally { ();}在你的代码中一贯地使用这种模式,

将会保证所有数据库资源都正确地关闭

(假设你没 有通过你自己的连接关闭,这会给

MyBatis

造成一种迹象表明你要自己管理连接资源)

。

Mapper 实例映射器是你创建绑定映射语句的接口。映射器接口的实例可以从

SqlSession

中获得。那 么从技术上来说,当被请求时,任意映射器实例的最宽范围和

SqlSession

是相同的。然而,

映射器实例的最佳范围是方法范围。也就是说,它们应该在使用它们的方法中被请求,然后 就抛弃掉。它们不需要明确地关闭,那么在请求对象中保留它们也就不是什么问题了,这和

SqlSession

相似。你也许会发现,在这个水平上管理太多的资源的话会失控。保持简单,将 映射器放在方法范围内。下面的示例就展示了这个实践:

SqlSession session = ssion();try { BlogMapper mapper = per(); // do work} finally { ();}重要

Object lifecycle and Dependency Injection Frameworks

Dependency Injection frameworks can create thread safe, transactional

SqlSessions and mappers and inject them directly into your beans so you can justforget about their lifecycle. You may want to have a look at MyBatis-Spring or

MyBatis-Guice sub-projects to know more about using MyBatis with DI frameworks.

XML 映射配置文件MyBatis

的

XML

配置文件包含了影响

MyBatis

行为甚深的设置和属性信息。

XML

文档 的高层级结构如下:

•configuration

配置

•

properties

属性

•

settings

设置

•

typeAliases

类型命名

Copyright © 2010-2013 g . All Rights Reserved. 8/79

MyBatis用户指南中文版

version 3.2.2

••••

typeHandlers

类型处理器

objectFactory

对象工厂

plugins

插件

environments

环境

•environment

环境变量

•transactionManager

事务管理器

•dataSource

数据源

• databaseIdProvider chinese?

•

mappers

映射器

properties这些是外部化的,

可替代的属性,

这些属性也可以配置在典型的

Java

属性配置文件中,

或者通过

properties

元素的子元素来传递。例如:

其中的属性就可以在整个配置文件中使用,使用可替换的属性来实现动态配置。比如:

这个例子中的

username

和

password

将会由

properties

元素中设置的值来替换。

driver

和

url

属性将会从包含进来的

ties

文件中的值来替换。这里提供很多配置的选项。

属性也可以被传递到

()方法中。例如:

SqlSessionFactory factory = (reader, props);// ... or ...SqlSessionFactory factory = (reader, environment, props);如果在这些地方,属性多于一个的话,MyBatis

按照如下的顺序加载它们:

•在

properties

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

•从类路径下资源或

properties

元素的

url

属性中加载的属性第二被读取,它会 覆盖已经存在的完全一样的属性。

•作为方法参数传递的属性最后被读取,

它也会覆盖任一已经存在的完全一样的 属性,这些属性可

Copyright © 2010-2013 g . All Rights Reserved. 9/79

MyBatis用户指南中文版

version 3.2.2

能是从

properties

元素体内和资源/url

属性中加载的。

因此,

最高优先级的属性是那些作为方法参数的,

然后是资源/url

属性,

最后是

properties

元素中指定的属性。

settings这些是极其重要的调整,

它们会修改

MyBatis

在运行时的行为方式。 下面这个表格描述 了设置信息,它们的含义和默认值。

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

这个配置使全局的映射器启用或禁用 缓true | falsetrue

存。

全局启用或禁用延迟加载。当禁用时,

所true | falsetrue

有关联对象都会即时加载。

当启用时,

有延迟加载属性的对象在被

调用时将会完全加载true | falsetrue

任意属性。否则,

每种属性将会按需要加载。

lazyLoadingEnabled

aggressiveLazyLoading

允许或不允许多种结果集从一个单独 的multipleResultSetsEnabled语句中返回(需要适true | falsetrue

合的驱动)

使用列标签代替列名。 不同的驱动在这 方便表现不同。 参考true | falsetrue

驱动文档或充分测

试两种方法来决定所使用的驱动。

允许

JDBC

支持生成的键。 需要适合的

驱动。 如果设置为

true

则这个设置强true | falseFalse

制 生成的键被使用,尽管一些驱动拒绝兼容但仍然有效(比如

useColumnLabel

useGeneratedKeys

Derby)

autoMappingBehavior

指定

MyBatis

如何NONE,

自动映射列到字段/ PARTIAL,

属性。PARTIAL

只FULL

PARTIAL

Copyright © 2010-2013 g . All Rights Reserved. 10/79

MyBatis用户指南中文版

version 3.2.2

设置参数描述会自动映射简单,

没有嵌套的结果。FULL会自动映射任 意复杂的结果(嵌套的或其他情况)

。

配置默认的执行器。SIMPLE

执行器没

有什么特别之处。SIMPLE REUSEREUSE

执行器重用

SIMPLE

BATCH

预处理语句。BATCH执行器重用语句 和批量更新

设置超时时间,

它决Any positiveNot Set (null)

定驱动等待一个数

integer

据库响应的时间。

有效值默认值defaultExecutorType

defaultStatementTimeout

safeRowBoundsEnabled

Allows using

RowBounds on

nested

statements.

true | falseFalse

Enables

automatic

mapping from

classic databasecolumn names

mapUnderscoreToCamelCase true | falseFalse

A_COLUMN to

camel case

classic Java

property names

aColumn.

localCacheScope MyBatis uses SESSION |

local cache to STATEMENT

prevent circularreferences and

speed up

repeated nested

queries. By

default

(SESSION) all

queries executedduring a sessionare cached. If

SESSION

Copyright © 2010-2013 g . All Rights Reserved. 11/79

MyBatis用户指南中文版

version 3.2.2

设置参数描述有效值默认值localCacheScope=STATEMENT local

session will be

used just for

statement

execution, no

data will be

shared between

two different

calls to the

same ies the

JDBC type for

null values whenno specific JDBCtype was

provided for theparameter. Some

drivers require

specifying the

column JDBC typebut others work

with generic

values like

NULL, VARCHAR orOTHER.

Specifies which

Object's methodstrigger a lazy

load

jdbcTypeForNull

JdbcType

common

OTHER

are: NULL,

VARCHAR and

OTHER

lazyLoadTriggerMethods

A method

name list equals,clone,hashCode,toseparated byString

commas

A type or fully

amicLaqualified

nguageDriver

class name.

Specifies the

language used bydefaultScriptingLanguage default for

dynamic SQL

generation.

callSettersOnNulls

当结果集中含有true | falsefalse

Null值时是否执行映射对象的setter或者Map对象的put方法。此设置对于原始类型如

Copyright © 2010-2013 g . All Rights Reserved. 12/79

MyBatis用户指南中文版

version 3.2.2

设置参数效。

描述有效值默认值int,boolean等无Specifies the

prefix string

that MyBatis Any String Not set

will add to the

logger names.

Specifies which

logging

implementation

MyBatis should

use. If this

setting is not

present logging

implementation

will be

autodiscovered.

SLF4J |

LOG4J |

JDK_LOGGING

|

COMMONS_LOGGNot set

ING |

STDOUT_LOGGING |

NO_LOGGING

logPrefix

logImpl

Specifies the

proxy tool that

MyBatis will useCGLIB |

proxyFactory

for creating JAVASSIST

lazy loading

capable objects.一个设置信息元素的示例,完全的配置如下所示:

CGLIB

Copyright © 2010-2013 g . All Rights Reserved. 13/79

MyBatis用户指南中文版

version 3.2.2

typeAliases类型别名是为

Java

类型命名一个短的名字。 它只和

XML

配置有关,

只用来减少类完全 限定名的多余部分。例如:

使用这个配置, “Blog”可以任意用来替代“. Blog”所使用的地方。

You can also specify a package where MyBatis will search for beans. For example:

Each bean found in , if no annotation is found, will be registered

as an alias using uncapitalized non-qualified class name of the bean. Thas is

will be registered as Author . If the @Alias annotation is

found its value will be used as an alias. See the example below:

@Alias("author")public class Author { ...}对于普通的

Java

类型,有许多内建的类型别名。它们都是大小写不敏感的,由于重载 的名字,要注意原生类型的特殊处理。

别名 映射的类型

_byte

_long

_short

_int

_integer

_double

_float

byte

long

short

int

int

double

float

Copyright © 2010-2013 g . All Rights Reserved. 14/79

MyBatis用户指南中文版

version 3.2.2

别名 映射的类型

_boolean

string

byte

long

short

int

integer

double

float

boolean

date

decimal

object

map

hashmap

list

boolean

String

Byte

Long

Short

Integer

Integer

Double

Float

Boolean

Date

BigDecimal

Object

Map

HashMap

List

bigdecimal BigDecimal

arraylist ArrayList

collection Collection

iterator Iterator

typeHandlers无论是

MyBatis

在预处理语句中设置一个参数,

还是从结果集中取出一个值时,

类型处 理器被用来将获取的值以合适的方式转换成

Java

类型。下面这个表格描述了默认的类型处 理器。

类型处理器

Java

类型

n,

boolean

, byte

, short

r, int

, long

, float

JDBC

类型

任何兼容的布尔值

任何兼容的数字或字节类型

任何兼容的数字或短整型

任何兼容的数字和整型

任何兼容的数字或长整型

任何兼容的数字或单精度浮点型任何兼容的数字或十进制小数类型

BooleanTypeHandler

ByteTypeHandler

ShortTypeHandler

IntegerTypeHandler

LongTypeHandler

FloatTypeHandler

DoubleTypeHandler

BigDecimalTypeHandler

, double

任何兼容的数字或双精度浮点型imal

Copyright © 2010-2013 g . All Rights Reserved. 15/79

MyBatis用户指南中文版

version 3.2.2

类型处理器

Java

类型

byte[]

byte[]

amp

Any

Enumeration Type

JDBC

类型

CHAR

和

VARCHAR

类型

CLOB

和

LONGVARCHAR

类型

NVARCHAR

和

NCHAR

类型

NCLOB

类型

任何兼容的字节流类型

StringTypeHandler

ClobTypeHandler

NStringTypeHandler

NClobTypeHandler

ByteArrayTypeHandler

BlobTypeHandler

DateTypeHandler

DateOnlyTypeHandler

TimeOnlyTypeHandler

SqlTimestampTypeHandler

SqlDateTypeHandler

SqlTimeTypeHandler

ObjectTypeHandler

EnumTypeHandler

BLOB

和

LONGVARBINARY

类型

TIMESTAMP

类型

DATE

类型

TIME

类型

TIMESTAMP

类型

DATE

类型

TIME

类型

其他或未指定类型

VARCHAR-任何兼容的字符串类型,

作为代码存储(而不是索引)

Any compatible NUMERIC

or DOUBLE, as the

EnumOrdinalTypeHandler Enumeration Type

position is stored (not

the code itself).

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。

//TODO

translation needed To do so, simply extend the

peHandler class and optionally map your new

TypeHandler class to a JDBC type.

例如:

// @MappedJdbcTypes(R)public class ExampleTypeHandler extends BaseTypeHandler { @Override public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType

jdbcType) throws SQLException { ing(i, parameter); } @Override public String getNullableResult(ResultSet rs, String columnName) throws SQLException { return ing(columnName); } @Override

Copyright © 2010-2013 g . All Rights Reserved. 16/79

MyBatis用户指南中文版

version 3.2.2

public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException { return ing(columnIndex); } @Override public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { return ing(columnIndex); }} 使用这样的类型处理器将会覆盖已经存在的处理

Java

的

String

类型属性和

VARCHAR

参数及结果的类型处理器。 要注意

MyBatis

不会审视数据库元信息来决定使用哪种类型,

所 以你必须在参数和结果映射中指定那是

VARCHAR

类型的字段,来绑定到正确的类型处理 器上。这是因为

MyBatis

直到语句被执行都不知道数据类型的这个现实导致的。

// TODO translation needed MyBatis will know the the Java type that you want to

handle with this TypeHandler by introspecting its generic type, but you can

override this behavior by two means:

•Adding a javaType attribute to the typeHandler element (for example:

javaType="String")

•Adding a @MappedTypes annotation to your TypeHandler class specifying the

list of java types to associate it with. This annotation will be ignored

if the javaType attribute as also been specified.

Associated JDBC type can be specified by two means:•Adding a jdbcType attribute to the typeHandler element (for example:

jdbcType=VARCHAR).

•Adding a @MappedJdbcTypes annotation to your TypeHandler class specifying

the list of JDBC types to associate it with. This annotation will be

ignored if the jdbcType attribute as also been specified.

And finally you can let MyBatis search for your TypeHandlers: Note that when using the autodiscovery feature JDBC types can only be specified

Copyright © 2010-2013 g . All Rights Reserved. 17/79

MyBatis用户指南中文版

version 3.2.2

with annotations.

You can create a generic TypeHandler that is able to handle more than one that purpose add a constructor that receives the class as a parameter and

MyBatis will pass the actual class when constructing the TypeHandler.

//blic class GenericTypeHandler extends BaseTypeHandler { private Class type; public GenericTypeHandler(Class type) { if (type == null) throw new IllegalArgumentException("Type argument cannot be null"); = type; } ...EnumTypeHandler and EnumOrdinalTypeHandler are generic TypeHandlers. We will

learn about them in the following section.

Handling EnumsIf you want to map an Enum, you'll need to use either EnumTypeHandler or

EnumOrdinalTypeHandler.

For example, let's say that we need to store the rounding mode that should be

used with some number if it needs to be rounded. By default, MyBatis uses

EnumTypeHandler to convert the Enum values to their names.

Note EnumTypeHandler is special in the sense that unlike other handlers,

it does not handle just one specific class, but any class that extends

Enum

However, we may not want to store names. Our DBA may insist on an integer code

instead. That's just as easy: add EnumOrdinalTypeHandler to the typeHandlers in

your config file, and now each RoundingMode will be mapped to an integer using

its ordinal value.

javaType="ngMode"/>But what if you want to map the same Enum to a string in one place and to

integer in another?

The auto-mapper will automatically use EnumOrdinalTypeHandler, so if we want to

Copyright © 2010-2013 g . All Rights Reserved. 18/79

MyBatis用户指南中文版

version 3.2.2

go back to using plain old ordinary EnumTypeHandler, we have to tell it, by

explicitly setting the type handler to use for those SQL statements.

(Mapper files aren't covered until the next section, so if this is your first

time reading through the documentation, you may want to skip this for now and

come back to it later.)

select * from users insert into users (id, name, funkyNumber, roundingMode) values ( #{id}, #{name}, #{funkyNumber}, #{roundingMode} )

typeHandler="peHandler"/> select * from users2 insert into users2 (id, name, funkyNumber, roundingMode) values ( #{id}, #{name}, #{funkyNumber}, #{roundingMode,

typeHandler=peHandler} )

Copyright © 2010-2013 g . All Rights Reserved. 19/79

MyBatis用户指南中文版

version 3.2.2

Note that this forces us to use a resultMap instead of a resultType in our

select statements.

objectFactoryMyBatis

每次创建结果对象新的实例时,

它使用一个

ObjectFactory

实例来完成。 如果参 数映射存在,默认的

ObjectFactory

不比使用默认构造方法或带参数的构造方法实例化目标 类做的工作多。如果你想重写默认的

ObjectFactory,你可以创建你自己的。比如:

// blic class ExampleObjectFactory extends DefaultObjectFactory { public Object create(Class type) { return (type); } public Object create(Class type, List constructorArgTypes, List