8、MyBatis主配置文件

学习资源：动力节点《2020最新MyBatis教程【IDEA版】-MyBatis从入门到精通》

目录


MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。

配置文档的顶层结构如下：

configuration（配置）							
    properties（属性）							*****
    settings（设置）							*****
    typeAliases（类型别名）                        *****
    typeHandlers（类型处理器）
    objectFactory（对象工厂）
    plugins（插件）
    environments（环境配置）	   				    *****
        environment（环境变量）
            transactionManager（事务管理器）
            dataSource（数据源）
    databaseIdProvider（数据库厂商标识）
    mappers（映射器）		    			     *****
<!-- 注意元素节点的顺序！顺序不对会报错 -->

1、Properties属性（重点）

数据库这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来传递。

  • 可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来配置。

  • 然而properties的作用并不单单是这样，你可以创建一个资源文件，名为jdbc.properties的文件，将四个连接字符串的数据在资源文件中通过键值 对(key=value)的方式放置，不要任何符号，一条占一行。

    driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8
username=root
password=123456

  • 将文件导入jdbc.properties文件，在environment元素的dataSource元素中为其动态设置。

    <configuration>
    <!--导入properties文件-->
    <properties resource="jdbc.properties"/>

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>
        <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>

</configuration>

  • 补充说明：在properties标签中也可以自定义属性：

    <properties resource="druid.properties">
    <property name="username" value="root"/>
    <property name="password" value="=#&amp;7415zgh"/>
</properties>

  • 如果自定义属性和外部配置文件从冲突，默认外部配置文件优先使用。


2、setting设置 （重点）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。

设置名 描述 有效值 默认值
cacheEnabled 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 true | false true
lazyLoadingEnabled 延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。 true | false false
aggressiveLazyLoading 开启时，任一方法的调用都会加载该对象的所有延迟加载属性。 否则，每个延迟加载属性会按需加载（参考 lazyLoadTriggerMethods)。 true | false false （在 3.4.1 及之前的版本中默认为 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
autoMappingUnknownColumnBehavior 指定发现自动映射目标未知列（或未知属性类型）的行为。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 | 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） 一个类型别名或完全限定类名。 未设置

  • 设置（settings）相关 => 查看帮助文档

    • 懒加载，lazyLoadingEnabled
    • 日志实现，
    • 缓存开启关闭，cacheEnabled

  • 一个配置完整的 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="false"/>
  <setting name="autoMappingBehavior" value="PARTIAL"/>
  <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
  <setting name="defaultExecutorType" value="SIMPLE"/>
  <setting name="defaultStatementTimeout" value="25"/>
  <setting name="defaultFetchSize" value="100"/>
  <setting name="safeRowBoundsEnabled" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="localCacheScope" value="SESSION"/>
  <setting name="jdbcTypeForNull" value="OTHER"/>
  <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>

3、typeAliases类型别名（重点）

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

  • 方式一，为单个类设置别名当这样配置时，user可以用在任何使用com.kuang.pojo.User的地方。

    <!--配置别名,注意顺序-->
<typeAliases>
    <typeAlias type="com.kuang.pojo.User" alias="user"/>
</typeAliases>

  • 方式二，指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，每一个在包 com.at.pojo 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。

    <typeAliases>
    <package name="com.at.pojo"/>
</typeAliases>

  • 方式三，使用注解@Alias("value")，别名为其注解值。见下面的例子：

    @Alias("user")
public class User {
    ...
}

方式总结：

​ 在pojo较少的情况下可以考虑使用方式一和方式三，在pojo较多的情况下可以考虑使用方式二。

​ 方式一、三都可以给pojo起别名，方式二不可以，只能使用小写的类名（大写也可以，建议小写）。


4、environments环境配置（重点）

  • MyBatis可以配置多种环境，比如开发、测试和生产环境需要有不同的配置

  • 每种环境使用一个<environment>标签进行配置并指定唯一标识符

  • 可以通过<environments>标签中的default属性指定一个环境的标识符来快速的切换环境

  • environment指定具体环境，id：指定当前环境的唯一标识，transactionManager、和dataSource都必须有

  • 子元素节点：environment

    • 具体的一套环境，通过设置id进行区别，id保证唯一！

    • 子元素节点：transactionManager - [ 事务管理器 ]，表示 MyBstis 处理事务的方式

      <!-- 语法 -->
<transactionManager type="[ JDBC | MANAGED ]"/>
      • type，事务处理的类型
        • JDBC：表示 MyBatis 底层是使用 JDBC 中的 Connection 对象的 commiy、rollback 处理事务*
        • MANAGED：表示 MyBstis 将事务处理委托给其他容器（服务器软件或框架）
      • 这两种事务管理器类型都不需要设置任何属性。

    • 子元素节点：数据源（dataSource）

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

      • 数据源即为数据库连接池，mybatis内置有数据库连接池

      • 数据源是必须配置的

      • 有三种内建的数据源类型

        type="[UNPOOLED|POOLED|JNDI]"

        • unpooled： 这个数据源的实现只是每次被请求时打开和关闭连接。

        • pooled： 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来 , 这是一种使得并发 Web 应用快速响应请求的流行处理方式。

        • jndi：这个数据源的实现是为了能在如 Spring 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。

      • 数据源也有很多第三方的实现，比如dbcp，c3p0，druid等等....子元素节点：environment

  • Mybatis默认的事务管理器是 JDBC ，数据源是 POOLED

    <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>
    
  <environment id="test">
    <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>

5、mapper映射器（重点）

  • 用来在mybatis初始化的时候，告诉mybatis需要引入哪些Mapper映射文件

  • <mapper>标签会逐个注册SQL映射文件

    resource : 引入类路径下的文件

    url : 引入网络路径或者是磁盘路径下的文件

    class : 引入Mapper接口.

    有SQL映射文件时 , 要求Mapper接口与 SQL映射文件同名同位置.

    没有SQL映射文件时 , 使用注解在接口的方法上写SQL语句.

  • 引入方式

    • 方式一

      <!-- 使用相对于类路径的资源引用 -->
<mappers>
    <!-- 接口和,xml放在同一包下 -->
    <mapper resource="org/mybatis/builder/PostMapper.xml"/>
    <!-- .xml放在resource下 -->
    <mapper resource="UserMapper.xml"></mapper>
</mappers>

    • 方式二，要求配置文件名称和接口名称一致，并且位于同一目录下

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

    • 方式三，需要配置文件名称和接口名称一致，并且位于同一目录下

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

    • 方式四，不建议使用

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

6、日志工厂

思考：我们在测试SQL的时候，要是能够在控制台输出 SQL 的话，是不是就能够有更快的排错效率？

如果一个 数据库相关的操作出现了问题，我们可以根据输出的SQL语句快速排查问题。

对于以往的开发过程，我们会经常使用到debug模式来调节，跟踪我们的代码执行过程。但是现在使用Mybatis是基于接口，配置文件的源代码执行过程。因此，我们必须选择日志工具来作为我们开发，调节程序的工具。

Mybatis内置的日志工厂提供日志功能，具体的日志实现有以下几种工具：

  • SLF4J
  • Apache Commons Logging
  • Log4j 2
  • Log4j 掌握
  • STDOUT_LOGGING 掌握
  • JDK logging

具体选择哪个日志实现工具由MyBatis的内置日志工厂确定。它会使用最先找到的（按上文列举的顺序查找）。 如果一个都未找到，日志功能就会被禁用。

6.1、标准日志实现

指定 MyBatis 应该使用哪个日志记录实现。如果此设置不存在，则会自动发现日志记录实现。

<settings>
        <setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>

测试，可以看到控制台有大量的输出！我们可以通过这些输出来判断程序到底哪里出了Bug

image-20200322204556753


6.2、Log4j

简介：

  • Log4j是Apache的一个开源项目
  • 通过使用Log4j，我们可以控制日志信息输送的目的地：控制台，文本，GUI组件....
  • 我们也可以控制每一条日志的输出格式；
  • 通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

使用步骤：

  1. 导入log4j的包

    <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

  2. log4j.properties配置文件编写

    #将等级为DEBUG的日志信息输出到console和file这两个目的地，console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file

#控制台输出的相关设置
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n

#文件输出的相关设置
log4j.appender.file = org.apache.log4j.RollingFileAppender
log4j.appender.file.File=./log/kuang.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n

#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

  3. setting设置日志实现

    <settings>
    <setting name="logImpl" value="LOG4J"/>
</settings>

  4. 在程序中使用Log4j进行输出！

    //注意导包：org.apache.log4j.Logger
static Logger logger = Logger.getLogger(MyTest.class);

@Test
public void selectUser() {
    logger.info("info：进入selectUser方法");
    logger.debug("debug：进入selectUser方法");
    logger.error("error: 进入selectUser方法");
    SqlSession session = MybatisUtils.getSession();
    UserMapper mapper = session.getMapper(UserMapper.class);
    List<User> users = mapper.selectUser();
    for (User user: users){
        System.out.println(user);
    }
    session.close();
}

  5. 测试，看控制台输出！

    image-20200322215646925

    • 使用Log4j 输出日志

    • 可以看到还生成了一个日志的文件 【需要修改file的日志级别】


7、其他配置

7.1、typeHandlers 类型处理器

官方文档

  • 无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。
  • 你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。【了解即可】

7.2、objectFactory 对象工厂

官方文档

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

7.3、plugins 插件

MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

  • Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
  • ParameterHandler (getParameterObject, setParameters)
  • ResultSetHandler (handleResultSets, handleOutputParameters)
  • StatementHandler (prepare, parameterize, batch, update, query)

这些类中方法的细节可以通过查看每个方法的签名来发现，或者直接查看 MyBatis 发行包中的源代码。 如果你想做的不仅仅是监控方法的调用，那么你最好相当了解要重写的方法的行为。 因为在试图修改或重写已有方法的行为时，很可能会破坏 MyBatis 的核心模块。 这些都是更底层的类和方法，所以使用插件的时候要特别当心。

通过 MyBatis 提供的强大机制，使用插件是非常简单的，只需实现 Interceptor 接口，并指定想要拦截的方法签名即可。

// ExamplePlugin.java
@Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}

<!-- mybatis-config.xml -->
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

上面的插件将会拦截在 Executor 实例中所有的 “update” 方法调用， 这里的 Executor 是负责执行底层映射语句的内部对象。

提示覆盖配置类：除了用插件来修改 MyBatis 核心行为以外，还可以通过完全覆盖配置类来达到目的。只需继承配置类后覆盖其中的某个方法，再把它传递到 SqlSessionFactoryBuilder.build(myConfig) 方法即可。再次重申，这可能会极大影响 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>

	<properties resource="druid.properties" />
	
    <settings>
        <!-- 设置日志 -->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
        <!-- 驼峰-下划线自动转换 -->
	    <setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>
	<!--
	<settings>
		<setting name="logImpl" value="LOG4J"/>
	</settings>
	-->
	
    <!--方式1：给每一个pojo单独起别名 -->
	<typeAliases>
		<typeAlias type="com.chen.pojo.User" alias="User" />
	<!-- 方式2：为该包下所有pojo起别名，不区分大小类型名 -->
		<package name="com.chen.pojo"  />
	</typeAliases>
    
	<environments default="development">
		<environment id="development">
			<transactionManager type="JDBC"/>
			<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>

	<!-- sql映射文件的位置 -->
	<mappers>
	    <!-- 方式1：使用resource绑定接口 -->
		<!-- ①、接口和.xml放在同一包下 -->
		<mapper resource="com/chen/mapper/PostMapper.xml" />
		<!-- ②、.xml放在resource下 -->
		<mapper resource="UserMapper.xml" />
		
        <!-- 方式2：使用映射器接口实现类的完全限定类名 -->
        <!-- 需要配置文件名称和接口名称一致，并且位于同一目录下 -->
		<mapper class="com.chen.mapper.AuthorMapper" />
		
        <!-- 方式3：将包内的映射器接口实现全部注册为映射器 -->
        <!-- 需要配置文件名称和接口名称一致，并且位于同一目录下 -->
		<package name="org.mybatis.builder" />
	</mappers>
	
</configuration>

数据库属性配置文件

将数据库连接信息统一放置在一个单独的文件中，便于修改、保存处理多个数据库的信息。

#mysql服务器地址
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
#用户名
username=root
#用户密码
password=#&7415zgh
#新版本的MySQL8驱动
driver=com.mysql.cj.jdbc.Driver
【推广】 免费学中医，健康全家人
原文地址：https://www.cnblogs.com/sout-ch233/p/13608372.html