还不会用Mybatis-Plus?快看全网最通俗易懂的MyBatis-Plus讲解（扩展）

前言

继上一篇入门的文章介绍后，本章主要介绍的是Mybatis-plus的一些常用的扩展功能
学习MyBatis-Plus就看这个（入门）

逻辑删除

现在我们对记录的删除大多数其实只是伪删除，表中有一个已删除/未删除的字段，删除只是把状态字段修改一下，没有真正删除，但是我们每次写Sql都要判断删除的条件，where delete=0这样的，有的时候忘记了写了就会查询半天。

Mybatis-plus为我们想到了这个问题，这个逻辑删除的功能就能解决这个问题

为了验证这个功能，我们给User表增加一个status字段，默认值为0

一、增加yaml配置信息

在原先的配置文件中追加上以下的配置信息，指定全局的删除状态字段名status，和已删除的值和未删除的值

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: status  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

二、在实体类字段上加上@TableLogic注解

如果使用的mybatis-plus版本是3.3.0之后的，就可以不用配置下面这个属性

@TableLogic
private Integer status;

三、执行删除语句

boolean b = userService.removeById(5L);
System.out.println(b);

输出的结果其实只是去更新删除状态而已，并不是去真正的删除

==>  Preparing: UPDATE user SET status=1 WHERE id=? AND status=0 
==> Parameters: 5(Long)
<==    Updates: 1

自动填充功能

有没遇到这么个场景，在操作进行插入或者更新操作的时候，需要对记录的创建时间和更新时间都要做操作，这种繁琐的内容完全就是多余的，而自动填充就是解决这个问题的，在插入的时候他会自动帮你注入创建时间的值，更新的时候会自动帮你填充更新时间的值。

一、给User表中增加create_time和update_time字段

二、给实体类加上注解

在插入或者更新操作的时候，给对象的属性加上 @TableField注解，在插入的时候会自动帮我们填充上数据

@Data
public class User {
	...
    //给createTime加入TableField注解并标识为INSERT，这样在User对象进行插入的时候，会自动帮我们填充值
    @TableField(fill = FieldFill.INSERT)
    private String createTime;
    //给updateTime加入TableField注解并标识为UPDATE，这样在User对象进行更新的时候，会自动帮我们填充值
    @TableField(fill = FieldFill.UPDATE)
    private String updateTime;
}

三、增加填充配置类

创建一个自动填充配置类，实现MetaObjectHandler接口，实现插入和更新两个回调，这两个回调会在你的User对象插入或者更新的时候触发对应的方法，我们也只需要在方法里指定好字段名和要填充的值即可

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        this.strictInsertFill(metaObject, "createTime", String.class, getDateTime()); // 起始版本 3.3.0(推荐使用)
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.strictUpdateFill(metaObject, "updateTime", String.class, getDateTime()); // 起始版本 3.3.0(推荐)
    }

    public String getDateTime() {
        return new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date());
    }
}

四、测试

@Test
public void tableField(){
	//插入操作
    User user = new User();
    user.setId(12L);
    user.setAge(12);
    user.setEmail("123333@163@.com")
    user.setName("张三");
    userMapper.insert(user);
    //更新操作
    user.setAge(15);
    userMapper.updateById(user);
}

输出结果如下，可以看到我们的代码中并没有设置创建时间和修改时间，他在插入和更新的时候根据我们配置类中指定的方法，自动填充到了Sql的实体中了

INSERT INTO user ( id, name, age, email, status, create_time ) VALUES ( ?, ?, ?, ?, ?, ? ) 
12(Long), 张三(String), 12(Integer), 123333@163@.com(String), 0(Integer), 2021-05-11 05:34:19(String)
1
    
UPDATE user SET name=?, age=?, email=?, create_time=?, update_time=? WHERE id=? AND status=0 
张三(String), 15(Integer), 123333@163@.com(String), 2021-05-11 05:34:19(String), 2021-05-11 05:34:21(String), 12(Long)
1

Sql 注入器

我们使用MP帮我们注入的一系列通用的CRUD的方法，我们如果想实现自己的一些通用方法要如何实现呢，就可以用这个Sql注入器进行扩张。

一、创建自定义Mapper类

首先创建我们自定义的Mapper类，继承BaseMapper，并定义我们自己的接口方法

public interface MyBaseMapper<T> extends BaseMapper<T> {
	//请求列表数据
    List<T> getList();
}

二、定义接口实现类

创建对应接口方法实现类，继承AbstractMethod，保证方法名是一致的，然后根据自定要求组装Sql语句

public class MysqlInsertAllBatch extends AbstractMethod {
    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
        String sqlMethod = "getList";//方法名
        String sql = "select * from " + tableInfo.getTableName();//sql语句
        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return this.addSelectMappedStatementForTable(mapperClass, sqlMethod, sqlSource, tableInfo);
    }
}

三、声明自定义Sql注入器类

创建我们自定义的Sql注入器类，并注册给Spring容器，并且在回调方法中把我们的接口实现方法注入进去，这样使用mapper类的时候就可以调用我们自己的方法了

@Configuration
public class MySqlInjector extends DefaultSqlInjector {

    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass);
        //把我们的接口实现类注入进去，需要增加新的方法可以继续add
        methodList.add(new MysqlInsertAllBatch());
        return methodList;
    }
}

四、测试

@Autowired
private MyBaseMapper myBaseMapper;

@Test
public void customSql() {
    List<User> userList = myBaseMapper.getList();
    for (User user : userList) {
        System.out.println(user.getName());
    }
}

输出

123
123
张三
...

项目示例

这里提供了本文章介绍的项目示例，想要验证的可以下载下来调用一下
项目源码

个人公众号
喜欢的可以关注我的公众号，不定期会发布相关技术的文章