MyBatis-Plus逻辑删除SQL自定义格式化方法详解

背景介绍

MyBatis-Plus作为MyBatis的增强工具，提供了许多便捷功能，其中逻辑删除是一个常用的特性。在3.5.3版本中，开发者可以通过覆盖formatLogicDeleteSql方法来自定义逻辑删除的SQL语句生成逻辑。

问题描述

在实际开发中，有开发者尝试通过继承TableInfo类并覆盖formatLogicDeleteSql方法来自定义逻辑删除SQL，但发现即使添加了@Component注解，自定义逻辑也未被实际调用。

解决方案分析

从MyBatis-Plus的实现机制来看，直接继承TableInfo类并添加@Component注解是不够的，因为MyBatis-Plus有自己的初始化流程。正确的做法是：

1. 升级到最新版本：确保使用的是最新版MyBatis-Plus，以获得最完善的功能支持

2. 实现PostInitTableInfoHandler接口：

   • 这是一个表信息初始化后的处理器接口
   • 通过实现该接口可以介入表信息的初始化过程

3. 注入Spring容器：

   • 将自定义的处理器实现类注册为Spring Bean
   • 这样MyBatis-Plus在初始化时就能识别并使用你的自定义逻辑

实现示例

@Component
public class CustomLogicDeleteHandler implements PostInitTableInfoHandler {

    @Override
    public void postTableInfo(TableInfo tableInfo) {
        // 在这里可以修改tableInfo的逻辑删除SQL生成逻辑
        tableInfo.setLogicDeleteSql(info -> {
            // 自定义的逻辑删除SQL生成逻辑
            return "你的自定义SQL逻辑";
        });
    }
}

技术原理

MyBatis-Plus的表信息初始化流程分为几个阶段：

1. 元数据解析阶段：解析实体类注解和数据库表结构
2. TableInfo构建阶段：构建表信息对象
3. 后处理阶段：调用所有注册的PostInitTableInfoHandler

通过实现PostInitTableInfoHandler，开发者可以在表信息完全构建后、被使用前，对TableInfo进行最后的修改和定制。

注意事项

1. 确保自定义处理器的优先级（如果有多个处理器）
2. 注意线程安全问题，处理器应该是无状态的
3. 自定义SQL要确保语法正确性，避免SQL注入风险
4. 考虑与MyBatis-Plus其他特性的兼容性

总结

通过本文介绍的方法，开发者可以灵活地自定义MyBatis-Plus的逻辑删除SQL生成逻辑，满足各种特殊业务场景的需求。这种扩展方式遵循了MyBatis-Plus的设计理念，既保持了框架的完整性，又提供了足够的灵活性。