mybatis-config.xml是mybatis框架的核心主配置文件,用于定义框架的全局运行参数,包括数据库连接信息、类型别名、插件、映射器注册等内容,所有mybatis相关的全局配置都需要在这个文件中完成。
mybatis-config.xml的基础结构
mybatis-config.xml有固定的文档结构和标签顺序,配置时需要按照官方规定的顺序编写标签,否则会解析报错。基础结构如下:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://www.ipipp.com/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 配置内容写在这里 -->
</configuration>
其中<configuration>是根标签,所有配置项都必须放在这个标签内部,DOCTYPE声明用于指定配置文件的约束规则,保证配置格式的正确性。
核心配置项详解
1. 环境配置environments
environments标签用于配置数据库连接相关的环境,可以配置多个环境,通过default属性指定默认使用的环境。每个环境内部需要配置事务管理器和数据源。
<configuration>
<environments default="development">
<environment id="development">
<!-- 事务管理器,type为JDBC表示使用JDBC原生的事务管理 -->
<transactionManager type="JDBC"/>
<!-- 数据源,type为POOLED表示使用mybatis自带的连接池 -->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/test_db?useSSL=false&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
</configuration>
事务管理器除了JDBC类型,还可以配置为MANAGED,表示由容器管理事务,比如整合Spring框架时通常使用这种方式。数据源除了POOLED,还有UNPOOLED表示不使用连接池,JNDI表示从容器获取数据源。
2. 类型别名typeAliases
typeAliases标签用于给Java类设置别名,配置后可以在映射文件中直接使用别名代替全类名,简化代码编写。有两种配置方式:
- 给单个类设置别名:使用<typeAlias>标签,type指定类的全路径,alias指定别名
- 批量扫描包设置别名:使用<package>标签,name指定包路径,该包下的所有类默认别名为类名首字母小写
<typeAliases>
<!-- 单个类配置别名 -->
<typeAlias type="com.example.pojo.User" alias="User"/>
<!-- 批量扫描包,该包下的类默认别名为类名首字母小写 -->
<package name="com.example.pojo"/>
</typeAliases>
3. 映射器配置mappers
mappers标签用于注册SQL映射文件,告诉mybatis去哪里找映射文件,有四种常见的注册方式:
| 配置方式 | 说明 |
|---|---|
| resource | 指定类路径下的映射文件路径,比如mapper/UserMapper.xml |
| url | 指定磁盘路径或者网络路径的映射文件,比如file:///D:/mapper/UserMapper.xml |
| class | 指定映射器接口的全类名,要求映射文件和接口同名同包 |
| package | 批量扫描指定包下的所有映射器接口,同样要求映射文件和接口同名同包 |
最常用的配置方式是resource和package,示例如下:
<mappers>
<!-- 注册单个映射文件 -->
<mapper resource="mapper/UserMapper.xml"/>
<!-- 批量扫描mapper包下的所有映射文件 -->
<package name="com.example.mapper"/>
</mappers>
4. 其他常用配置
除了上述核心配置,mybatis-config.xml还支持很多其他配置项:
- settings:用于配置mybatis的全局行为,比如开启驼峰命名自动映射、开启二级缓存等
- plugins:用于配置mybatis的插件,比如分页插件PageHelper就需要在该标签下注册
- typeHandlers:用于配置自定义类型处理器,处理Java类型和数据库类型的转换
开启驼峰命名映射的配置示例:
<settings>
<!-- 开启驼峰命名自动映射,比如数据库字段user_name自动映射到Java属性userName -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
完整配置示例
以下是一个可以直接使用的mybatis-config.xml完整配置示例,包含了常用的配置项:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://www.ipipp.com/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 全局设置 -->
<settings>
<setting name="mapUnderscoreToCamelCase" value="true"/>
<setting name="cacheEnabled" value="true"/>
</settings>
<!-- 类型别名 -->
<typeAliases>
<package name="com.example.pojo"/>
</typeAliases>
<!-- 环境配置 -->
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://127.0.0.1:3306/test_db?useSSL=false&serverTimezone=UTC"/>
<property name="username" value="root"/>
<property name="password" value="123456"/>
</dataSource>
</environment>
</environments>
<!-- 映射器注册 -->
<mappers>
<package name="com.example.mapper"/>
</mappers>
</configuration>
配置完成后,就可以通过该文件构建SqlSessionFactory,进而获取SqlSession操作数据库。如果后续需要添加新的配置项,只需要按照标签顺序在对应位置添加即可,注意不要打乱标签的先后顺序。
mybatismybatis_config_xmlORM框架数据库配置修改时间:2026-06-25 20:15:47