Mybatis配置文件解析

最新推荐文章于 2023-10-07 12:43:05 发布

花生的斯努比

最新推荐文章于 2023-10-07 12:43:05 发布

阅读量431

点赞数 1

分类专栏： MyBatis学习文章标签：数据库 java intellij-idea mybatis

本文链接：https://blog.csdn.net/weixin_45138036/article/details/122132606

版权

MyBatis学习专栏收录该内容

5 篇文章 0 订阅

订阅专栏

Mybatis配置文件解析

MyBaits中的配置文件会深深影响MyBatis的运行和属性信息，接下来我们对照官网对MyBatis的配置文件进行解读，以项目中的mybatis-config.xml配置文件为例：

1、配置文件的结构

configuration（配置）
- properties（属性）
- settings（设置）
- typeAliases（类型别名）
- typeHandlers（类型处理器）
- objectFactory（对象工厂）
- plugins（插件）
- environments（环境配置）
  - Environment（环境变量）
    - transactionManager（事务管理器）
    - dataSource（数据源）
- databaseldProvider（数据库厂商标识）
- mappers（映射器）

2、属性（properties）

我们可以通过properties属性来实现引入外部配置文件，这些属性都是可外部配置和动态替换的

<!-- 原方式 -->
<environment id="test">
        <!-- 事务管理器：默认JDBC -->
        <transactionManager type="JDBC" />
        <!-- 数据源：使用连接池，并加载mysql驱动连接数据库 -->
        <dataSource type="POOLED">
            <property name="driver" value="com.mysql.cj.jdbc.Driver" />
            <property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
            <property name="username" value="root" />
            <property name="password" value="123456" />
        </dataSource>
    </environment>

当使用上边的方式配置数据库连接的属性，如果我们想修改数据库配置信息，那么将不得不逐一修改上述配置属性，不能实现代码复用。但properties可以简化此操作。我们可以将数据库环境变量的配置信息放在一个专门的文件中，通过修改该文件的内容和properties的引用来修改环境变量的配置，如：

<!-- 使用mysql.properties的配置连接mysql数据库 -->
<properties resource="mysql.properties"></properties> 
<!-- 使用oracle.properties的配置连接oracle数据库 -->
<properties resource="mysql.properties"></properties>   

<environment id="development">
        <!-- 事务管理器：默认JDBC -->
        <transactionManager type="JDBC" />
        <!-- 数据源：使用连接池，并加载mysql驱动连接数据库 -->
        <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>

mysql.properties文件，用于连接mysql数据库

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/mybatis?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC&characterEncoding=UTF-8
username=root
password=123456

oracle.properties文件，用于连接oracle数据库

driver=oracle.jdbc.driver.OracleDriver 
url=jdbc:oracle:thin:@127.0.0.1:1521:oracle
username=root
password=123456

通过修改resources我们可以快速切换数据库，默认在mybatis-config.xml同文件目录下寻找

注意：如果一个属性在不只一个地方进行了配置，那么，MyBatis 将按照下面的顺序来加载：

首先读取在 properties 元素体内指定的属性。
然后根据 properties 元素中的 resource 属性读取类路径下属性文件，或根据 url 属性指定的路径读取属性文件，并覆盖之前读取过的同名属性。
最后读取作为方法参数传递的属性，并覆盖之前读取过的同名属性。

因此，通过方法参数传递的属性具有最高优先级，resource/url 属性中指定的配置文件次之，最低优先级的则是 properties 元素中指定的属性。

3、设置（settings）

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。常用于设置缓存和日志

<settings>
    <!--设置缓存-->
    <setting name="cacheEnabled" value="true"/>
    
    <!--设置日志为LOG4J-->
    <setting name="logImpl" value="LOG4J"/>
</settings>

下面是一个配置完整的 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>

4、类型别名（typeAliases）

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

现在我们在Mapper.xml文件中返回的数据结果我们设置为resultType=“com.bjut.pojo.User”，参数类型为parameterType=“com.bjut.pojo.User”，这样的代码具有很大的冗余，为了更加简洁，我们可以在mybatis-config.xml中通过配置类型别名来降低冗余，如：

<typeAliases>
    <!--方式一-->
    <typeAlias type="com.bjut.pojo.User" alias="user"/>
</typeAliases>

通过此设定，那么就可以将原来使用的com.bjut.pojo.User缩写成user

<select id="getUserList" resultType="com.bjut.pojo.User">
       select * from mybatis.user;
</select>

<!-- 改成如下形式效果一样-->
<select id="getUserList" resultType="user">
       select * from mybatis.user;
</select>

此外还可以指定一个包名，MyBatis会在这个包下搜索需要的Java Bean，比如：

<typeAliases>
    <!--方式二-->
    <package name="com.bjut.pojo"/>
</typeAliases>

通过此设定，每一个com.bjut.pojo包下的Java Bean，在没有注解的情况下，会使用Java Bean的首字母小写的非限定类名来作为它的别名。如com.bjut.pojo.Employee的别名为employee;如果该Java Bean有注解，则别名为注解值，比如：

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

在实体类较少的情况下，使用第一种方式；在实体类十分多的情况下，使用第二种方式

5、环境变量（Environments）

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中。例如，开发、测试和生产环境需要有不同的配置。

**不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。通过<environments default="development">**指定

<environments default="development">
    <!-- 环境变量：支持多套环境变量，例如开发环境、生产环境 -->
    <environment id="development">
        <!-- 事务管理器：默认JDBC -->
        <transactionManager type="JDBC" />
        <!-- 数据源：使用连接池，并加载mysql驱动连接数据库 -->
        <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">
        <!-- 事务管理器：默认JDBC -->
        <transactionManager type="JDBC" />
        <!-- 数据源：使用连接池，并加载mysql驱动连接数据库 -->
        <dataSource type="POOLED">
            <property name="driver" value="com.mysql.cj.jdbc.Driver" />
            <property name="url" value="jdbc:mysql://localhost:3306/mybatis" />
            <property name="username" value="root" />
            <property name="password" value="123456" />
        </dataSource>
    </environment>
</environments>

如果你想连接两个数据库，就需要创建两个 SqlSessionFactory 实例，每个数据库对应一个 SqlSessionFactory 实例

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

如果忽略了环境参数，那么将会加载默认环境，也就是default指定的环境

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>

注意一些关键点:

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

默认环境和环境 ID 顾名思义。环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。

5.1、事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器（也就是 type="[JDBC|MANAGED]"）：

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

如果你正在使用 Spring + MyBatis，则没有必要配置事务管理器，因为 Spring 模块会使用自带的管理器来覆盖前面的配置。

5.2、数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。（修改此值可以使用Druid、c3p0、dbcp等数据库连接池，以后再做详细补充）

大多数 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 上下文的数据源引用。使用的比较少

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

6、映射器（mappers）

MapperRegistry：注册绑定我们的Mapper文件

通过上述配置我们已经配置好MyBatis的行为了，接下来就要来定义SQL映射语句了。首先，我们需要告诉MyBatis到哪里去找这些语句。在自动查找资源方面，Java 并没有提供一个很好的解决方案，所以最好的办法是直接告诉 MyBatis 到哪里去找映射文件。可以使用相对于类路径的资源引用，或类名和包名等。例如：

resource：使用相对于类路径的资源引用 resource="org/mybatis/builder/AuthorMapper.xml"

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

class：使用映射器接口实现类的完全限定类名 class="org.mybatis.builder.AuthorMapper"

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

package：将包内的映射器接口实现全部注册为映射器name="org.mybatis.builder"

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

使用class和package方式需注意：

接口和它的Mapper配置文件必须同名！

接口和它的Mapper配置文件必须在同一个包下

总结：

通过上述配置文件我们可以实现以下功能：

将数据库配置文件外部引入
设置缓存和日志
为实体类指定别名
为项目配置开发、测试和生产环境
设置MyBatis 到哪里去找映射文件

注意：

在配置mybatis-config.xml时，要严格按照配置文件的结构进行配置，可以省略，但是先后顺序必须与配置文件结构一致，否则就会报错

配置的优先级：方法参数传递 > 配置文件 > properties 元素中指定的属性

花生的斯努比

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
Mybatis配置文件解析

对MyBatis的配置文件进行解读
复制链接

扫一扫

专栏目录

Mybatis配置文件解析

Mybatis配置文件解析

1、配置文件的结构

2、属性（properties）

3、设置（settings）

4、类型别名（typeAliases）

5、环境变量（Environments）

5.1、事务管理器（transactionManager）

5.2、数据源（dataSource）

6、映射器（mappers）

总结：

“相关推荐”对你有帮助么？