mybatis配置解析

疯狂的小鸡仔

已于 2022-11-27 17:37:27 修改

阅读量1.4k

点赞数 1

文章标签： mybatis java

于 2022-11-27 17:01:16 首次发布

本文链接：https://blog.csdn.net/m0_52896041/article/details/128066093

版权

1 核心配置文件：mybatis-config.xml

1.1核心配置文件

核心配置文件名一般为：mybatis-config.xml

说明：必须按这个顺序配置，否则错误。

· configuration (配置)

· properties（属性）

· setting（设置）

· typeAliases（类型别名）

· typeHandlers（类型处理器）

· objectFactory（对象工厂）

· plugins（插件）

· environments（环境配置）

        · environment（环境变量）

                · transactionManager（事务管理器）

                · dataSource（数据源）

· databaseldProvider（数据库厂商表示）

· mappers（映射器）

1.2 核心配置文件的作用

mybatis的配置文件包含了影响Mybatis行为的设置和属性信息。

2 环境配置

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

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

所以，如果你想连接两个数据库，就需要创建两个SqlSessionFactory实例，每个数据库对应一个。而如果是三个数据库，就需要三个实例，依次类推。

2.1 格式介绍

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

说明：

environments default="development"：默认使用哪个环境
<environment id="development">：环境配置ID指定环境名称
<transactionManager type="JDBC"/>：事务管理类型JDBC
<dataSource type="POOLED">：数据源配置，默认为POOLED，其他的为cp30数据库连接池等。
<property name="driver" value="${driver}"/>：驱动程序加载
<property name="url" value="${url}"/>：数据库URL
<property name="username" value="${username}"/>：用户名
<property name="password" value="${password}"/>：密码

注意关键点：

1）默认使用的环境ID（比如：default="development"）

2）每个environment元素定义的环境ID（比如：id="development"）

3）事务管理器的配置（比如：ttype="JDBC"）

4）数据源的配置（比如：type="POOLED"）

2.2 具体介绍

事务管理器（transactionManager）

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

· JDBC -- 这个配置直接使用了JDBC的提交和回滚设施，他依赖从数据源获得的连接来管理事务作用域。

· MANAGED -- 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如JEE应用服务器的上下文）。默认情况下它会关闭连接。然而一些容器并不会希望连接被关闭，因此需要将closeConnection属性设置为false来阻止默认的关闭行为。例如：

<transactionManage type="MANAGED">
    <property name="closeConnection" value="false"/>
</transactionManage>

数据源（dataSource）

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

有三种内建的数据源类型（也就是 type="[UNPOOLED|POOLED|JNDI]"）:

环境配置案例1：

<environments default="yj">		//设置当前项目使用哪个环境
		<environment id="development">		//环境1
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/xsgl?serverTimezone=UTC&amp;useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>

        <environment id="yj">			//环境2
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/xsgl?serverTimezone=UTC&amp;useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>

3 属性(properties)配置

<properties>是一个配置属性的元素，该元素通常用来将内部的配置外在化，即通过外部的配置来动态的替换内部定义的属性。例如，数据库的连接等属性，就可以通过典型的Java属性文件中的配置来替换，具体方式如下：

第一步：在resource下建 db.properties 文件

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/jxgl?serverTimezone=UTC
username=root
password=

第二步：在mybatis文件中引用配置文件db.properties ：

`<properties resource="db.properties"/>`

<?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="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>
        
                <environment id="yj">			//环境2
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url"
                          value="jdbc:mysql://localhost:3306/xsgl?serverTimezone=UTC&amp;useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"/>
                <property name="username" value="root"/>
                <property name="password" value=""/>
            </dataSource>
        </environment>
    </environments>
<mappers>
    <mapper resource="yj/com/mapper/UserMapper.xml"/>
</mappers>
</configuration>

4 类型别名（typeAliases）

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

格式一：配置类名，一个类配置一个别名

<typeAliases>
	<typeAlias type="fq.com.pojo.User" alias="User"/>
</typeAliases>

第二步：修改UserMapper文件内容

将所有yj.com.pojo.User改为User

<mapper namespace="yj.com.mapper.UserMapper">
        <select id="getUserList" resultType="User">
        select * from xsgl.user;
    </select>
</mapper>

格式二：配置包名格式：可以配置一个包，MyBatis会在包名下面搜索需要的Java Bean。

特点：类名：在没有注解的情况下，会使用Bean的首字母小写的非限定类名来作为它的别名

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

第二步：修改UserMapper文件内容

<mapper namespace="yj.com.mapper.UserMapper">
        <select id="getUserList" resultType="user">   
        select * from xsgl.user;
    </select>
</mapper>

注意：resultType="user"，类名首字母小写。

格式三：实体类中使用注解

@Alias("user")      注解方式
public class User {
    private  int     id;
    private  String  name;
    private  String   pwd;
    private  int      age;

}

5 映射器（mapper）

注册绑定我们的UserMapper.xml文件的。

格式一：使用相对于类路径的资源引用

<mappers>
 <mapper resource="yj/com/mapper/UserMapper.xml"/>
</mappers>

格式二：使用映射器接口实现类的完全限定类名

<mappers>    <mapper class="yj.com.mapper.UserMapper"/></mappers>

格式三：使用包名配置

<mappers>
    <package name="yj.com.mapper" />
</mappers>

测试功能：修改完之后返回测试代码进行测试。

6 设置（settings）

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

格式：

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

说明：

设置名	描述	有效值	默认值
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)
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）	一个类型别名或完全限定类名。	未设置
shrinkWhitespacesInSql	从SQL中删除多余的空格字符。请注意，这也会影响SQL中的文字字符串。 (新增于 3.5.5)	true \| false	false
defaultSqlProviderType	Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.	A type alias or fully qualified class name