MyBatis 学习笔记之配置文件

Myth丶恋晨 2023-09-30 23:47 10阅读 0赞

## 前言 ##

*  mybatis-config 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#settings][https_mybatis.org_mybatis-3_zh_configuration.html_settings]

## DEMO ##

<?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>    
            <properties resource="db-connection.properties">        <property name="driver" value="${driver}"/>        <property name="url" value="${url}"/>        <property name="username" value="${username}"/>        <property name="password" value="${password}"/>    </properties>
           
            <typeAliases>        <package name="com.fly9.domain"/>    </typeAliases>
            <typeHandlers>            </typeHandlers>
        
            <environments default="development">        <environment id="development">                        <transactionManager type="JDBC"></transactionManager>                        <dataSource type="POOLED">                <property name="driver" value="${driver}"/>                <property name="url" value="${url}"/>                <property name="username" value="${username}"/>                <property name="password" value="${password}"/>                                            </dataSource>        </environment>    </environments>
            <mappers>        <package name="com.fly9.mapper"/>    </mappers></configuration>

### properties 属性配置 ###

mybatis 官方属性文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#properties][https_mybatis.org_mybatis-3_zh_configuration.html_properties]属性，可以直接赋值，也可以外部进行配置，同一属性名以最后加载的为准；通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

driver=com.mysql.cj.jdbc.Driverurl=jdbc:mysql://192.168.5.129:3306/db_learnusername=rootpassword=123456

### settings 配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#settings][https_mybatis.org_mybatis-3_zh_configuration.html_settings]

*  NONE: 不做任何反应
 *  WARNING: 输出警告日志（'org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN）
 *  FAILING: 映射失败 (抛出 SqlSessionException) | NONE, WARNING, FAILING | NONE || defaultExecutorType | 配置默认的执行器。SIMPLE 就是普通的执行器；REUSE 执行器会重用预处理语句（PreparedStatement）； BATCH 执行器不仅重用语句还会执行批量更新。 | SIMPLE REUSE BATCH | SIMPLE || defaultStatementTimeout | 设置超时时间，它决定数据库驱动等待数据库响应的秒数。 | 任意正整数 | 未设置 (null) || defaultFetchSize | 为驱动的结果集获取数量（fetchSize）设置一个建议值。此参数只可以在查询设置中被覆盖。 | 任意正整数 | 未设置 (null) || defaultResultSetType | 指定语句默认的滚动策略。（新增于 3.5.2） | FORWARD\_ONLY | SCROLL\_SENSITIVE | SCROLL\_INSENSITIVE | DEFAULT（等同于未设置） | 未设置 (null) || safeRowBoundsEnabled | 是否允许在嵌套语句中使用分页（RowBounds）。如果允许使用则设置为 false。 | true | false | False || safeResultHandlerEnabled | 是否允许在嵌套语句中使用结果处理器（ResultHandler）。如果允许使用则设置为 false。 | true | false | True || mapUnderscoreToCamelCase | 是否开启驼峰命名自动映射，即从经典数据库列名 A\_COLUMN 映射到经典 Java 属性名 aColumn。 | true | false | False || localCacheScope | MyBatis 利用本地缓存机制（Local Cache）防止循环引用和加速重复的嵌套查询。 默认值为 SESSION，会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地缓存将仅用于执行语句，对相同 SqlSession 的不同查询将不会进行缓存。 | SESSION | STATEMENT | SESSION || jdbcTypeForNull | 当没有为参数指定特定的 JDBC 类型时，空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量，常用值：NULL、VARCHAR 或 OTHER。 | OTHER || lazyLoadTriggerMethods | 指定对象的哪些方法触发一次延迟加载。 | 用逗号分隔的方法列表。 | equals,clone,hashCode,toString || defaultScriptingLanguage | 指定动态 SQL 生成使用的默认脚本语言。 | 一个类型别名或全限定类名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver || defaultEnumTypeHandler | 指定 Enum 使用的默认 TypeHandler 。（新增于 3.4.5） | 一个类型别名或全限定类名。 | org.apache.ibatis.type.EnumTypeHandler || callSettersOnNulls | 指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。 | true | false | false || returnInstanceForEmptyRow | 当返回行的所有列都是空时，MyBatis 默认返回 null。 当开启这个设置时，MyBatis 会返回一个空实例。 请注意，它也适用于嵌套的结果集（如集合或关联）。（新增于 3.4.2） | true | false | false || logPrefix | 指定 MyBatis 增加到日志名称的前缀。 | 任何字符串 | 未设置 || logImpl | 指定 MyBatis 所用日志的具体实现，未指定时将自动查找。 | SLF4J | LOG4J(deprecated since 3.5.9) | LOG4J2 | JDK\_LOGGING | COMMONS\_LOGGING | STDOUT\_LOGGING | NO\_LOGGING | 未设置 || proxyFactory | 指定 Mybatis 创建可延迟加载对象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST （MyBatis 3.3 以上） || vfsImpl | 指定 VFS 的实现 | 自定义 VFS 的实现的类全限定名，以逗号分隔。 | 未设置 || useActualParamName | 允许使用方法签名中的名称作为语句参数名称。 为了使用该特性，你的项目必须采用 Java 8 编译，并且加上 -parameters 选项。（新增于 3.4.1） | true | false | true || configurationFactory | 指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为 static Configuration getConfiguration() 的方法。（新增于 3.2.3） | 一个类型别名或完全限定类名。 | 未设置 || shrinkWhitespacesInSql | 从 SQL 中删除多余的空格字符。请注意，这也会影响 SQL 中的文字字符串。 (新增于 3.5.5) | true | false | false || defaultSqlProviderType | Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted. | A type alias or fully qualified class name | Not set || nullableOnForEach | Specifies the default value of 'nullable' attribute on 'foreach' tag. (Since 3.5.9) | true | false | false |

### typeAliases 别名配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#typeAliases][https_mybatis.org_mybatis-3_zh_configuration.html_typeAliases]

<typeAliases>    <package name="com.fly9.domain"/></typeAliases>

### typeHandlers 类型处理器配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#typeHandlers][https_mybatis.org_mybatis-3_zh_configuration.html_typeHandlers]

### plugins 配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#plugins][https_mybatis.org_mybatis-3_zh_configuration.html_plugins]

### environments 环境配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#environments][https_mybatis.org_mybatis-3_zh_configuration.html_environments]

<environments default="development">    <environment id="development">                <transactionManager type="JDBC"></transactionManager>                <dataSource type="POOLED">            <property name="driver" value="${driver}"/>            <property name="url" value="${url}"/>            <property name="username" value="${username}"/>            <property name="password" value="${password}"/>                                </dataSource>    </environment></environments>

**数据源（dataSource）**dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

*  大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。

有三种内建的数据源类型（也就是 type="\[UNPOOLED|POOLED|JNDI\]"）：**UNPOOLED**– 这个数据源的实现会每次请求时打开和关闭连接。虽然有点慢，但对那些数据库连接可用性要求不高的简单应用程序来说，是一个很好的选择。 性能表现则依赖于使用的数据库，对某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：

*  driver – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
 *  url – 这是数据库的 JDBC URL 地址。
 *  username – 登录数据库的用户名。
 *  password – 登录数据库的密码。
 *  defaultTransactionIsolationLevel – 默认的连接事务隔离级别。
 *  defaultNetworkTimeout – 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看 java.sql.Connection\#setNetworkTimeout() 的 API 文档以获取更多信息。

作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可，例如：

*  driver.encoding=UTF8

这将通过 DriverManager.getConnection(url, driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动。**POOLED**– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。除了上述提到 UNPOOLED 下的属性外，还有更多属性用来配置 POOLED 的数据源：

*  poolMaximumActiveConnections – 在任意时间可存在的活动（正在使用）连接数量，默认值：10
 *  poolMaximumIdleConnections – 任意时间可能存在的空闲连接数。
 *  poolMaximumCheckoutTime – 在被强制返回之前，池中连接被检出（checked out）时间，默认值：20000 毫秒（即 20 秒）
 *  poolTimeToWait – 这是一个底层设置，如果获取连接花费了相当长的时间，连接池会打印状态日志并重新尝试获取一个连接（避免在误配置的情况下一直失败且不打印日志），默认值：20000 毫秒（即 20 秒）。
 *  poolMaximumLocalBadConnectionTolerance – 这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3（新增于 3.4.5）
 *  poolPingQuery – 发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动出错时返回恰当的错误消息。
 *  poolPingEnabled – 是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。
 *  poolPingConnectionsNotUsedFor – 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

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

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

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给 InitialContext。比如：

*  env.encoding=UTF8

这就会在 InitialContext 实例化时往它的构造方法传递值为 UTF8 的 encoding 属性。

### mappers 映射器配置 ###

mybatis 官方配置文档 ： [https://mybatis.org/mybatis-3/zh/configuration.html\#mappers][https_mybatis.org_mybatis-3_zh_configuration.html_mappers]

<mappers>    <package name="com.fly9.mapper"/></mappers>

[https_mybatis.org_mybatis-3_zh_configuration.html_settings]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23settings
[https_mybatis.org_mybatis-3_zh_configuration.html_properties]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23properties
[https_mybatis.org_mybatis-3_zh_configuration.html_typeAliases]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23typeAliases
[https_mybatis.org_mybatis-3_zh_configuration.html_typeHandlers]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23typeHandlers
[https_mybatis.org_mybatis-3_zh_configuration.html_plugins]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23plugins
[https_mybatis.org_mybatis-3_zh_configuration.html_environments]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23environments
[https_mybatis.org_mybatis-3_zh_configuration.html_mappers]: https://xie.infoq.cn/link?target=https%3A%2F%2Fmybatis.org%2Fmybatis-3%2Fzh%2Fconfiguration.html%23mappers