有关Mybatis-Plus的插件机制

Posted 2022-01-10 一只楠喃

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了有关Mybatis-Plus的插件机制相关的知识，希望对你有一定的参考价值。

插件机制

1. 自动填充
- 1.1原理
- 1.2 基本操作
2. 乐观锁
3 逻辑删除

1. 自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

1.1原理

实现元对象处理器接口：com.baomidou.mybatisplus.core.handlers.MetaObjectHandler，确定填充具体操作
注解填充字段：@TableField(fill = ...) 确定字段填充的时机
- FieldFill.INSERT：插入填充字段
- FieldFill.UPDATE：更新填充字段
- FieldFill.INSERT_UPDATE：插入和更新填充字段

1.2 基本操作

步骤一：修改表添加字段

alter table tmp_customer add column create_time date;
alter table tmp_customer add column update_time date;

步骤二：修改JavaBean

package com.czxy.mp.domain;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;

import java.util.Date;

/**
 * Created by nannan.
 */
@Data
@TableName("tmp_customer")
public class Customer 
    @TableId(type = IdType.AUTO)
    private Integer cid;
    private String cname;
    private String password;
    private String telephone;
    private String money;

    @TableField(value="create_time",fill = FieldFill.INSERT)
    private Date createTime;

    @TableField(value="update_time",fill = FieldFill.UPDATE)
    private Date updateTime;

步骤三：编写处理类

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ldK08LSb-1640089949121)(assets/image-20200914121135941.png)]

package com.czxy.mp.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * Created by nannan.
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler 
    /**
     * 插入填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) 
        this.setFieldValByName("createTime", new Date(), metaObject);
    

    /**
     * 更新填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) 
        this.setFieldValByName("updateTime", new Date(), metaObject);

步骤四：测试

    @Test
    public void testInsert() 
        Customer customer = new Customer();
        customer.setCname("测试888");

        customerMapper.insert(customer);
    

    @Test
    public void testUpdate() 
        Customer customer = new Customer();
        customer.setCid(11);
        customer.setTelephone("999");

        customerMapper.updateById(customer);

2. 乐观锁

2.1 什么是乐观锁

当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败

2.2. 实现

步骤一：修改表结构，添加version字段
步骤二：修改JavaBean，添加version属性

  package com.czxy.mp.domain;
  
  import com.baomidou.mybatisplus.annotation.*;
  import lombok.Data;
  
  /**
   * Created by nannan.
   */
  @Data
  @TableName("tmp_customer")
  public class Customer 
      @TableId(type = IdType.AUTO)
      private Integer cid;
      private String cname;
      private String password;
      private String telephone;
      private String money;
      @Version
      @TableField(fill = FieldFill.INSERT)
      private Integer version;

步骤三：元对象处理器接口添加version的insert默认值 (保证version有数据)

package com.czxy.mp.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * Created by nannan.
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler 
    /**
     * 插入填充
     * @param metaObject
     */
    @Override
    public void insertFill(MetaObject metaObject) 
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("version", 1, metaObject);
    

    /**
     * 更新填充
     * @param metaObject
     */
    @Override
    public void updateFill(MetaObject metaObject) 
        this.setFieldValByName("updateTime", new Date(), metaObject);

步骤四：修改 MybatisPlusConfig 开启乐观锁

package com.czxy.mp.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Created by nannan.
 */
@Configuration
public class MybatisPlusConfig 
     */
    /**
     * 配置插件
     * @return
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor()

        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        // 分页插件
        mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.mysql));
        // 乐观锁
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());

        return mybatisPlusInterceptor;

步骤五：测试
- 先添加一条，保证version有数据
- 在更新该条

    @Test
    public void testUpdate() 
        Customer customer = new Customer();
        customer.setCid(14);
        customer.setCname("测试999");
        // 与数据库中数据一致，将更新成功，否则返回失败。
        customer.setVersion(1);

        int i = customerMapper.updateById(customer);
        System.out.println(i);

2.3 注意事项

支持的数据类型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime
整数类型下 newVersion = oldVersion + 1
newVersion 会回写到 entity 中
仅支持 updateById(id) 与 update(entity, wrapper) 方法
在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

3 逻辑删除

3.1 什么是逻辑删除

逻辑删除，也称为删除。就是在表中提供一个字段用于记录是否删除，实际该数据没有被删除。

3.2 实现

步骤一：修改表结构添加deleted字段

步骤二：修改JavaBean，给deleted字段添加@TableLogic

package com.czxy.mp.domain;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;

/**
 * Created by nannan.
 */
@Data
@TableName("tmp_customer")
public class Customer 
    @TableId(type = IdType.AUTO)
    private Integer cid;
    private String cname;
    private String password;
    private String telephone;
    private String money;
    @Version
    @TableField(fill = FieldFill.INSERT)
    private Integer version;

    @TableLogic
    @TableField(fill = FieldFill.INSERT)
    private Integer deleted;


* 步骤三：添加数据时，设置默认“逻辑未删除值”


```java
  package com.czxy.mp.config;
  
  import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  import org.apache.ibatis.reflection.MetaObject;
  import org.springframework.stereotype.Component;
  
  import java.util.Date;
  
  /**
   * Created by nannan.
   */
  @Component
  public class MyMetaObjectHandler implements MetaObjectHandler 
      /**
       * 插入填充
       * @param metaObject
       */
      @Override
      public void insertFill(MetaObject metaObject) 
          this.setFieldValByName("createTime", new Date(), metaObject);
          this.setFieldValByName("version", 1, metaObject);
          this.setFieldValByName("deleted", 0, metaObject);
      
  
      /**
       * 更新填充
       * @param metaObject
       */
      @Override
      public void updateFill(MetaObject metaObject) 
          this.setFieldValByName("updateTime", new Date(), metaObject);

步骤四：测试

      @Test
      public void testDelete() 
          // 删除时，必须保证deleted数据为“逻辑未删除值”
          int i = customerMapper.deleteById(12);
          System.out.println(i);

3.3 全局配置

如果使用了全局配置，可以不使用注解@TableLogic

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted  # 局逻辑删除的实体字段名
      logic-delete-value: 1  # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

以上是关于有关Mybatis-Plus的插件机制的主要内容，如果未能解决你的问题，请参考以下文章

有关Mybatis-Plus的插件机制

Mybatis-Plus：插件（mybatis的插件机制执行分析插件性能分析插件乐观锁插件）

浅谈MyBatis-Plus学习之插件扩展

mybatis-plus之插件

MyBatis-Plus逆向生成代码