MyBatis配置文件中最常用的设置
作者：SadSunset
文章主要介绍了MyBatis配置的优化方法,包括引用外部的properties配置文件、配置外置以实现环境解耦、配置文件中最常用的6个核心设置以及三种常用的Mapper注册方式,感兴趣的朋友跟随小编一起看看吧
MyBatis配置优化
mybatis的配置中引用外部的propertis配置文件
1. 创建外部配置文件
比如 db.properties：
jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/mydb?useSSL=false jdbc.username=root jdbc.password=123456
2. 在mybatis-config.xml中引入：
<?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 文件 -->
<properties resource="db.properties" />
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="mappers/UserMapper.xml"/>
</mappers>
</configuration>✅ resource="db.properties" 表示从 classpath 根路径加载（如 src/main/resources/db.properties）
⚠️ 注意事项
- 不要把密码明文写在代码里
生产环境应使用配置中心（如 Apollo、Nacos）或 K8s Secret，而不是本地.properties。
MyBatis 自动集成，无需手动配mybatis-config.xml。
💡 记住：配置外置 = 环境解耦 = 上线不改代码 = DevOps 友好
xml文件标签的顺序
在 MyBatis 的 mybatis-config.xml（主配置文件）中，标签是有严格顺序要求的；而在 Mapper XML（如 UserMapper.xml）中，除了 <resultMap> 等定义类标签建议放前面外，SQL 标签（<select>、<insert> 等）本身没有顺序限制。
[!NOTE] 补充
很多主流框架的 XML 都有顺序要求，因为它们都基于 DTD 或 XSD 定义了严格的结构。如 Spring XML 配置（applicationContext.xml）—— 有顺序！
MyBatis 别名
两种用法：
- 单个注册（适合少量类）
<typeAlias type="com.example.User" alias="User"/>
```
→ Mapper 中可用 `resultType="User"`
2. **包扫描（推荐）**
```xml
<package name="com.example.model"/>
```
→ 自动注册别名（默认类名首字母小写，如 `user`）；加 `@Alias("User")` 可自定义。
✅ 作用：省去全限定类名，简化 Mapper XML。
### **最常用**的 Java 类型的**默认别名（type alias）**：
|别名（小写）|对应 Java 类型|
|---|---|
|`string`|`java.lang.String`|
|`int` / `_int`|`int`（基本类型）|
|`integer` / `_integer`|`java.lang.Integer`|
|`long` / `_long`|`long`|
|`double` / `_double`|`double`|
|`boolean` / `_boolean`|`boolean`|
|`map`|`java.util.HashMap`|
|`list`|`java.util.ArrayList`|
|`date`|`java.util.Date`|
|`object`|`java.lang.Object`|
> ✅ **带下划线（如 `_int`）表示基本类型，不带下划线（如 `int`）实际映射到包装类（`Integer`）** —— 这是 MyBatis 的约定。
### 示例：
```xml
<select id="getName" resultType="string">
SELECT name FROM user WHERE id = #{id}
</select>
<select id="getIds" resultType="_int">
SELECT id FROM user
</select>💡 记住：开发中优先用包装类别名（如 integer），避免基本类型 null 问题。这些别名全局可用，不用额外配置。
配置文件中最常用和最重要的设置
以下是必须掌握的 6 个核心配置（按优先级排序）：
✅ 1.mapUnderscoreToCamelCase（强烈推荐开启）
<setting name="mapUnderscoreToCamelCase" value="true"/>
- 作用：自动将数据库下划线字段（如
user_name）映射到 Java 驼峰属性（userName）。 - 不设的后果：需手动写
<resultMap>，代码爆炸。
✅ 2.logImpl（开发必备）
<setting name="logImpl" value="SLF4J"/>
- 作用：指定日志框架（SLF4J、LOG4J 等），方便查看 SQL 执行。
- 不设的后果：看不到执行的 SQL，调试困难。
✅ 3.cacheEnabled（默认 true，通常不动）
<setting name="cacheEnabled" value="true"/>
- 作用：开启二级缓存（Mapper 级别）。
- 注意：生产环境慎用，容易因缓存不一致引发 Bug；多数团队用 Redis 替代。
✅ 4.lazyLoadingEnabled+aggressiveLazyLoading
<setting name="lazyLoadingEnabled" value="true"/> <setting name="aggressiveLazyLoading" value="false"/>
- 作用：开启懒加载（关联对象按需查询）。
aggressiveLazyLoading=false：只在访问具体属性时才加载（推荐）。
✅ 5.useGeneratedKeys（常在 XML 中局部设，全局也可）
<setting name="useGeneratedKeys" value="true"/>
- 作用：插入后自动回填数据库自增主键（配合
keyProperty）。 - 更常见做法：在
<insert>标签里单独设置（更精准）。
✅ 6.defaultExecutorType（批量操作时注意）
<setting name="defaultExecutorType" value="REUSE"/> <!-- 或 BATCH -->
- 默认是
SIMPLE BATCH：用于大批量插入/更新（配合SqlSession手动提交）。
🚫 避坑建议：
- 不要乱开二级缓存（
cacheEnabled虽默认开，但实际常禁用）。 - 务必开
mapUnderscoreToCamelCase—— 这是 MyBatis 最香的功能之一。 - 日志实现（
logImpl）要和项目日志体系一致（Spring Boot 默认集成好，可不设）。
💡 极简推荐配置（90% 场景够用）：
<settings> <setting name="mapUnderscoreToCamelCase" value="true"/> <setting name="logImpl" value="SLF4J"/> </settings>
其他设置按需调整，**先掌握这两个。
Mapper（映射器）
三种常用方式，按推荐度排序如下：
✅ 方式一：通过 Mapper 接口注册（最推荐）
<mappers> <package name="com.example.mapper"/> </mappers>
- 要求：XML 文件名和接口名一致，且在同一包下（如
UserMapper.java+UserMapper.xml）。 - 优点：批量注册，简洁；配合 Spring Boot 自动扫描更高效。
- 适用：主流开发方式（接口 + XML）。
✅ 方式二：通过 XML 文件路径注册
<mappers> <mapper resource="mappers/UserMapper.xml"/> </mappers>
- 说明：
resource从 classpath 根路径开始写。 - 适用：纯 MyBatis 项目，或 XML 与接口不在同包时。
✅ 方式三：通过 Mapper 接口全限定类名注册（不推荐）
<mappers> <mapper class="com.example.mapper.UserMapper"/> </mappers>
- 要求：SQL 必须用 注解 写在接口里（如
@Select），不能搭配 XML（除非 XML 路径也正确且同名）。 - 适用：简单 SQL 用注解的场景。
⚠️ 注意：
- 方式一（
<package>）是大厂最常用，尤其配合 Maven/Gradle 标准目录结构。 - 如果同时用 XML 和接口，必须保证命名和路径匹配，否则报错“找不到 mapper”。
- 在 Spring / Spring Boot 中，通常用
@MapperScan("com.example.mapper")，无需在mybatis-config.xml里配<mappers>。
📌 一句话总结：
优先用
<package>扫描接口包；纯 XML 用resource；注解 Mapper 用class。
到此这篇关于MyBatis配置文件的文章就介绍到这了,更多相关mybatis配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！