Mybatis Plus 使用@TableLogic实现逻辑删除

今天药忘吃喽~ 2024-03-17 09:11 51阅读 0赞

#### 文章目录 ####

*   *  步骤1:修改数据库表添加\`deleted\`列
     *  步骤2:实体类添加属性
     *  步骤3:运行删除方法
     *  知识点1：@TableLogic

接下来要讲解是删除中比较重要的一个操作，逻辑删除，先来分析下问题:

![1631246806130][]

*  这是一个员工和其所签的合同表，关系是一个员工可以签多个合同，是一个一(员工)对多(合同)的表
 *  员工ID为1的张业绩，总共签了三个合同，如果此时他离职了，我们需要将员工表中的数据进行删除，会执行delete操作
 *  如果表在设计的时候有主外键关系，那么同时也得将合同表中的前三条数据也删除掉
    
    ![1631246997190][]
 *  后期要统计所签合同的总金额，就会发现对不上，原因是已经将员工1签的合同信息删除掉了
 *  如果只删除员工不删除合同表数据，那么合同的员工编号对应的员工信息不存在，那么就会出现垃圾数据，就会出现无主合同，根本不知道有张业绩这个人的存在
 *  所以经过分析，我们不应该将表中的数据删除掉，而是需要进行保留，但是又得把离职的人和在职的人进行区分，这样就解决了上述问题，如:
    
    ![1631247188218][]
 *  区分的方式，就是在员工表中添加一列数据`deleted`，如果为0说明在职员工，如果离职则将其改完1，（0和1所代表的含义是可以自定义的）

所以对于删除操作业务问题来说有:

*  物理删除:业务数据从数据库中丢弃，执行的是delete操作
 *  逻辑删除:为数据设置是否可用状态字段，删除时设置状态字段为不可用状态，数据保留在数据库中，执行的是update操作

MP中逻辑删除具体该如何实现?

### 步骤1:修改数据库表添加`deleted`列 ###

字段名可以任意，内容也可以自定义，比如`0`代表正常，`1`代表删除，可以在添加列的同时设置其默认值为`0`正常。

![1631247439168][]

### 步骤2:实体类添加属性 ###

(1)添加与数据库表的列对应的一个属性名，名称可以任意，如果和数据表列名对不上，可以使用@TableField进行关系映射，如果一致，则会自动对应。

(2)标识新增的字段为逻辑删除字段，使用`@TableLogic`

@Data
    //@TableName("tbl_user") 可以不写是因为配置了全局配置
    public class User {
        
        @TableId(type = IdType.ASSIGN_UUID)
        private String id;
        private String name;
        @TableField(value="pwd",select=false)
        private String password;
        private Integer age;
        private String tel;
        @TableField(exist=false)
        private Integer online;
        @TableLogic(value="0",delval="1")
        //value为正常数据的值，delval为删除数据的值
        private Integer deleted;
    }

### 步骤3:运行删除方法 ###

@SpringBootTest
    class Mybatisplus03DqlApplicationTests {
        
    
        @Autowired
        private UserDao userDao;
    	
        @Test
        void testDelete(){
        
           userDao.deleteById(1L);
        }
    }

![1631247818327][]

从测试结果来看，逻辑删除最后走的是update操作，会将指定的字段修改成删除状态对应的值。

**思考**

逻辑删除，对查询有没有影响呢?

*  执行查询操作
    
        @SpringBootTest
        class Mybatisplus03DqlApplicationTests {
              
        
            @Autowired
            private UserDao userDao;
        	
            @Test
            void testFind(){
              
               System.out.println(userDao.selectList(null));
            }
        }
    
    运行测试，会发现打印出来的sql语句中会多一个查询条件，如:
    
    ![1631248019999][]
    
    可想而知，MP的逻辑删除会将所有的查询都添加一个未被删除的条件，也就是已经被删除的数据是不应该被查询出来的。
 *  如果还是想把已经删除的数据都查询出来该如何实现呢?
    
        @Mapper
        public interface UserDao extends BaseMapper<User> {
              
            //查询所有数据包含已经被删除的数据
            @Select("select * from tbl_user")
            public List<User> selectAll();
        }
 *  如果每个表都要有逻辑删除，那么就需要在每个模型类的属性上添加`@TableLogic`注解，如何优化?
    
    在配置文件中添加全局配置，如下:
    
        mybatis-plus:
          global-config:
            db-config:
              # 逻辑删除字段名
              logic-delete-field: deleted
              # 逻辑删除字面值：未删除为0
              logic-not-delete-value: 0
              # 逻辑删除字面值：删除为1
              logic-delete-value: 1

介绍完逻辑删除，逻辑删除的本质为:

**逻辑删除的本质其实是修改操作。如果加了逻辑删除字段，查询数据时也会自动带上逻辑删除字段。**

执行的SQL语句为:

UPDATE tbl_user SET deleted=1 where id = ? AND deleted=0

执行数据结果为:

![1631248494929][]

### 知识点1：@TableLogic ###

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>@TableLogic</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>类型</td> 
   <td>属性注解</td> 
  </tr> 
  <tr> 
   <td>位置</td> 
   <td>模型类中用于表示删除字段的属性定义上方</td> 
  </tr> 
  <tr> 
   <td>作用</td> 
   <td>标识该字段为进行逻辑删除的字段</td> 
  </tr> 
  <tr> 
   <td>相关属性</td> 
   <td>value：逻辑未删除值<br>delval: 逻辑删除值</td> 
  </tr> 
 </tbody> 
</table>

[1631246806130]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/b700d91fd3134513bf7b0f77411b6010.png
[1631246997190]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/05589049da5d4cfa843a5d8d807452a5.png
[1631247188218]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/e9635d687c5f424591b0e1008d191eab.png
[1631247439168]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/1d742e9adac74bfb83a0bdec9f4f7f02.png
[1631247818327]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/3936e3013675470abb9959674732d0bb.png
[1631248019999]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/d758e64f1c9b4b1180f0881306a612c5.png
[1631248494929]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/1d374143f1f84cd1b496475b0abd5365.png