MybatisPlus的各种功能使用笔记综合！
目录
零、MybatisPlus特性：
- 无侵入，损耗小，强大的CRUD操作。
- 支持Lambda形式调用，支持多种数据库。
- 支持主键自动生成，支持ActiveRecord模式。
- 支持自定义全局通用操作，支持关键词自动转义。
- 内置代码生成器，分页插件，性能分析插件。
- 内置全局拦截插件，内置sql注入剥离器。
一、快速开始
前置准备：本文所有代码样例包括数据库脚本均已上传至码云：https://gitee.com/tqbx/springboot-samples-learn
- 引入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.0</version>
</dependency>
- 配置yml
spring:
# mysql数据库连接
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:p6spy:mysql://localhost:3306/eblog?serverTimezone=GMT%2B8
username: xxx
password: xxx
# mybatis配置
mybatis-plus:
mapper-locations:
- classpath*:mapper/*.xml
# logging
logging:
level:
root: warn
com.hyh.mybatisplus.mapper: trace
pattern:
console: '%p%m%n'
- 编写MybatisPlus的配置
@Configuration
@MapperScan("com.hyh.mybatisplus.mapper")
public class MybatisPlusConfig {
}
- 编写测试方法
@Test
void selectById() {
User user = mapper.selectById(1087982257332887553L);
System.out.println(user);
}
二、常用注解
当遇到不可抗拒因素导致数据库表与实体表名或字段名不对应时，可以使用注解进行指定。
@Data
@ToString
@TableName("user") //指定表名 也可以使用table-prefix
public class User {
@TableId //指定主键
private Long id;
@TableField("name") //指定字段名
private String name;
private String email;
private Integer age;
private Long managerId;
@TableField("create_time")
private Date createTime;
@TableField(exist = false)//备注[数据库中无对应的字段]
private String remark;
}
三、排除非表字段的三种方式
假设实体中存在字段且该字段只是临时为了存储某些数据，数据库表中并没有，此时有三种方法可以排除这类字段。
- 使用transient修饰字段，此时字段无法进行序列化，有时会不符合需求。
- 使用static修饰字段，此时字段就归属于类了，有时不符合需求。
以上两种方式在某种意义下，并不能完美解决这个问题，为此，mp提供了下面这种方式：
@TableField(exist = false)//备注[数据库中无对应的字段]
private String remark;
四、MybatisPlus的查询
博客地址：https://www.cnblogs.com/summerday152/p/13869233.html
代码样例地址：spring-boot-mybatis-plus学习
五、分页插件使用
文档地址：分页插件使用
我们这里采用SpringBoot的注解方式使用插件：
@Configuration
@MapperScan("com.hyh.mybatisplus.mapper")
public class MybatisPlusConfig {
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
@Bean
public ConfigurationCustomizer configurationCustomizer() {
return configuration -> configuration.setUseDeprecatedExecutor(false);
}
}
测试分页：
@Test
public void selectPage(){
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.ge("age",26);
//Page<User> page = new Page<>(1,2);
Page<User> page = new Page<>(1,2,false);
Page<User> p = mapper.selectPage(page, queryWrapper);
System.out.println("总页数: " + p.getPages());
System.out.println("总记录数: " + p.getTotal());
List<User> records = p.getRecords();
records.forEach(System.out::println);
}
七、MyBatisPlus代码生成器整合
文档地址：MyBatisPlus代码生成器整合
MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：
- 添加代码生成器依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.0</version>
</dependency>
八、ActiveRecord模式
- 实体类需要继承Model类。
- mapper继承BaseMapper。
- 可以将实体类作为方法的调用者。
@Test
public void selectById(){
User user = new User();
User selectById = user.selectById(1319899114158284802L);//新对象
System.out.println(selectById == user); //false
System.out.println(selectById);
}
九、主键策略
十、MybatisPlus的配置
文档地址：https://mybatis.plus/config/#基本配置
Springboot的使用方式
mybatis-plus:
......
configuration:
......
global-config:
......
db-config:
......
mapperLocations
- 类型：
String[] - 默认值：
["classpath*:/mapper/**/*.xml"]
MyBatis Mapper 所对应的 XML 文件位置，如果您在 Mapper 中有自定义方法(XML 中有自定义实现)，需要进行该配置，告诉 Mapper 所对应的 XML 文件位置。
Maven 多模块项目的扫描路径需以 classpath*: 开头 （即加载多个 jar 包下的 XML 文件）
十一、通用Service
/**
* Service接口,继承IService
* @author Summerday
*/
public interface UserService extends IService<User> {
}
/**
* Service实现类,继承ServiceImpl,实现接口
* @author Summerday
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}
@RunWith(SpringRunner.class)
@SpringBootTest
public class ServiceTest {
@Autowired
UserService userService;
/**
* 链式查询
*/
@Test
public void chain() {
List<User> users = userService
.lambdaQuery()
.gt(User::getAge, 25)
.like(User::getName, "雨")
.list();
for (User user : users) {
System.out.println(user);
}
}
}
十二、逻辑删除功能
十三、自动填充
十四、乐观锁插件
博客地址：MybatisPlus的乐观锁插件使用！
十五、SQL分析打印
地址: 执行 SQL 分析打印，该插件有性能损耗，不建议生产环境使用。
- 引入maven依赖
<dependency>
<groupId>p6spy</groupId>
<artifactId>p6spy</artifactId>
<version>最新版本</version>
</dependency>
- 配置application.yml
spring:
datasource:
driver-class-name: com.p6spy.engine.spy.P6SpyDriver #p6spy 提供的驱动类
url: jdbc:p6spy:mysql://localhost:3306/eblog?serverTimezone=GMT%2B8 #url 前缀为 jdbc:p6spy
...
- spy.properties配置
#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2
如何在控制台打印sql语句的执行结果？
<== Columns: id, content, authorAvatar
<== Row: 2, <<BLOB>>, /res/images/avatar/0.jpg
<== Row: 1, <<BLOB>>, /res/images/avatar/default.png
<== Total: 2
配置mybatis-plus.configuration.log-impl为org.apache.ibatis.logging.stdout.StdOutImpl
十六、多租户的使用
博客地址：MybatisPlus的多租户插件使用！
十七、动态表名
添加配置 DynamicTableNameInnerInterceptor
@Configuration
@MapperScan("com.baomidou.mybatisplus.samples.dytablename.mapper")
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
DynamicTableNameInnerInterceptor dynamicTableNameInnerInterceptor = new DynamicTableNameInnerInterceptor();
HashMap<String, TableNameHandler> map = new HashMap<String, TableNameHandler>(2) {{
put("user", (sql, tableName) -> {
String year = "_2018";
int random = new Random().nextInt(10);
if (random % 2 == 1) {
year = "_2019";
}
return tableName + year;
});
}};
dynamicTableNameInnerInterceptor.setTableNameHandlerMap(map);
interceptor.addInnerInterceptor(dynamicTableNameInnerInterceptor);
return interceptor;
}
}
测试随机访问user_2018和user_2019
@SpringBootTest
class SampleTest {
@Autowired
private UserMapper userMapper;
@Test
void test() {
// 自己去观察打印 SQL 目前随机访问 user_2018 user_2019 表
for (int i = 0; i < 6; i++) {
User user = userMapper.selectById(1);
System.err.println(user.getName());
}
}
}
