mybatis配置文件解析

 核心配置文件

• mybati-config.xml
• MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 配置文档的顶层结构如下：

configuration（配置）

• properties（属性）

• settings（设置）

• typeAliases（类型别名）

• typeHandlers（类型处理器）

• objectFactory（对象工厂）

• plugins（插件）

• environments（环境配置）

  • environment（环境变量）
    • transactionManager（事务管理器）
    • dataSource（数据源）

• databaseIdProvider（数据库厂商标识）

• mappers（映射器）------->指定映射文件的位置

  • package属性（将包内的映射器接口实现全部注册为映射器）

  • mapper属性

    • class（使用映射器接口实现类的完全限定类名）
    • url (使用完全限定资源定位符url)
    • resource（ 使用相对于类路径的资源引用）

<?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>
    <!--environment 元素体中包含了事务管理和连接池的配置。-->
    <!--开发环境可以是多套的-->
    <typeAliases>
        <package name="com.xuan.pojo"/>
    </typeAliases>
    <environments default="development">
        <environment id="development">
            <!--事务管理器-->
            <transactionManager type="JDBC"/>
            <!--数据源-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <!--useSSL是协议 后面两个是设置字符集UTF-8  最后是设置时区（mysql8以上都需要）-->
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=UTC"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!-- mappers 元素则包含了一组映射器（mapper），这些映射器的 XML 映射文件包含了 SQL 代码和映射定义信息。-->
    <mappers>
        <mapper resource="com/xuan/mapper/UserMapper.xml"/>
    </mappers>
</configuration>

环境配置（environments）

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。

欢迎添加博主v新：xl95998，参与技术交流

• 开发、测试和生产环境需要有不同的配置；
• 或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。

不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。

每个数据库对应一个 SqlSessionFactory 实例

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。可以接受环境配置的两个方法签名是：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
//不加环境参数environment默认加载配置文件的
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, properties);

 properties属性

• 这些属性可以在外部进行配置，并可以**进行动态替换。**你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。

 ​ 第一步：编写配置文件db.properties

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useSSL=true&useUnicode=true&characterEncoding=UTF-8
username=root
password=root  

​ 第二步：在主配置文件mybatis-config.xml中引入外部配置文件

• 他这是要按照一定顺序配置的属性才能生效的properties标签写在configuration下第一个

<!--引入外部配置文件-->
<properties resource="db.properties"></properties>

​ 第三步：将数据源配置修改问外部引用

<dataSource type="POOLED">
    <property name="driver" value="${driver}"/>
    <!--useSSL是协议 后面两个是设置字符集UTF-8  最后是设置时区（mysql8以上都需要）-->
    <property name="url" value="${url}"/>
    <property name="username" value="${username}"/>
    <property name="password" value="${password}"/>
</dataSource>

environmentenvironment的id属性

• 默认环境和环境 ID 顾名思义。 环境可以随意命名，但务必保证默认的环境 ID 要匹配其中一个环境 ID。
• 默认使用的环境 ID（比如：default=“development”）。

事务管理器（transactionManager）

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

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

<transactionManager type="MANAGED">
  <!--不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。-->
  <property name="closeConnection" value="false"/>
</transactionManager>

数据源（dataSource）(了解)

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

• 如果要启用延迟加载特性，就必须配置数据源。

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

• UNPOOLED:这个数据源的实现会每次请求时打开和关闭连接。对某些数据库来说，**使用连接池并不重要，**这个配置就很适合这种情形。UNPOOLED 类型的数据源仅仅需要配置以下 5 种属性：
  • driver – 这是 JDBC 驱动的 Java 类全限定名（并不是 JDBC 驱动中可能包含的数据源类）。
  • url – 这是数据库的 JDBC URL 地址。
  • username – 登录数据库的用户名。
  • password – 登录数据库的密码。
  • defaultTransactionIsolationLevel – 默认的连接事务隔离级别。
  • defaultNetworkTimeout – 等待数据库操作完成的默认网络超时时间（单位：毫秒）。查看java.sql.Connection#setNetworkTimeout() 的 API 文档以获取更多信息。
• POOLED:种数据源的实现**利用“池”**的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行，能使并发 Web 应用快速响应请求。
  • 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 上下文的数据源引用。**这种数据源配置只需要两个属性：
  • nitial_context – 这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性。
  • data_source – 这是引用数据源实例位置的上下文路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。
     

设置（settings）

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

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

类型别名（typeAliases）

• 类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写。
• typeAlias里的alias属性指定的是别名的名字 type属性指定的是实体类的全限定类型

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/> 
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

• 也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean

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

  指定后怎么用？ resultType就是返回值类型在不指定别名的前提下需要写全限定类名

<!--resultType返回类型-->
<select id="findAll" resultType="user">
    select * from mybatis.user
</select>

• 也可以通过注解来实现

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

最后

以上就是如意火龙果为你收集整理的mybatis配置文件解析的全部内容，希望文章能够帮你解决mybatis配置文件解析所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。