Mybatis 配置文件

本文最后更新于:2024年9月8日 晚上

Mybatis 配置文件

  • mybatis-config.xml 系统核心配置文件。
  • MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。
    • configuration(配置)
    • properties(属性)
    • settings(设置)
    • typeAliases(类型别名)
    • typeHandlers(类型处理器)
    • objectFactory(对象工厂)
    • plugins(插件)
    • environments(环境配置)
    • environment(环境变量)
    • transactionManager(事务管理器)
    • dataSource(数据源)
    • databaseIdProvider(数据库厂商标识)
    • mappers(映射器)
  • 注意:元素节点的顺序不对会报错。

environments

environment

  • 具体的一套环境,通过设置id进行区别, id保证唯一。
  • 配置MyBatis的多套运行环境,将SQL映射到多个不同的数据库上,必须指定其中一个为默认运行环境(通过default指定)
1
2
3
4
5
6
7
8
9
10
11
<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>

dataSource

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

  • 数据源是必须配置的。

  • 有三种内建的数据源类型。

    1
    <dateSource type="[UNPOOLED|POOLED|JNDI]">
  • unpooled:这个数据源的实现只是每次被请求时打开和关闭连接。

  • pooled:这种数据源的实现利用"池”的概念将 JDBC 连接对象组织起来,这是一种使得并发 Web 应用快速响应请求的流行处理方式。

  • jndi:这个数据源的实现是为了能在如 Spring 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置一个 JNDI 上下文的引用。

  • 数据源也有很多第三方的实现,比如dbcp, c3p0, druid

transactionManager

  • 这两种事务管理器类型都不需要设置任何属性。
1
<transactionManager type="[ JDBC | MANAGED ]"/>

mappers

  • 映射器:定义映射SQL语句文件。
  • 首先需要告诉 MyBatis 到哪里去找到这些语句,可以使用相对于类路径的资源引用,或完全限定资源定位符(包括 file:// 的 URL),或类名和包名等。
  • 映射器是MyBatis中最核心的组件之一,在MyBatis 3之前,只支持xml映射器,即:所有的SQL语句都必须在xml文件中配置,而从MyBatis 3开始,还支持接口映射器,这种映射器方式允许以Java代码的方式注解定义SQL语句。

用相对于类路径的资源引用

1
2
3
<mappers>
<mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>

使用完全限定资源定位符(URL)

1
2
3
<mappers>
<mapper url="file://var/mappers/AuthorMapper.xml"/>
</mappers>

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

  • 需要配置文件名称和接口名称一致,并且位于同一目录下。
1
2
3
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
</mappers>

将包内的映射器接口实现全部注册为映射器

  • 但是需要配置文件名称和接口名称一致,并且位于同一目录下。
1
2
3
<mappers>
<package name="org.mybatis.builder"/>
</mappers>

Mapper文件

1
2
3
4
5
6
7
<?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">
<mapper namespace="com.example.mapper.UserMapper">

</mapper>
  • namespace
    • namespace的命名必须跟某个接口同名(包名+类名)
      • 接口中的方法与映射文件中sql语句id一一对应。

Properties

  • 数据库这些属性都是可外部配置且可动态替换的,既可以在典型的 Java 属性文件中配置,亦可通过 properties 元素的子元素来传递。
  1. 在资源目录下新建一个db.properties
1
2
3
4
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf8
username=root
password=123456
  1. 将文件导入properties 配置文件。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<configuration>
<!--导入properties文件-->
<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>
</environments>
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
</configuration>

typeAliases

  • 类型别名是为 Java 类型设置一个短的名字,它只和 XML 配置有关,存在的意义仅在于用来减少类完全限定名的冗余。
1
2
3
4
<!--配置别名,注意顺序-->
<typeAliases>
<typeAlias type="com.example.entity.User" alias="User"/>
</typeAliases>
  • 当这样配置时, User可以用在任何使用com.example.entity.User的地方。
  • 也可以指定一个包名, MyBatis 会在包名下面搜索需要的 Java Bean,比如:
1
2
3
<typeAliases>
<package name="com.example.entity"/>
</typeAliases>
  • 每一个在包 com.example.entity 中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。
  • 若有注解,则别名为其注解值,见下面的例子:
1
2
3
4
@Alias("user")
public class User {
...
}

settings

  • Mybatis配置。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<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>

typeHandlers

  • 无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时,都会用类型处理器将获取的值以合适的方式转换成 Java 类型。
  • 你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型,[了解即可]

objectFactory

  • MyBatis 每次创建结果对象的新实例时,它都会使用一个对象工厂(ObjectFactory)实例来完成。
  • 默认的对象工厂需要做的仅仅是实例化目标类,要么通过默认构造方法,要么在参数映射存在的时候通过有参构造方法来实例化。
  • 如果想覆盖对象工厂的默认行为,则可以通过创建自己的对象工厂来实现。

本博客所有文章除特别声明外,均采用 CC BY-SA 4.0 协议 ,转载请注明出处!