【MyBatis 系列 2】最全 MyBatis 核心配置文件总结，可以作为工具先收藏了

作者：Java高工P7

2021 年 11 月 11 日
本文字数：6538 字
阅读完需：约 21 分钟

properties 优先级

properties 配置的属性如果重复，优先级如下：

1、第一优先：在代码中直接通过 properties 传入 build 方法。
2、第二优先：通过 resource 或者 url 读取到的 properties 文件中属性。
3、第三优先：直接在 properties 内的子标签 property 内定义的属性。

在实际开发中，建议是只使用一种，使用多种方式混合的话会给后期维护造成困难，而且不同类型的配置属性混合时可读性也不好。

settings

settings 是 MyBatis 中最复杂，也是最重要的内容之一。当然这里说的复杂并不是说配置方式复杂，而是 settings 能配置的东西非常多，一些很核心的功能都是通过 settings 标签配置的。

下面是一个完整的属性配置示例：

</settings>

所有的可设置值列举如下（这些属性有个映像就可以了，不需要去记，常用的多用几次自然就记住了，不常用的需要的时候再查一下资料就可以了，所以建议大家可以收藏之后方便查询）：

| 参数 | 描述 | 可选值 | 默认值 |

| --- | --- | --- | --- |

| cacheEnabled | 缓存配置的全局开关 | true

false

| true |

| lazyLoadingEnabled | 延迟加载全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置 sql 语句上标签的 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 |

| safeRowBoundsEnabled | 允许在嵌套语句中使用分页（RowBounds） | true

false

| false |

| mapUnderscoreToCamelCase | 是否开启驼峰验证 | true

false

| false |

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

STATEMENT

| SESSION |

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

false

| false |

| logImpl | 指定 MyBatis 所用日志的具体实现，未指定时将自动查找 | SLF4J

LOG4J

LOG4J2

JDK_LOGGING

COMMONS_LOGGING

STDOUT_LOGGING

NO_LOGGING | - |

| proxyFactory | 指定 Mybatis 创建具有延迟加载能力的对象所用到的代理工具。 | CGLIB

JAVASSIST | JAVASSIST |

typeAliases

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

直接指定类名

例如：

这样配置的话在 MyBatis 的 xml 文件中可以直接使用 UserMapper 代替其类的全限定名。

只指定包名

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如:

这么配置的话每一个在指定包名中的 Java 类，如果没有使用注解指定名称，则会默认使用 Bean 的首字母小写的非限定类名来作为它的别名，如果有注解，则优先使用注解指定的别名。如：

@Alias("lonely_wolf")

public class LonelyWolf{

}

这里因为注解指定了别名，所以会以注解为准，如果没有注解，则默认使用 lonelyWolf 作为别名。

系统默认提供的别名

实际开发中，有很多返回类型是数据基本类型或者 String,Map,List 等非常常见的类型，这些类型 MyBatis 已经为我们提供好了别名，我们就不需要另外再定义了。

以下就时 MyBatis 中默认提供的别名：

| 别名 | 映射的类型 |

| --- | --- |

| _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 |

【一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义】
浏览器打开：qq.cn.hn/FTf 免费领取

复制代码

Map |

| hashmap | Hashmap |

| list | List |

| arraylist | Arraylist |

| collection | Collection |

| iterator | Iterator |

PS：这些别名的字母都是不区分大小写的，因为 MyBatis 在注册别名的时候会全部转为小写字母存储

typeHandlers

typeHandlers 主要是用来实现 Java 对象和数据库字段类型额转换关系。无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

配置方式如下：

</typeHandlers>

MyBatis 默认提供的 Java Bean 和数据库字段类型映射关系如下：

| 类型处理器 | Java 类型 | JDBC 类型 |

| --- | --- | --- |

| BooleanTypeHandler | java.lang.Boolean，boolean | 数据库兼容的 BOOLEAN |

| ByteTypeHandler | java.lang.Byte，byte | 数据库兼容的 NUMERIC 或 BYTE |

| ShortTypeHandler | java.lang.Short , short | 数据库兼容的 NUMERIC 或 SHORT INTEGER |

| IntegerTypeHandler | java.lang.Integer , int | 数据库兼容的 NUMERIC 或 INTEGER |

| LongTypeHandler | java.lang.Long , long | 数据库兼容的 NUMERIC 或 LONG INTEGER |

| 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 |

| ClobTypeHandler | java.lang.String | CLOB , LONGVARCHAR |

| NStringTypeHandler | java.lang.String | NVARCHAR , NCHAR |

| NClobTypeHandler | java.lang.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 | 任意类型 | OTHER 或未指定类型 |

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

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

自定义 typeHandlers

上面是 MyBatis 提供的默认映射类型，可以处理大部分需求，如果我们需要有不同的需求，则可以自己定义类型，具体如何定义，在后面的文章会单独分析，在这里不展开，感兴趣的可以关注我，留意后续文章。

objectFactory

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

可以通过创建自己的对象工厂来实现

plugins

MyBatis 允许你在已映射语句执行过程中的某一点进行拦截调用。这里我们不详细讨论，后期会有单独文章介绍 MyBatis 插件

environments

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中，例如：开发、测试和生产环境需要有不同的配置；或者共享相同 Schema 的多个生产数据库，想使用相同的 SQL 映射。许多类似的用例。

注意：尽管可以配置多个环境，每个 SqlSessionFactory 实例只能选择其一。所以，如果想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个。

配置示例如下：

</transactionManager>

</dataSource>

</environment>

</environments>

environment 配置关键点:

默认的环境 ID（比如:default=”development”）
每个 environment 元素定义的环境 ID（比如:id=”development”）。
事务管理器的配置（比如:type=”JDBC”）。
数据源的配置（比如:type=”POOLED”）。

事务管理器

在 MyBatis 中有两种类型的事务管理器（也就是 type=”JDBC"或者"MANAGED”）:

JDBC：这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务范围。
MANAGED：这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 J2EE 应用容器上下文）。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。

如:

</transactionManager>

注意：如果单独使用 MyBatis 而没有集成能管理事务的容器，那么配置成 MANAGED 就会等同于没有事务，所以一般单独使用 MyBatis 时，应配置为 JDBC。

数据源

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。有三种内建的数据源类型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）。

UNPOOLED

非连接池数据源。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

driver – 这是 JDBC 驱动的 Java 类的完全限定名（并不是 JDBC 驱动中可能包含的数据源类）
url – 这是数据库的 JDBC URL 地址
username – 登录数据库的用户名
password – 登录数据库的密码
defaultTransactionIsolationLevel – 默认的连接事务隔离级别

POOLED

连接池数据源。除了上述提到 UNPOOLED 下的属性外，会有更多属性用来配置 POOLED 的数据源：

poolMaximumActiveConnections – 在任意时间可以存在的活动（也就是正在使用）连接数量，默认值：10
poolMaximumIdleConnections – 任意时间可能存在的空闲连接数
poolMaximumCheckoutTime – 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
poolTimeToWait – 这是一个底层设置，如果获取连接花费的相当长的时间，它会给连接池打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直安静的失败），默认值：20000 毫秒（即 20 秒）
poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否处在正常工作秩序中并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息。
poolPingEnabled – 是否启用侦测查询。若开启，也必须使用一个可执行的 SQL 语句设置 poolPingQuery 属性（最好是一个非常快的 SQL），默认值：false
poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的使用频度。这可以被设置成匹配具体的数据库连接超时时间，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）

JNDI

这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：

initial_context – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么 data_source 属性将会直接从 InitialContext 中寻找。
data_source – 这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

自定义数据源

有些业务场景可能需要自己自定义数据源，MyBatis 也是支持的。自定义数据源必须要实现 DataSourceFactory 接口。然后采用如下配置：

databaseIdProvider

MyBatis 可以根据不同的数据库厂商执行不同的语句，这种多厂商的支持是基于映射语句中的 databaseId 属性。 MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。如果同时找到带有 databaseId 和不带 databaseId 的相

同语句，则后者会被舍弃。为支持多厂商特性只要像下面这样在 mybatis-config.xml 文件中加入 databaseIdProvider 即可：

mappers

这个就是用来配置 sql 映射语句的 xml 文件了。mappers 文件共有 4 种配置方式：

发布于: 2021 年 11 月 11 日阅读数: 4

Java高工P7

关注

还未添加个人签名 2021.11.08 加入

还未添加个人简介

发布

暂无评论

创作场景

【MyBatis 系列 2】最全 MyBatis 核心配置文件总结，可以作为工具先收藏了

properties 优先级

直接指定类名

只指定包名

系统默认提供的别名

自定义 typeHandlers

事务管理器

数据源

UNPOOLED

POOLED

JNDI

自定义数据源

Java高工P7

评论