MyBatis学习笔记（二）。核心配置文件mybatis-config.xml剖析。environments，properties，typeAliases，settings，mappers

配置

官方文档：

https://mybatis.net.cn/configuration.html

在此代码基础上进行的核心配置文件讲解：

https://blog.csdn.net/weixin_45842494/article/details/122725240

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

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

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

注意：这些配置在mybatis-config.xml是有顺序的，不能随意写，按照上面这个顺序就行。

2 环境配置（environments）

MyBatis 可以配置成适应多种环境

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

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。

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

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

3 properties（属性）

我们可以通过properties属性来实现引用配置文件。

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。例如，我们将数据库的一些配置提出来（db.properties）

编写db.properties

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

注意：在properties中连接符为&

在核心配置文件中引入

<properties resource="db.properties">
    <property name="username" value="root"/>
    <property name="password" value="111111"/>
</properties>

注意点：

• 可以直接引用外部文件
• 可以在其中增加一些属性
• 如果两个文件有同一字段，优先使用外部配置文件的（例如这里的password）

4 typeAliases（类型别名）

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

<!-- 可以给实体类型起别名 -->
<typeAliases>
    <typeAlias type="com.xxc.pojo.User" alias="User"/>
</typeAliases>

通过起别名，我们就可以在UserMapper.xml写成如下形式

<select id="getUserList" resultType="User">
    select * from user;
</select>

也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean，这种情况下会使用 Bean 的首字母小写的非限定类名来作为它的别名

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

通过起别名，我们就可以在UserMapper.xml写成如下形式

<select id="getUserList" resultType="user">
    select * from user;
</select>

这里使用user或User均可，官方建议小写。

区别：实体类较少的时候使用typeAlias，实体类较多的时候使用package。
使用package的时候别名不能自定义，如果需要自定义，可以在实体类上使用注解，例如@Alias(“hello”)，那么这个时候别名就是hello，UserMapper.xml中就要写hello。

@Alias("hello")
public class User {}

<select id="getUserList" resultType="hello">
    select * from user;
</select>

附录：

下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的，注意，为了应对原始类型的命名重复，采取了特殊的命名风格。

别名	映射的类型
_byte	byte
_long	long
_short	short
_int	int
_integer	int
_double	double
_float	float
_boolean	boolean
string	String
byte	Byte
long	Long
short	Short
int	Integer
integer	Integer
double	Double
float	Float
boolean	Boolean
date	Date
decimal	BigDecimal
bigdecimal	BigDecimal
object	Object
map	Map
hashmap	HashMap
list	List
arraylist	ArrayList
collection	Collection
iterator	Iterator

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

6 映射器（mappers）

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

方式一：

<!-- 每一个Mapper.xml都需要在MyBatis核心配置文件中注册! -->
<mappers>
    <mapper resource="com/xxc/dao/UserMapper.xml"/>
</mappers>

方式二：

使用class文件绑定注册

<!-- 每一个Mapper.xml都需要在MyBatis核心配置文件中注册! -->
<mappers>
    <mapper class="com.xxc.dao.UserMapper"/>
</mappers>

注意点：接口和他的Mapper配置文件必须同名。接口和他的Mapper配置文件必须在同一个包下。

方式三：

使用扫描包进行注入绑定。

<mappers>
    <package name="com.xxc.dao"/>
</mappers>

注意点：接口和他的Mapper配置文件必须同名。接口和他的Mapper配置文件必须在同一个包下。

最后附上完整核心配置文件及代码结构：

<?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">
        <property name="username" value="root"/>
        <property name="password" value="111111"/>
    </properties>
    <typeAliases>
        <package name="com.xxc.pojo"/>
    </typeAliases>
    <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/xxc/dao/UserMapper.xml"/>-->
        <!--<mapper class="com.xxc.dao.UserMapper"/>-->
        <package name="com.xxc.dao"/>
    </mappers>
</configuration>