mybatis-plus怎么配置逻辑删除

MyBatis-Plus怎么配置逻辑删除

在现代的软件开发中，数据的安全性和完整性是非常重要的。逻辑删除是一种常见的数据管理策略，它通过在数据库中标记记录为“已删除”而不是真正地从数据库中删除记录，来保留数据的历史记录和审计跟踪。MyBatis-Plus 是一个强大的 MyBatis 增强工具，它提供了许多便捷的功能，包括逻辑删除的支持。本文将详细介绍如何在 MyBatis-Plus 中配置逻辑删除。

1. 什么是逻辑删除？

逻辑删除（Logical Delete）是指在数据库中不真正删除记录，而是通过更新某个字段的值来标记该记录为“已删除”。通常，这个字段是一个布尔类型的字段（如 is_deleted），或者是一个时间戳字段（如 delete_time）。逻辑删除的好处是可以保留数据的历史记录，方便后续的审计和恢复操作。

2. MyBatis-Plus 中的逻辑删除

MyBatis-Plus 提供了对逻辑删除的内置支持，开发者可以通过简单的配置来实现逻辑删除功能。MyBatis-Plus 的逻辑删除功能基于全局配置和注解两种方式来实现。

2.1 全局配置

在 MyBatis-Plus 中，可以通过全局配置来启用逻辑删除功能。全局配置适用于整个项目中的所有实体类。

2.1.1 配置步骤

1. 添加依赖：首先，确保你的项目中已经引入了 MyBatis-Plus 的依赖。

 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>最新版本</version> </dependency> 

1. 配置逻辑删除字段：在 application.yml 或 application.properties 文件中配置逻辑删除的字段名和删除标记值。

 mybatis-plus: global-config: db-config: logic-delete-field: is_deleted # 逻辑删除字段名 logic-delete-value: 1 # 逻辑删除标记值（已删除） logic-not-delete-value: 0 # 逻辑未删除标记值（未删除） 

1. 实体类配置：在实体类中，确保逻辑删除字段与配置的字段名一致。

 @Data public class User { private Long id; private String name; private Integer age; private Integer isDeleted; // 逻辑删除字段 } 

1. 测试逻辑删除：在代码中调用 MyBatis-Plus 的 deleteById 或 delete 方法时，MyBatis-Plus 会自动将 is_deleted 字段更新为 1，而不是真正删除记录。

 userMapper.deleteById(1L); // 逻辑删除，将 is_deleted 字段更新为 1 

2.2 注解配置

除了全局配置外，MyBatis-Plus 还支持通过注解的方式为单个实体类配置逻辑删除。

2.2.1 配置步骤

1. 实体类配置：在实体类中使用 @TableLogic 注解标记逻辑删除字段。

 @Data public class User { private Long id; private String name; private Integer age; @TableLogic private Integer isDeleted; // 逻辑删除字段 } 

1. 测试逻辑删除：与全局配置相同，调用 deleteById 或 delete 方法时，MyBatis-Plus 会自动更新 is_deleted 字段。

 userMapper.deleteById(1L); // 逻辑删除，将 is_deleted 字段更新为 1 

2.3 自定义逻辑删除 SQL

在某些情况下，开发者可能需要自定义逻辑删除的 SQL 语句。MyBatis-Plus 提供了 @SqlParser 注解来实现自定义 SQL。

2.3.1 配置步骤

1. 自定义 SQL：在 Mapper 接口中定义自定义的逻辑删除 SQL。

 @Mapper public interface UserMapper extends BaseMapper<User> { @Update("UPDATE user SET is_deleted = 1 WHERE id = #{id}") int logicDeleteById(@Param("id") Long id); } 

1. 调用自定义 SQL：在代码中调用自定义的逻辑删除方法。

 userMapper.logicDeleteById(1L); // 自定义逻辑删除 

3. 逻辑删除的查询

在启用了逻辑删除后，MyBatis-Plus 会自动在查询语句中添加过滤条件，排除已被逻辑删除的记录。例如，执行 selectById 或 selectList 方法时，MyBatis-Plus 会自动添加 WHERE is_deleted = 0 条件。

3.1 查询已被逻辑删除的记录

如果需要查询已被逻辑删除的记录，可以通过自定义 SQL 或使用 @SqlParser 注解来实现。

@Select("SELECT * FROM user WHERE is_deleted = 1") List<User> selectDeletedUsers(); 

4. 逻辑删除的恢复

逻辑删除的记录可以通过更新操作来恢复。例如，将 is_deleted 字段更新为 0。

User user = new User(); user.setId(1L); user.setIsDeleted(0); userMapper.updateById(user); // 恢复逻辑删除的记录 

5. 总结

MyBatis-Plus 提供了简单而强大的逻辑删除功能，开发者可以通过全局配置或注解的方式轻松实现逻辑删除。逻辑删除不仅可以保留数据的历史记录，还能提高数据的安全性和可恢复性。通过本文的介绍，相信你已经掌握了如何在 MyBatis-Plus 中配置和使用逻辑删除功能。在实际开发中，合理使用逻辑删除可以大大提高数据管理的灵活性和安全性。