持久层MyBatis - mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 属性 -->
<!--
既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置
config.properties 文件中的属性可以使用,在子元素中设置的也可以用
属性加载顺序:
1、首先读取在 properties 元素体内指定的属性。
2、然后根据 properties 元素中的 resource 属性读取类路径下属性文件,或根据 url 属性指定的路径读取属性文件,并覆盖之前读取过的同名属性。
3、最后读取作为方法参数传递的属性,并覆盖之前读取过的同名属性。
-->
<properties resource="./config.properties">
<!-- 特殊属性 启用默认值特性,默认关闭 -->
<property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
<!-- 修改默认值的分隔符 ${username:ut_user} => ${username?:ut_user} 避免 : 被用于三元表达式等情况,需要用别的替换-->
<property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
<property name="username" value="root"/>
<property name="password" value="mazichong"/>
</properties>
<!-- 设置 -->
<!-- MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。 -->
<settings>
<!-- 描述
有效值 默认值 -->
<!-- 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。
true | false true -->
<setting name="cacheEnabled" value="true"/>
<!-- 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。
true | false false -->
<setting name="lazyLoadingEnabled" value="false"/>
<!-- 开启时,任一方法的调用都会加载该对象的所有延迟加载属性。否则,每个延迟加载属性会按需加载(参考 lazyLoadTriggerMethods)。
true | false false (在 3.4.1 及之前的版本中默认为 true) -->
<setting name="aggressiveLazyLoading" value="false"/>
<!-- 是否允许单个语句返回多结果集(需要数据库驱动支持)。
true | false true -->
<setting name="multipleResultSetsEnabled" value="true"/>
<!-- 使用列标签代替列名。实际表现依赖于数据库驱动,具体可参考数据库驱动的相关文档,或通过对比测试来观察。
true | false true -->
<setting name="useColumnLabel" value="true"/>
<!-- 允许 JDBC 支持自动生成主键,需要数据库驱动支持。如果设置为 true,将强制使用自动生成主键。尽管一些数据库驱动不支持此特性,但仍可正常工作(如 Derby)。
true | false false -->
<setting name="useGeneratedKeys" value="false"/>
<!-- 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射;PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集(无论是否嵌套)。
NONE,PARTIAL,FULL PARTIAL -->
<setting name="autoMappingBehavior" value="PARTIAL"/>
<!-- 指定发现自动映射目标未知列(或未知属性类型)的行为。 NONE: 不做任何反应; WARNING: 输出警告日志('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN); FAILING: 映射失败 (抛出 SqlSessionException)
NONE,WARNING,FAILING NONE -->
<setting name="autoMappingUnknownColumnBehavior" value="NONE"/>
<!-- 配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会重用预处理语句(PreparedStatement); BATCH 执行器不仅重用语句还会执行批量更新。
SIMPLE,REUSE,BATCH SIMPLE -->
<setting name="defaultExecutorType" value="SIMPLE"/>
<!-- 设置超时时间,它决定数据库驱动等待数据库响应的秒数。
任意正整数 未设置 (null) -->
<setting name="defaultStatementTimeout" value=""/>
<!-- 为驱动的结果集获取数量(fetchSize)设置一个建议值。此参数只可以在查询设置中被覆盖。
任意正整数 未设置 (null) -->
<setting name="defaultFetchSize" value=""/>
<!-- 指定语句默认的滚动策略。(新增于 3.5.2)
FORWARD_ONLY,SCROLL_SENSITIVE,SCROLL_INSENSITIVE,DEFAULT(等同于未设置) 未设置 (null) -->
<setting name="defaultResultSetType" value=""/>
<!-- 是否允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为 false。
true | false false -->
<setting name="safeRowBoundsEnabled" value="false"/>
<!-- 是否允许在嵌套语句中使用结果处理器(ResultHandler)。如果允许使用则设置为 false。
true | false true -->
<setting name="safeResultHandlerEnabled" value="true"/>
<!-- 是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。
true | false false -->
<setting name="mapUnderscoreToCamelCase" value="false"/>
<!-- MyBatis 利用本地缓存机制(Local Cache)防止循环引用和加速重复的嵌套查询。 默认值为 SESSION,会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地缓存将仅用于执行语句,对相同 SqlSession 的不同查询将不会进行缓存。
SESSION,STATEMENT SESSION -->
<setting name="localCacheScope" value="SESSION"/>
<!-- 当没有为参数指定特定的 JDBC 类型时,空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可,比如 NULL、VARCHAR 或 OTHER。
JdbcType 常量,常用值:NULL、VARCHAR 或 OTHER。 OTHER -->
<setting name="jdbcTypeForNull" value="OTHER"/>
<!-- 指定对象的哪些方法触发一次延迟加载。
用逗号分隔的方法列表。 equals,clone,hashCode,toString -->
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
<!-- 指定动态 SQL 生成使用的默认脚本语言。
一个类型别名或全限定类名。 org.apache.ibatis.scripting.xmltags.XMLLanguageDriver -->
<setting name="defaultScriptingLanguage" value="org.apache.ibatis.scripting.xmltags.XMLLanguageDriver"/>
<!-- 指定 Enum 使用的默认 TypeHandler 。(新增于 3.4.5)
一个类型别名或全限定类名。 org.apache.ibatis.type.EnumTypeHandler -->
<setting name="defaultEnumTypeHandler" value="org.apache.ibatis.type.EnumTypeHandler"/>
<!-- 指定当结果集中值为 null 的时候是否调用映射对象的 setter(map 对象时为 put)方法,这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型(int、boolean 等)是不能设置成 null 的。
true | false false -->
<setting name="callSettersOnNulls" value="false"/>
<!-- 当返回行的所有列都是空时,MyBatis默认返回 null。 当开启这个设置时,MyBatis会返回一个空实例。 请注意,它也适用于嵌套的结果集(如集合或关联)。(新增于 3.4.2)
true | false false -->
<setting name="returnInstanceForEmptyRow" value="false"/>
<!-- 指定 MyBatis 增加到日志名称的前缀。
任何字符串 未设置 -->
<setting name="logPrefix" value=""/>
<!-- 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。
SLF4J,LOG4J,LOG4J2,JDK_LOGGING,COMMONS_LOGGING,STDOUT_LOGGING,NO_LOGGING 未设置 -->
<setting name="logImpl" value=""/>
<!-- 指定 Mybatis 创建可延迟加载对象所用到的代理工具。
CGLIB,JAVASSIST JAVASSIST (MyBatis 3.3 以上) -->
<setting name="proxyFactory" value="JAVASSIST"/>
<!-- 指定 VFS 的实现
自定义 VFS 的实现的类全限定名,以逗号分隔。 未设置 -->
<setting name="vfsImpl" value=""/>
<!-- 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的项目必须采用 Java 8 编译,并且加上 -parameters 选项。(新增于 3.4.1)
true | false true -->
<setting name="useActualParamName" value="true"/>
<!-- 指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。(新增于 3.2.3)
一个类型别名或完全限定类名。 未设置 -->
<setting name="configurationFactory" value=""/>
</settings>
<!-- 类型别名 -->
<!-- 类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。 -->
<!-- 下面是一些为常见的 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 BigDecimal
bigdecimal BigDecimal
object Object
map Map
hashmap HashMap
list List
arraylist ArrayList
collection Collection
iterator Iterator
-->
<typeAliases>
<!-- 类别名 当这样配置时,Author 可以用在任何使用 domain.blog.Author 的地方。-->
<typeAlias alias="Author" type="domain.blog.Author"/>
<!-- 指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean -->
<!-- 每一个在包 domain.blog 中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author;若有注解 @Alias("author"),则别名为其注解值。 -->
<package name="domain.blog"/>
</typeAliases>
<!-- 类型处理器 详见官方文档-->
<!--
MyBatis 在设置预处理语句(PreparedStatement)中的参数或从结果集中取出一个值时,
都会用类型处理器将获取到的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器。
你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。
具体做法为:实现 org.apache.ibatis.type.TypeHandler 接口,
或继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler, 并且可以(可选地)将它映射到一个 JDBC 类型
-->
<!-- EnumTypeHandler 和 EnumOrdinalTypeHandler 都是泛型类型处理器 详见官方文档 -->
<!-- 下表描述了一些默认的类型处理器
类型处理器 Java 类型 JDBC 类型
BooleanTypeHandler java.lang.Boolean, boolean 数据库兼容的 BOOLEAN
ByteTypeHandler java.lang.Byte, byte 数据库兼容的 NUMERIC 或 BYTE
ShortTypeHandler java.lang.Short, short 数据库兼容的 NUMERIC 或 SMALLINT
IntegerTypeHandler java.lang.Integer, int 数据库兼容的 NUMERIC 或 INTEGER
LongTypeHandler java.lang.Long, long 数据库兼容的 NUMERIC 或 BIGINT
FloatTypeHandler java.lang.Float, float 数据库兼容的 NUMERIC 或 FLOAT
DoubleTypeHandler java.lang.Double, double 数据库兼容的 NUMERIC 或 DOUBLE
BigDecimalTypeHandler java.math.BigDecimal 数据库兼容的 NUMERIC 或 DECIMAL
StringTypeHandler java.lang.String CHAR, VARCHAR
ClobReaderTypeHandler java.io.Reader -
ClobTypeHandler java.lang.String CLOB, LONGVARCHAR
NStringTypeHandler java.lang.String NVARCHAR, NCHAR
NClobTypeHandler java.lang.String NCLOB
BlobInputStreamTypeHandler java.io.InputStream -
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 类型,用来存储枚举的序数值(而不是名称)。
SqlxmlTypeHandler java.lang.String SQLXML
InstantTypeHandler java.time.Instant TIMESTAMP
LocalDateTimeTypeHandler java.time.LocalDateTime TIMESTAMP
LocalDateTypeHandler java.time.LocalDate DATE
LocalTimeTypeHandler java.time.LocalTime TIME
OffsetDateTimeTypeHandler java.time.OffsetDateTime TIMESTAMP
OffsetTimeTypeHandler java.time.OffsetTime TIME
ZonedDateTimeTypeHandler java.time.ZonedDateTime TIMESTAMP
YearTypeHandler java.time.Year INTEGER
MonthTypeHandler java.time.Month INTEGER
YearMonthTypeHandler java.time.YearMonth VARCHAR 或 LONGVARCHAR
JapaneseDateTypeHandler java.time.chrono.JapaneseDate DATE
-->
<typeHandlers>
<typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
<!-- MyBatis 帮你查找类型处理器, 注意在使用自动发现功能的时候,只能通过注解方式来指定 JDBC 的类型。-->
<package name="org.mybatis.example"/>
</typeHandlers>
<!-- 对象工厂 -->
<!--
每次 MyBatis 创建结果对象的新实例时,它都会使用一个对象工厂(ObjectFactory)实例来完成实例化工作。
默认的对象工厂需要做的仅仅是实例化目标类,要么通过默认无参构造方法,要么通过存在的参数映射来调用带有参数的构造方法。
如果想覆盖对象工厂的默认行为,可以通过创建自己的对象工厂来实现。
ObjectFactory 接口很简单,它包含两个创建实例用的方法,一个是处理默认无参构造方法的,另外一个是处理带参数的构造方法的。
另外,setProperties 方法可以被用来配置 ObjectFactory,
在初始化你的 ObjectFactory 实例后, objectFactory 元素体中定义的属性会被传递给 setProperties 方法。
可参考默认实现类 DefaultObjectFactory
-->
<!-- 完全限定类名 -->
<objectFactory type="org.mybatis.example.ExampleObjectFactory">
<!-- 对象工厂属性 -->
<property name="someProperty" value="100"/>
</objectFactory>
<!-- 插件 -->
<!--
MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下,MyBatis 允许使用插件来拦截的方法调用包括:
Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
ParameterHandler (getParameterObject, setParameters)
ResultSetHandler (handleResultSets, handleOutputParameters)
StatementHandler (prepare, parameterize, batch, update, query)
-->
<!-- 详细看官方注解 -->
<plugins>
<plugin interceptor="org.mybatis.example.ExamplePlugin">
<property name="someProperty" value="100"/>
</plugin>
</plugins>
<!-- 环境配置 -->
<!-- 尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。想连接两个数据库,就需要创建两个 SqlSessionFactory 实例 -->
<!-- 默认使用的环境 default="ID" -->
<environments default="development">
<!-- 每个 environment 元素定义的环境 ID -->
<environment id="development1">
<!-- 事务管理器的配置, 在 MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]")-->
<!--
JDBC – 这个配置直接使用了 JDBC 的提交和回滚设施,它依赖从数据源获得的连接来管理事务作用域。
MANAGED – 这个配置几乎没做什么。它从不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如 JEE 应用服务器的上下文)。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭,因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。
这两种事务管理器类型都不需要设置任何属性。它们其实是类型别名,换句话说,你可以用 TransactionFactory 接口实现类的全限定名或类型别名代替它们。
Tips: Spring + MyBatis,则没有必要配置事务管理器,因为 Spring 模块会使用自带的管理器来覆盖前面的配置。
自定义 MyBatis 对事务的处理, 需要实现以下两个接口
interface TransactionFactory
interface Transaction
-->
<transactionManager type="JDBC">
<!-- <property name="..." value="..."/> -->
</transactionManager>
<!-- 数据源的配置, 有三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]")-->
<!-- 实现接口 org.apache.ibatis.datasource.DataSourceFactory 来使用第三方数据源 -->
<!-- 继承 org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory 可被用来构建新的数据源适配器 -->
<!-- UNPOOLED: 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢,但对那些数据库连接可用性要求不高的简单应用程序来说,是一个很好的选择。 性能表现则依赖于使用的数据库,对某些数据库来说,使用连接池并不重要,这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性 -->
<dataSource type="UNPOOLED">
<!-- JDBC 驱动的 Java 类全限定名(并不是 JDBC 驱动中可能包含的数据源类) -->
<property name="driver" value="${driver}"/>
<!-- 数据库的 JDBC URL 地址 -->
<property name="url" value="${url}"/>
<!-- 登录数据库的用户名 -->
<property name="username" value="${username}"/>
<!-- 如果属性 'username' 没有被配置,'username' 属性的值将为 'ut_user' 需要在属性中开启此特性-->
<!-- <property name="username" value="${username:ut_user}"/> -->
<!-- 登录数据库的密码 -->
<property name="password" value="${password}"/>
<!-- 默认的连接事务隔离级别 -->
<property name="defaultTransactionIsolationLevel" value=""/>
<!-- 等待数据库操作完成的默认网络超时时间(单位:毫秒) -->
<property name="defaultNetworkTimeout" value="5000"/>
<!-- 可选项,你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可 -->
<property name="driver.encoding" value="UTF8"/>
</dataSource>
</environment>
<environment id="development">
<transactionManager type="JDBC" />
<!-- POOLED: 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来,避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行,能使并发 Web 应用快速响应请求。 -->
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
<property name="defaultTransactionIsolationLevel" value=""/>
<property name="defaultNetworkTimeout" value="5000"/>
<property name="driver.encoding" value="UTF8"/>
<!-- 在任意时间可存在的活动(正在使用)连接数量,默认值:10 -->
<property name="poolMaximumActiveConnections" value="10"/>
<!-- 任意时间可能存在的空闲连接数 -->
<property name="poolMaximumIdleConnections" value="10"/>
<!-- 在被强制返回之前,池中连接被检出(checked out)时间,默认值:20000 毫秒(即 20 秒) -->
<property name="poolMaximumCheckoutTime" value="20000"/>
<!-- 这是一个底层设置,如果获取连接花费了相当长的时间,连接池会打印状态日志并重新尝试获取一个连接(避免在误配置的情况下一直失败且不打印日志),默认值:20000 毫秒(即 20 秒) -->
<property name="poolTimeToWait" value="20000"/>
<!-- 这是一个关于坏连接容忍度的底层设置, 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接,那么这个数据源允许这个线程尝试重新获取一个新的连接,但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值:3(新增于 3.4.5) -->
<property name="poolMaximumLocalBadConnectionTolerance" value="3"/>
<!-- 发送到数据库的侦测查询,用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”,这会导致多数数据库驱动出错时返回恰当的错误消息 -->
<property name="poolPingQuery" value="NO PING QUERY SET"/>
<!-- 是否启用侦测查询。若开启,需要设置 poolPingQuery 属性为一个可执行的 SQL 语句(最好是一个速度非常快的 SQL 语句),默认值:false -->
<property name="poolPingEnabled" value="false"/>
<!-- 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样,来避免不必要的侦测,默认值:0(即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用) -->
<property name="poolPingConnectionsNotUsedFor" value="0"/>
<property name="driver.encoding" value="UTF8"/>
</dataSource>
</environment>
<environment id="development3">
<transactionManager type="JDBC" />
<!-- JNDI: 这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置一个 JNDI 上下文的数据源引用。这种数据源配置只需要两个属性 -->
<dataSource type="POOLED">
<!-- 这个属性用来在 InitialContext 中寻找上下文(即,initialContext.lookup(initial_context))。这是个可选属性,如果忽略,那么将会直接从 InitialContext 中寻找 data_source 属性 -->
<property name="initial_context" value="${driver}"/>
<!-- 这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找,没有提供时则直接在 InitialContext 中查找 -->
<property name="data_source " value="${url}"/>
<!-- 可以通过添加前缀“env.”直接把属性传递给 InitialContext -->
<property name="env.encoding" value="UTF8"/>
</dataSource>
</environment>
</environments>
<!-- 数据库厂商标识 -->
<!--
MyBatis 可以根据不同的数据库厂商执行不同的语句,这种多厂商的支持是基于映射语句中的 databaseId 属性。
MyBatis 会加载带有匹配当前数据库 databaseId 属性和所有不带 databaseId 属性的语句。
如果同时找到带有 databaseId 和不带 databaseId 的相同语句,则后者会被舍弃。
databaseIdProvider 对应的 DB_VENDOR 实现会将 databaseId 设置为 DatabaseMetaData#getDatabaseProductName() 返回的字符串。
由于通常情况下这些字符串都非常长,而且相同产品的不同版本会返回不同的值,你可能想通过设置属性别名来使其变短。
可以通过实现接口 org.apache.ibatis.mapping.DatabaseIdProvider 并在 mybatis-config.xml 中注册来构建自己的 DatabaseIdProvider
-->
<databaseIdProvider type="DB_VENDOR">
<property name="SQL Server" value="sqlserver"/>
<property name="DB2" value="db2"/>
<property name="Oracle" value="oracle" />
</databaseIdProvider>
<!-- 映射器 -->
<!-- 这些配置会告诉 MyBatis 去哪里找映射文件 -->
<mappers>
<!-- 使用相对于类路径的资源引用 -->
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
<!-- 使用完全限定资源定位符(URL) -->
<mapper url="file:///var/mappers/AuthorMapper.xml"/>
<!-- 使用映射器接口实现类的完全限定类名 -->
<mapper class="org.mybatis.builder.AuthorMapper"/>
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<package name="org.mybatis.builder"/>
</mappers>
</configuration>