MyBatis配置介绍

一、MyBatis依赖和约束

1.1 MyBatis依赖

要使用 MyBatis,只需将mybatis-x.x.x.jar jar包引入即可,或者使用Maven来构建项目

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>3.4.5</version>
</dependency>
//版本号根据实际情况自己定义

1.2 Mybatis XML约束文件

<!-- config约束 -->
<?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">

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

约束文件附件：📎mybatis-3-mapper.dtd📎mybatis-3-config.dtd

二、MyBatis的主配置文件

2.1 环境的配置

MyBatis 可以配置多种环境，例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。如果你想连接多个数据库，就需要创建多个 SqlSessionFactory 实例，每个数据库对应一个。

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

为了指定创建哪种环境，只要将它作为可选的参数传递给 SqlSessionFactoryBuilder 即可。如果忽略了环境参数，那么默认环境将会被加载。默认的环境和环境 ID 是自解释的，你可以对环境随意命名，但一定要保证默认的环境 ID 要匹配其中一个环境 ID。可以接受环境配置的两个方法签名是：

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, "环境的ID");

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, "环境的ID", properties);

2.1.1 主配置文件模板

<?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>
    <!--默认使用的环境ID-->
    <environments default="development">
        <!--每一个environment定义的环境ID-->
        <environment id="development">
          
            <!--配置事务管理器-->
            <transactionManager type="JDBC">
                <property name="" value=""/>
            </transactionManager>
            
            <!--配置数据源-->
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/demo"/>
                <property name="username" value="root"/>
                <property name="password" value="339869"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

2.2 事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器【type="[JDBC|MANAGED]"】

  • JDBC :这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
  • MANAGED : 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期。默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。例如:
<transactionManager type="MANAGED">
  <property name="closeConnection" value="false"/>
</transactionManager>

如果你正在使用Spring + MyBatis，则不需要配置事务管理器， 因为Spring模块会使用自带的管理器来覆盖前面的配置。这两种事务管理器类型都不需要设置任何属性。它们其实是类型别名，你可以使用 TransactionFactory 接口的实现类的完全限定名或类型别名代替它们。

public interface TransactionFactory {
  default void setProperties(Properties props) {
    // Since 3.5.2, change to default method
  }
  Transaction newTransaction(Connection conn);
  Transaction newTransaction(DataSource dataSource, TransactionIsolationLevel level, boolean autoCommit);
}

任何在 XML 中配置的属性在实例化之后将会被传递给 setProperties() 方法。你也需要创建一个 Transaction 接口的实现类，这个接口也很简单：

public interface Transaction {
  Connection getConnection() throws SQLException;
  void commit() throws SQLException;
  void rollback() throws SQLException;
  void close() throws SQLException;
  Integer getTimeout() throws SQLException;
}

使用这两个接口，你可以完全自定义 MyBatis 对事务的处理。

2.3 数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。许多 MyBatis 的应用程序会按示例中的例子来配置数据源。虽然这是可选的，但为了使用延迟加载，数据源是必须配置的。有三种内建的数据源类型【type=”[UNPOOLED|POOLED|JNDI]"】

2.3.1 UNPOOLED

UNPOOLED这个数据源的实现只是每次被请求时打开和关闭连接。虽然有点慢，但对于在数据库连接可用性方面没有太高要求的简单应用程序来说，是一个很好的选择。 不同的数据库在性能方面的表现也是不一样的，对于某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。UNPOOLED 类型的数据源具有以下属性：

driver

JDBC 驱动的 Java 类的完全限定名（并不是 JDBC 驱动中可能包含的数据源类）

url

数据库的 JDBC URL 地址

username

数据库的用户名

password

数据库的密码

defaultTransactionIsolationLevel默认的连接事务隔离级别。

defaultNetworkTimeout

The default network timeout value in milliseconds to wait for the database operation to complete. See the API documentation of java.sql.Connection#setNetworkTimeout() for details.

encoding=UTF8

作为可选项，你也可以传递属性给数据库驱动。只需在属性名加上“driver.”前缀即可，例如：driver.encoding=UTF8。这将通过 DriverManager.getConnection(url,driverProperties) 方法传递值为 UTF8 的 encoding 属性给数据库驱动。

2.3.2 POOLED

这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。这是一种使得并发 Web 应用快速响应请求的流行处理方式。除了上述提到 UNPOOLED 下的属性外，还有更多属性用来配置 POOLED 的数据源：

poolMaximumActiveConnections

在任意时间可以存在的活动连接数量，默认值：10

poolMaximumIdleConnections

任意时间可能存在的空闲连接数。

poolMaximumCheckoutTime

在被强制返回之前,池中连接被检出(checked out)时间,默认值:20000毫秒.

 

poolTimeToWait

这是一个底层设置，如果获取连接花费了相当长的时间,连接池会打印状态日志并重新尝试获取一个连接(避免在误配置的情况下一直安静的失败),默认值:20000毫秒.

poolMaximumLocalBadConnectionTolerance

这是一个关于坏连接容忍度的底层设置， 作用于每一个尝试从缓存池获取连接的线程。 如果这个线程获取到的是一个坏的连接，那么这个数据源允许这个线程尝试重新获取一个新的连接，但是这个重新尝试的次数不应该超过 poolMaximumIdleConnections 与 poolMaximumLocalBadConnectionTolerance 之和。 默认值：3 （新增于 3.4.5）

poolPingQuery

发送到数据库的侦测查询，用来检验连接是否正常工作并准备接受请求。默认是“NO PING QUERY SET”，这会导致多数数据库驱动失败时带有一个恰当的错误消息。

poolPingEnabled

是否启用侦测查询。若开启，需要设置 poolPingQuery 属性为一个可执行的 SQL 语句（最好是一个速度非常快的 SQL 语句），默认值：false。

poolPingConnectionsNotUsedFor

配置 poolPingQuery 的频率。可以被设置为和数据库连接超时时间一样，来避免不必要的侦测，默认值：0（即所有连接每一时刻都被侦测 — 当然仅当 poolPingEnabled 为 true 时适用）。

2.3.3 JNDI

这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。这种数据源配置只需要两个属性：

initial_context

这个属性用来在 InitialContext 中寻找上下文（即，initialContext.lookup(initial_context)）。这是个可选属性，如果忽略，那么将会直接从 InitialContext 中寻找 data_source 属性。

data_source

这是引用数据源实例位置的上下文的路径。提供了 initial_context 配置时会在其返回的上下文中进行查找，没有提供时则直接在 InitialContext 中查找。

和其他数据源配置类似，可以通过添加前缀“env.”直接把属性传递给初始上下文。比如：env.encoding=UTF8。

这就会在初始上下文实例化时往它的构造方法传递值为 UTF8 的 encoding 属性

你可以通过实现接口 org.apache.ibatis.datasource.DataSourceFactory 来使用第三方数据源：

public interface DataSourceFactory {
  void setProperties(Properties props);
  DataSource getDataSource();
}

org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory 可被用作父类来构建新的数据源适配器，比如下面这段插入 C3P0 数据源所必需的代码：

import org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory;
import com.mchange.v2.c3p0.ComboPooledDataSource;
public class C3P0DataSourceFactory extends UnpooledDataSourceFactory {
  public C3P0DataSourceFactory() {
    this.dataSource = new ComboPooledDataSource();
  }
}

为了令其工作，记得为每个希望 MyBatis 调用的 setter 方法在配置文件中增加对应的属性。 下面是一个可以连接至 PostgreSQL 数据库的例子：

<dataSource type="org.myproject.C3P0DataSourceFactory">
  <property name="driver" value="org.postgresql.Driver"/>
  <property name="url" value="jdbc:postgresql:mydb"/>
  <property name="username" value="postgres"/>
  <property name="password" value="root"/>
</dataSource>

2.4 mappers标签

该标签的作用是加载映射文件

2.4.1 方式一 <mapper resource=""/>

该方式是加载相对于类路径下的映射文件(接口与xml文件必须是同一级目录)

 <mappers>
        <mapper resource="sqlmap/User.xml"/>
 </mappers>

2.4.2 方式二 <mapper url=""/>

该方式使用全限定路径

<mapper url="file:///D:\workspace_spingmvc\mybatis_01\config\sqlmap\User.xml" />

2.4.3 方式三：<mapper class=""/>

该方式使用mapper接口的全限定类名。Mapper接口Mapper映射文件名称相同且在同一个目录下。

<mapper class="cn.sps.lc.mapper.UserMapper"/>

2.4.4 方式四 <package name=""/>

    该方式是加载指定包下的所有映射文件,Mapper接口Mapper映射文件名称相同且在同一个目录下。

<package name="cn.lc.mybatis.mapper"/>