TkMybatis：tkmapper功能扩展逻辑删除

原创

已于 2023-06-08 09:34:54 修改 · 1.1k 阅读

于 2023-06-02 17:41:47 首次发布

文章介绍了在项目中因tk.mapper组件版本较低不支持逻辑删除，而通过自定义注解LogicDelete、扩展SqlHelper、提供者ExtBaseProvider以及创建ExtBaseMapper来实现逻辑删除的功能。主要步骤包括定义逻辑删除注解、更新字段处理、动态SQL生成以及定制Mapper接口。

前言

项目中的数据删除需要执行逻辑删除，而不是物理删除，由于项目中数据访问层使用的tkmapper组件版本比较低，暂不支持逻辑删除操作（新版本已经支持），在此基础上通过tk提供的扩展自定义逻辑删除处理功能。

自定义扩展

POM引入库

<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.20</version>
</dependency>

<!-- https://mvnrepository.com/artifact/tk.mybatis/mapper-spring-boot-starter -->
<dependency>
  <groupId>tk.mybatis</groupId>
  <artifactId>mapper-spring-boot-starter</artifactId>
  <version>2.0.4</version>
</dependency>

新增注解LogicDelete

代码如下：

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义逻辑删除注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({
   
   ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface LogicDelete {
   
   

    /**
     * 正常的值：由于数据库使用的是number类型，所以我这边写默认值为0
     */
    String value() default "0";

    /**
     * 删除的值：由于数据库使用的是number类型，所以我这边写默认值为1
     */
    String devval() default "1";

}