MyBatis核心配置解析与生命周期详解-优快云博客

本文链接：https://blog.youkuaiyun.com/m0_56183421/article/details/129105195

Mybatis-配置解析

一、核心配置文件配置解析
二、生命周期和作用域

一、核心配置文件配置解析

mybatis-config.xml 系统核心配置文件

注意：官网的这个排列顺序，配置文件必须按照这个顺序配置。例如 < properties >< /properties >必须放在第一位，否则报错！

环境配置（environments）

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

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

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中，现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。必须指定其中一个为默认运行环境（通过default指定）

子元素节点environment

environment 元素定义具体的一套环境，通过设置id进行区别，id保证唯一！

事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器（也就是 type=“[JDBC|MANAGED]”）
Mybatis默认是JDBC，知道事务管理器不止JDBC即可！

数据源（dataSource）

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

UNPOOLED
POOLED
JNDI

数据源也有很多第三方的实现，比如dbcp，c3p0，druid等等…
想了解实现方法的查看官网

映射器（mappers）

mappers
映射器 : 定义映射SQL语句文件
定义 SQL 映射语句。首先，我们需要告诉 MyBatis 到哪里去找到这些语句。在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用，或完全限定资源定位符（包括 file:/// 形式的 URL），或类名和包名等。

引入资源方式

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

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

<!-- 
使用映射器接口实现类的完全限定类名 
需要XXXMapper.xml名称和接口名称一致，并且位于同一目录下 
-->
<mappers>
  <mapper class="org.mybatis.builder.AuthorMapper"/>
</mappers>

<!-- 
将包内的映射器接口全部注册为映射器 
但是需要XXXMapper.xml名称和接口名称一致，并且位于同一目录下
-->
<mappers>
  <package name="org.mybatis.builder"/>
</mappers>

Mapper文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.h.mapper.UserMapper">
    
</mapper>

namespace:命名空间
- namespace命名规则 : 包名+类名
- namespace的值必须跟某个接口同名
- 接口中的方法与映射文件中sql语句id应该一一对应
- namespace值和子标签id的值保证唯一

Properties优化

数据库这些属性都是可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 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>

我们来优化我们的配置文件，具体操作如下：

第一步，在resource目录下新建一个db.properties

driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mysql?useSSL=false&useUnicode=true&characterEncoding=UTF-8
userName=root
password=12345678

第二步 : 将文件导入properties 配置文件，导入后property 的value值可以用${}取到，名字要对应

<configuration>
<!--导入properties文件-->
<properties resource="db.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>

	<mappers>
	<mapper resource="com/H/Dao/UserMapper.xml"/>
	</mappers>
</configuration>

除了这种方式还可以在properties 标签里设置property

<properties>
	 <property name="driver" value="com.mysql.jdbc.Driver"/>
	 <property name="url" value="jdbc:mysql://localhost:3306/mysql?useSSL=false&useUnicode=true&characterEncoding=UTF-8"/>
     <property name="userName" value="root"/>
     <property name="password" value="12345678"/>
</properties>

当然不建议既在db.properties里面写又在properties标签里写
如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

首先读取在 properties 元素体内指定的属性
然后然后读取db.properties里的，并覆盖之前读取过的同名属性。
也就是说如果有相同的熟悉都会被db.properties里的覆盖掉！

typeAliases优化

类型别名可为 Java 类型设置一个缩写名字。它仅用于 XML 配置，意在降低冗余的全限定类名书写

例如：

<select id="getUserList" resultType="com.h.pojo.User">
    select * from mysql.t_user;
</select>

每一次都这么写会造成代码的冗余

在mybatis-config.xml文件中添加

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

当这样配置时，User可以用在任何使用com.h.pojo.User的地方。
也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，比如:

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

每一个在包 com.h.pojo 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。比如 com.h.pojo.User 的别名为 user；若有注解，则别名为其注解值。见下面的例子：

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

别名为U

在这里插入图片描述

设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为

列举一些常用的：

设置名	描述	有效值	默认值
cacheEnabled	全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。	true / false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。	true / false	false
useGeneratedKeys	允许 JDBC 支持自动生成主键，需要数据库驱动支持。如果设置为 true，将强制使用自动生成主键。尽管一些数据库驱动不支持此特性，但仍可正常工作（如 Derby）。	true / false	False
mapUnderscoreToCamelCase	是否开启驼峰命名自动映射，即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。	true / false	False
logImpl	指定 MyBatis 所用日志的具体实现，未指定时将自动查找。	SLF4J 、LOG4J（3.5.9 起废弃）、 LOG4J2、 JDK_LOGGING 、 COMMONS_LOGGING、 STDOUT_LOGGING、 NO_LOGGING	未设置

一个配置完整的 settings 元素的示例如下：

<settings>
  <setting name="cacheEnabled" value="true"/>
  <setting name="lazyLoadingEnabled" value="true"/>
  <setting name="useGeneratedKeys" value="false"/>
  <setting name="mapUnderscoreToCamelCase" value="false"/>
  <setting name="logImpl" value="SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING"/>
</settings>

更多设置查看Mybatis官网

二、生命周期和作用域

理解我们之前讨论过的不同作用域和生命周期类别是至关重要的，因为错误的使用会导致非常严重的并发问题。

在这里插入图片描述

作用域理解

SqlSessionFactoryBuilder 的作用在于创建 SqlSessionFactory，创建成功后，SqlSessionFactoryBuilder 就失去了作用，所以它只能存在于创建 SqlSessionFactory 的方法中，而不要让其长期存在。因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。
SqlSessionFactory 可以被认为是一个数据库连接池，它的作用是创建 SqlSession 接口对象。因为 MyBatis 的本质就是 Java 对数据库的操作，所以 SqlSessionFactory 的生命周期存在于整个 MyBatis 的应用之中，所以一旦创建了 SqlSessionFactory，就要长期保存它，直至不再使用 MyBatis 应用，所以可以认为 SqlSessionFactory 的生命周期就等同于 MyBatis 的应用周期。
由于 SqlSessionFactory 是一个对数据库的连接池，所以它占据着数据库的连接资源。如果创建多个 SqlSessionFactory，那么就存在多个数据库连接池，这样不利于对数据库资源的控制，也会导致数据库连接资源被消耗光，出现系统宕机等情况，所以尽量避免发生这样的情况。
因此在一般的应用中我们往往希望 SqlSessionFactory 作为一个单例，让它在应用中被共享。所以说 SqlSessionFactory 的最佳作用域是应用作用域。
如果说 SqlSessionFactory 相当于数据库连接池，那么 SqlSession 就相当于一个数据库连接（Connection 对象），你可以在一个事务里面执行多条 SQL，然后通过它的 commit、rollback 等方法，提交或者回滚事务。所以它应该存活在一个业务请求中，处理完整个请求后，应该关闭这条连接，让它归还给 SqlSessionFactory，否则数据库资源就很快被耗费精光，系统就会瘫痪，这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。
所以 SqlSession 的最佳的作用域是请求或方法作用域。