MyBatis 02-XML 配置文件

https://mybatis.org/mybatis-3/zh/configuration.html

<?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>
    <settings>
    <typeAliases>
    <typeHandlers>
    <objectFactory>
    <objectWrapperFactory>
    <reflectorFactory>
    <plugins>
    <environments>
    <databaseIdProvider>
    <mappers>
</configuration>

标签顺序必须符合要求,否则报错:
The content of element type "configuration" must match "(properties?,settings?,typeAliases?,typeHandlers?,objectFactory?,objectWrapperFactory?,reflectorFactory?,plugins?,environments?,databaseIdProvider?,mappers?)".

属性(properties)

属性可以在典型的 Java properties 文件中配置,亦可通过 properties 元素的子元素来传递

<properties resource="config.properties">
    <property name="username" value="root"/>
    <property name="password" value="root"/>
</properties>

然后其中的属性就可以在整个配置文件中被用来替换需要动态配置的属性值。比如:

<dataSource type="POOLED">
  <property name="driver" value="${driver}"/>
  <property name="url" value="${url}"/>
  <property name="username" value="${username}"/>
  <property name="password" value="${password}"/>
</dataSource>

属性也可以被传递到 SqlSessionFactoryBuilder.build() 方法中。例如:

Properties prop = new Properties();
prop.setProperty("driver", "com.mysql.cj.jdbc.Driver");
prop.setProperty("url", "jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&characterEncoding=utf8");
prop.setProperty("username", "root");
prop.setProperty("password", "root");

Reader reader = Resources.getResourceAsReader("config.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader, prop);
reader.close();

加载顺序

通过方法参数传递的属性具有最高优先级,属性中指定的配置文件次之,最低优先级的是 properties 属性中指定的属性。

为占位符指定一个默认值

从 MyBatis 3.4.2 开始

<dataSource type="POOLED">
    <property name="username" value="${username:ut_user}"/> <!-- 如果属性 'username' 没有被配置,'username' 属性的值将为 'ut_user' -->
</dataSource>

需添加一个指定的属性来开启这个特性。例如:

<properties resource="org/mybatis/example/config.properties">
    <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/> <!-- 启用默认值特性 -->
</properties>

可以修改 value="?:" 的值,来修改分隔键名和默认值的字符。

设置(settings)

<settings>
    <!-- 全局的映射器启用或禁用缓存。 -->
    <setting name="cacheEnabled" value="true"/>
    <!-- 全局启用或禁用延迟加载 -->
    <setting name="lazyLoadingEnabled" value="true"/>
    <!-- 允许或不允许多种结果集从一个单独的语句中返回 -->
    <setting name="multipleResultSetsEnabled" value="true"/>
    <setting name="useColumnLabel" value="true"/>
    <setting name="useGeneratedKeys" value="true"/>
    <setting name="defaultExecutorType" value="SIMPLE"/>
    <!-- 设置超时时间(秒) -->
    <setting name="defaultStatementTimeout" value="200"/>
</settings>
设置名 描述 有效值 默认值
cacheEnabled 全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存。 true/false true
lazyLoadingEnabled 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。 true/false false
aggressiveLazyLoading 当开启时,任何方法的调用都会加载该对象的所有属性。否则,每个属性会按需加载(参考 lazyLoadTriggerMethods)。 true/false false (在 3.4.1 及之前的版本默认值为 true)
lazyLoadTriggerMethods 指定哪个对象的方法触发一次延迟加载。 用逗号分隔的方法列表。 equals,clone,hashCode,toString
multipleResultSetsEnabled 是否允许单一语句返回多结果集(需要驱动支持)。 true/false true
useColumnLabel 使用列标签代替列名。不同的驱动在这方面会有不同的表现,具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果。 true/false true
useGeneratedKeys 允许 JDBC 支持自动生成主键,需要驱动支持。 如果设置为 true 则这个设置强制使用自动生成主键,尽管一些驱动不能支持但仍可正常工作(比如 Derby)。 true/false false
autoMappingBehavior 指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射; PARTIAL 只会自动映射没有定义嵌套结果集映射的结果集。 FULL 会自动映射任意复杂的结果集(无论是否嵌套)。 NONE, PARTIAL, FULL PARTIAL
autoMappingUnknownColumnBehavior 指定发现自动映射目标未知列(或者未知属性类型)的行为。
NONE: 不做任何反应
WARNING: 输出提醒日志 ('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN)
FAILING: 映射失败 (抛出 SqlSessionException)
NONE, WARNING, FAILING NONE
defaultExecutorType 配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会重用预处理语句(prepared statements); BATCH 执行器将重用语句并执行批量更新。 SIMPLE, REUSE, BATCH SIMPLE
defaultStatementTimeout 设置超时时间,它决定驱动等待数据库响应的秒数。 任意正整数 未设置 (null)
defaultFetchSize 为驱动的结果集获取数量(fetchSize)设置一个提示值。此参数只可以在查询设置中被覆盖。 任意正整数 未设置 (null)
safeRowBoundsEnabled 允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为 false。 true/false False
safeResultHandlerEnabled 允许在嵌套语句中使用分页(ResultHandler)。如果允许使用则设置为 false。 true/false True
mapUnderscoreToCamelCase 是否开启自动驼峰命名规则(camel case)映射,即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。 true/false False
localCacheScope MyBatis 利用本地缓存机制(Local Cache)防止循环引用(circular references)和加速重复嵌套查询。 默认值为 SESSION,这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地会话仅用在语句执行上,对相同 SqlSession 的不同调用将不会共享数据。 SESSION / STATEMENT SESSION
defaultEnumTypeHandler 指定 Enum 使用的默认 TypeHandler 。(新增于 3.4.5) 一个类型别名或完全限定类名。 org.apache.ibatis.type.EnumTypeHandler
logPrefix 指定 MyBatis 增加到日志名称的前缀。 任何字符串 未设置
logImpl 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 SLF4J / LOG4J / LOG4J2 / JDK_LOGGING / COMMONS_LOGGING / STDOUT_LOGGING / NO_LOGGING 未设置

类型别名(typeAliases)

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

<typeAliases>
    <typeAlias alias="Country" type="com.bin.domian.Country"/>
</typeAliases>

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

<typeAliases>
    <package name="com.bin.domian"/>
</typeAliases>

每一个在包 com.bin.domian 中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 com.bin.domian.Country 的别名为 country;若有注解,则别名为其注解值。见下面的例子:

@Alias("country")
public class Country {
    ...
}

常见的 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

类型处理器(typeHandlers)

无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时, 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

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

处理枚举类型

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

默认情况下,MyBatis 会利用 EnumTypeHandler 来把 Enum 值转换成对应的名字。

public enum CountryCode {
    CN("CN 中国"),
    US("US 美国"),
    RU("RU 俄罗斯"),
    GB("GB 英国"),
    FR("FR 法国");

    private String codename;

    private CountryCode(String codename) {
        this.codename = codename;
    }

    public String getCodename() {
        return codename;
    }
}
// Country 类下 增加属性
private CountryCode code;

EnumTypeHandler

<resultMap id="countryMap" type="Country">
    <id column="id" property="id"/>
    <result column="countrycode" property="code" typeHandler="org.apache.ibatis.type.EnumTypeHandler"/>
</resultMap>

<select id="selectAll2" resultMap="countryMap">
    select id, countryname, countrycode from country
</select>

将数据库中 countrycode 映射到 code 字段中。

EnumOrdinalTypeHandler

数据库中新增 code 字段,存放整型值

<!-- 修改默认的处理器,如果在下方的 resultMap 指定了 typeHandler 这里可以不需要-->
<typeHandlers>
    <typeHandler handler="org.apache.ibatis.type.EnumOrdinalTypeHandler" javaType="com.bin.domian.CountryCode"/>
</typeHandlers>
<resultMap id="countryMap" type="Country">
    <id column="id" property="id"/>
    <!-- 同样如果已经在配置文件中修改了 默认的处理器,这里的 typeHandler 可以不需要 -->
    <result column="code" property="code" typeHandler="org.apache.ibatis.type.EnumOrdinalTypeHandler"/>
</resultMap>

<select id="selectAll2" resultMap="countryMap">
    select id, countryname, countrycode, code from country
</select>

环境配置(environments)

可以指定使用哪个环境配置,如果忽略了环境参数,那么默认环境将会被加载

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

环境元素定义了如何配置环境。

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC">
            <property name="..." value="..."/>
        </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>
  • 默认使用的环境 ID(比如:default="development")。

  • 每个 environment 元素定义的环境 ID(比如:id="development")。

  • 事务管理器的配置(比如:type="JDBC")。如果使用 Spring + MyBatis,Spring 模块会使用自带的管理器来覆盖前面的配置。

  • 数据源的配置(比如:type="POOLED")。

      <dataSource type="POOLED">
          <!-- type="UNPOOLED"  不使用任何数据库连接池来管理数据库连接 -->
          <property name="driver" value="${driver}"/>
          <property name="url" value="${url}"/>
          <property name="username" value="${username}"/>
          <property name="password" value="${password}"/>
          <!-- defaultTransactionIsolationLevel – 默认的连接事务隔离级别。 -->
          <!-- defaultNetworkTimeout 默认网络超时值(以毫秒为单位),以等待数据库操作完成 -->
          <!-- 你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可,例如: -->
              <!-- driver.encoding=UTF8 -->
    
          <!-- type="POOLED" 使用 Mybatis 自带的数据库连接池来管理数据库连接 -->
          <!-- 除了上述提到 UNPOOLED 下的属性外,还有更多属性用来配置 POOLED 的数据源: -->
    
          <!-- 在任意时间可以存在的活动(也就是正在使用)连接数量,默认值: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"/>
          <!-- 是否启用侦测查询。若开启,需要设置 poolPingQuery 属性为一个可执行的 SQL 语句(最好是一个速度非常快的 SQL 语句),默认值:false。 -->
          <property name="poolPingEnabled" value="true"/>
          <!-- 发送到数据库的侦测查询,用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”,这会导致多数数据库驱动失败时带有一个恰当的错误消息。 -->
          <property name="poolPingQuery" value="select 1"/>
          <!-- 配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样,来避免不必要的侦测,默认值:0(即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用)。 -->
          <property name="poolPingConnectionsNotUsedFor" value="20000"/>
      </dataSource>

映射器(mappers)

可以使用相对于类路径的资源引用, 或完全限定资源定位符(包括 file:/// 的 URL),或类名和包名等。例如:

<!-- 使用相对于类路径的资源引用 -->
<mappers>
    <mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

<!-- 使用完全限定资源定位符(URL) -->
<mappers>
    <mapper url="file:///var/mappers/PostMapper.xml"/>
</mappers>

<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
    <mapper class="org.mybatis.builder.PostMapper"/>
</mappers>

<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
    <package name="org.mybatis.builder"/>
</mappers>

转载请注明来源,欢迎对文章中的引用来源进行考证,欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论,也可以邮件至 bin07280@qq.com

文章标题:MyBatis 02-XML 配置文件

文章字数:3.5k

本文作者:Bin

发布时间:2019-09-18, 23:08:44

最后更新:2019-10-23, 15:15:39

原始链接:http://coolview.github.io/2019/09/18/MyBatis/MyBatis%2002-XML%20%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6/

版权声明: "署名-非商用-相同方式共享 4.0" 转载请保留原文链接及作者。

目录