今天开始接触了MyBatis-Plus，所以来简单记录下是如何使用的。
一、快速开始
1.导入依赖
com.baomidou
mybatis-plus-boot-starter
3.0.5
mysql
mysql-connector-java
org.projectlombok
lombok
2.创建实体类
@Data
public class User {
/*
@TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
@TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
*/
private Long id;
private String name;
private Integer age;
private String email;
}
该实体类中使用了lembok,所以会自动生成set,get方法
3.创建dao层
因为只是先简单演示下MyBatis-Plus的用法，所以这里直接先创建DAO层，用于单元测试
package com.atguigu.mpdemo1010.mapper;
import com.atguigu.mpdemo1010.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Repository;
/**
* @Author su mingxin
* @Date 2020/9/15 11:12
*
* IDEA在@Autowried userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。
* 为了避免报错，可以在 dao 层 的接口上添加 @Repository
*/
@Repository
public interface UserMapper extends BaseMapper {
}
这里的DAO层接口直接继承BaseMapper,类型为User,这样，就直接可以使用MyBatis-Plus所提供的CRUD。
4.单元测试
package com.atguigu.mpdemo1010;
import com.atguigu.mpdemo1010.entity.User;
import com.atguigu.mpdemo1010.mapper.UserMapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import javax.jws.soap.SOAPBinding;
import java.util.Arrays;
import java.util.List;
@RunWith(SpringRunner.class)
@SpringBootTest
public class Mpdemo1010ApplicationTests {
@Autowired
private UserMapper userMapper;
//查询
@Test
public void selectUser() {
List users = userMapper.selectList(null);
for (User user:users){
System.out.println(user);
}
}
//添加
@Test
public void insertUser(){
User user = new User();
user.setName("岳不群");
user.setAge(56);
user.setEmail("[email protected]");
userMapper.insert(user);
}
//修改
@Test
public void updateUser(){
User user = new User();
user.setId(1305766050880610306L); //因为id是Long类型
user.setAge(110);
userMapper.updateById(user);
}
//删除
@Test
public void deleteUser(){
userMapper.deleteById(1305787376383143938L);
}
}
5.数据库
image.png
二、自动填充
当我们在插入或修改一条数据时，某种情境下，我们可能希望在插入或修改之后，能够自动往数据库中填充该条记录的创建或修改时间。
此时有两种常用的方法：
1.在进行insert或update前，手动set记录的创建或修改时间
user.setCreateTime(new Data());
user.setUpdateTime(new Data());
2.若你使用了mybatis-plus，我们就可以使用其提供的自动填充功能。
首先，在实体类中添加相应字段，并添加@TableField注解
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
//该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
}
然后，创建一个handler，设置自动填充的内容和和填充字段
/**
* @Author su mingxin
* @Date 2020/9/15 15:03
* 该类实现MetaObjectHandler接口，设置createTime和updateTime的值，用于在添加或修改操作时进行自动填充
* 不要忘记@Component注解，将该类交给spring管理
*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//使用mybatis-plus进行insert操作时才会起作用
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//使用mybatis-plus进行update操作时才会起作用
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
这样，我们在新添加一条记录或者修改一条记录时，就会往数据库中自动填充创建时间或修改时间。
若想自动填充其他字段，也可这样设置。
三、乐观锁
乐观锁我在这里就不多说了。MyBatis-Plus也为我们提供了乐观锁。
1.往表中添加一个version属性，目的是为了对记录的修改操作进行控制。当多人同时对同一记录进行操作时，若version不对，则不允许修改。
image.png
2.往实体类中添加version属性，并添加@Version注解
@Data
public class User {
/*
@TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
@TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
*/
private Long id;
private String name;
private Integer age;
private String email;
//该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;//版本号 用于乐观锁
}
这里我使用了mybatis-plus的自动填充，让每次新增一条记录时，数据库中对应记录的version都为1。当然，若是不想这样用的话，也可以在数据库中设置该字段的默认值。
3.新建一个配置类MyConfig，添加乐观锁插件
@Configuration
@MapperScan("com.atguigu.mpdemo1010.mapper")
public class MyConfig {
/**
* 乐观锁插件
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
4.单元测试
//测试乐观锁
@Test
public void testOptimisticLock(){
User user = userMapper.selectById(1305774986337775617L);
user.setAge(180);
userMapper.updateById(user);
}
四、SQL性能分析
MyBatis-Plus还提供了有关SQL性能分析插件
需要在自定义配置类MyConfig中进行插件的添加
/**
* SQL 执行性能分析插件
* 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
* dev:开发环境
* test:测试环境
* prod:生产环境
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
添加该插件后，当执行SQL时，就可以在控制台中看见插件对SQL执行的监控
五、逻辑删除
逻辑删除就是将记录从项目中移除不再显示，但是数据库中依旧保有该记录
1.在表中添加deleted字段，用来标记逻辑删除状态。
image.png
2.在实体类中添加该字段，并使用@TableLogic注解，标记该字段为逻辑删除的标记。
@Data
public class User {
/*
@TableId(type = IdType.ID_WORKER) mybatis-plus自带的id生成策略，生成19位的值，适用于数值类型的主键
@TableId(type = IdType.ID_WORKER_STR) mybatis-plus自带的id生成策略，生成19位的值，适用于字符串类型的主键
若是使用mybatis-plus且没有指定主键生成策略，会自动根据主键类型选择生成策略
*/
private Long id;
private String name;
private Integer age;
private String email;
//该注解为mybatis-plus的自动填充（与MetaObjectHandler配合使用）
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;//版本号 用于乐观锁
@TableLogic
private Integer deleted;//逻辑删除标记
}
3.在自定义配置类中，添加逻辑删除插件
/**
* 逻辑删除插件
*/
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
4.单元测试
//删除（逻辑删除）
@Test
public void deleteUser(){
userMapper.deleteById(1305787376383143938L);
}
image.png
被逻辑删除的记录的deleted字段就会改变为非默认值，随后再在项目中进行查询时除非添加查询条件外，mybatis-plus的默认查询语句是不会查询被逻辑删除的字段。
（这里，我在数据库中将deleted属性默认值设为0）
六、mybatis-plus复杂条件查询
//mp实现复杂查询操作
@Test
public void testSelectQuery(){
//创建QueryWrapper对象
QueryWrapper wrapper = new QueryWrapper<>();
//通过QueryWrapper设置条件
//ge,gt,le,lt
//查询age>=30记录
// wrapper.ge("age",30);
//eq,ne
//查询名字不为Lucy的记录
// wrapper.ne("name","Lucy");
//between
//查询年龄在15-30之间的记录
// wrapper.between("age",15,30);
//like
//模糊查询
// wrapper.like("name","J");
//orderByDesc
//根据id进行排序(Desc降序,ASC升序)
// wrapper.orderByDesc("id");
//last
//在SQL语句最后拼接SQL
// wrapper.last("limit 1");
//指定要查询的列
wrapper.select("id","name");
List users = userMapper.selectList(wrapper);
System.out.println(users);
}
七、mybatis-plus的分页实现
@Test
public void testPage(){
/*
1.创建page对象，传入两个参数:当前页 和 每页显示记录数
2.调用mp分页查询方法；调用mp分页查询过程中，底层封装 分页用到的所有数据都封装到page对象里面
*/
Page page = new Page<>(1,3);
userMapper.selectPage(page,null);
//通过page对象获取分页数据
System.out.println(page.getCurrent());//当前页
System.out.println("======================================");
System.out.println(page.getRecords());//每页数据list集合
System.out.println("======================================");
System.out.println(page.getSize());//每页显示记录数
System.out.println("======================================");
System.out.println(page.getTotal());//总记录数
System.out.println("======================================");
System.out.println(page.getPages());//总页数
System.out.println(page.hasNext());//表示是否有下一页
System.out.println(page.hasPrevious());//表示是否有上一页
}
八、自动生成代码
自动生成代码的教程可以参考官方介绍
这里我转载了其他大哥的技术博客，以供学习，感谢分享