一、介绍
MyBatis-Plus 提供了丰富的配置选项,以满足不同用户的需求。这些配置中,一部分继承自 MyBatis 原生支持的配置,另一部分则是 MyBatis-Plus 特有的扩展配置。
在 Spring Boot 项目中,可以通过 application.yml 或 application.properties 文件来配置 MyBatis-Plus。
刚才也提到, M P 的配置选项很丰富,但是我们先了解一些常见的配置,后续根据不同的需求进行查找配置,而且MP大多数有默认配置,我们一般保持默认就行,没有默认值但是我们需要的也会在接下来介绍。
二、 常见配置
1、yaml文件配置整体布局
mybatis-plus:
configuration:
# MyBatis 配置
map-underscore-to-camel-case: true
global-config:
# 全局配置
db-config:
# 数据库配置
id-type: auto
2、configLocation
- 类型:String
- 默认值:null
指定 MyBatis 配置文件的位置。如果有单独的 MyBatis 配置文件,应将其路径配置到 configLocation。
配置示例:
mybatis-plus:
config-location: classpath:/mybatis-config.xml
解释:
-
什么时候用到这个配置?
答:有单独的MyBatis配置文件时,将这个文件路径配置进来。 -
什么是单独的MyBatis配置文件?
答:是指定一个自定义的 MyBatis 配置文件(如 mybatis-config.xml),这个文件允许你进行更细致的配置,覆盖或扩展 MyBatis 的默认行为。例如,如果你需要使用 MyBatis 的分页插件或其他第三方插件,需要在配置文件中进行配置。 -
classpath 代表什么?
答:表示配置文件位于类路径下的根目录,通常是src/main/resources
3、mapperLocations
- 类型:String[]
- 默认值:[“classpath*:/mapper/**/*.xml”]
指定 MyBatis Mapper 对应的 XML 文件位置。如果在 Mapper 中有自定义方法,需要配置此项。
配置示例:
mybatis-plus:
mapper-locations: classpath:/mapper/**.xml
注意:
对于 Maven 多模块项目,扫描路径应以 classpath*: 开头,以加载多个 JAR 包中的 XML 文件。
在这个xml配置文件中手写SQL,利用上面的配置就可以让MP 扫描到这个文件。
下面这个是UserMapper.xml,实际上的SQL语句比这个更复杂才会手写SQL语句。
<?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.itheima.mp.mapper.UserMapper">
<select id="queryById" resultType="User">
SELECT * FROM user WHERE id = #{id}
</select>
</mapper>
4、typeAliasesPackage
- 类型:String
- 默认值:null
指定 MyBatis 别名包扫描路径,用于给包中的类注册别名。注册后,在 Mapper 对应的 XML 文件中可以直接使用类名,无需使用全限定类名。
配置示例:
mybatis-plus:
type-aliases-package: com.your.domain
5、globalConfig
mybatis-plus:
global-config:
db-config:
table-prefix: tbl_ # 设置全局表前缀
id-type: auto # 全局id类型为自增长
# 有Mapper接口中定义的表名都会自动添加tbl_前缀。例如,如果有一个Mapper接口中定义了一个名为user的表,实际操作的表名将会是tbl_user。
我感觉目前只需要介绍这几个,剩下的我们根据需求在学习,到MP整个学习完以后再来看更多的配置