MyBatis Plus 注解方式如何实现动态SQL？

Question

在使用 MyBatis Plus 进行数据库操作时，开发者常常面临一个关键技术问题：如何在不编写 XML 文件的前提下，通过注解方式实现动态 SQL 查询？虽然 MyBatis Plus 提供了强大的 Wrapper 构建条件，但在某些复杂业务场景下仍需自定义动态 SQL。那么，在 MyBatis Plus 中，如何结合 @SelectProvider、@UpdateProvider 等注解与 Java 方法拼接动态 SQL 语句？如何利用 MyBatis 的 Provider API 实现灵活的条件判断和 SQL 拼接？同时需要注意哪些线程安全与可维护性问题？

Answer 1

MyBatis Plus 中通过注解实现动态 SQL 查询的深度解析

在使用 MyBatis Plus 进行数据库操作时，开发者常常面临一个关键技术问题：如何在不编写 XML 文件的前提下，通过注解方式实现动态 SQL 查询？虽然 MyBatis Plus 提供了强大的 Wrapper 构建条件，但在某些复杂业务场景下仍需自定义动态 SQL。本文将从浅入深，逐步讲解如何结合 @SelectProvider、@UpdateProvider 等注解与 Java 方法拼接动态 SQL 语句，并探讨线程安全与可维护性等关键问题。

1. 基础概念：MyBatis 的 Provider 注解机制

MyBatis 提供了 Provider API，允许开发者通过 Java 类的方法来动态生成 SQL 语句。这种方式可以完全替代 XML 配置文件中的 SQL 定义，尤其适用于需要根据运行时参数动态构建 SQL 的场景。

主要注解包括：

• @SelectProvider：用于指定查询语句的提供类和方法。
• @UpdateProvider：用于更新操作。
• @InsertProvider：用于插入操作。
• @DeleteProvider：用于删除操作。

这些注解的基本用法是通过指定一个类（通常是 SQL 构造器类）和一个方法名，由该方法返回最终的 SQL 字符串。

2. 示例演示：构建动态 SELECT 查询

假设我们有一个用户表 user，需要根据传入的参数动态筛选用户信息。

public class UserSqlProvider {
    public String selectUsers(@Param("name") String name, @Param("age") Integer age) {
        return new SQL() {{
            SELECT("*");
            FROM("user");
            if (name != null) {
                WHERE("name LIKE CONCAT('%', #{name}, '%')");
            }
            if (age != null) {
                WHERE("age = #{age}");
            }
        }}.toString();
    }
}

对应的 Mapper 接口如下：

public interface UserMapper extends BaseMapper<User> {
    @SelectProvider(type = UserSqlProvider.class, method = "selectUsers")
    List<User> selectUsers(String name, Integer age);
}

这样就可以根据传入的参数动态生成 SQL，避免了冗余的条件判断逻辑。

3. 深入分析：SQL 构建方式的选择与优化

MyBatis 提供了多种 SQL 构建方式，开发者可以根据需求选择：

方式	适用场景	优点	缺点
XML 配置	复杂 SQL 或大量动态条件	结构清晰，易于维护	需要额外维护 XML 文件
Java 注解 + Provider	中等复杂度，逻辑较简单	代码集中，便于版本控制	SQL 可读性略差
Wrapper 构建器	简单的条件拼接	简洁、类型安全	不支持复杂 SQL 拼接

对于需要高度定制化的 SQL 场景，推荐使用 Provider 方式，它既保持了 Java 的面向对象特性，又具备良好的扩展性和灵活性。

4. 线程安全与可维护性考虑

在使用 Provider 模式时，需要注意以下几点以确保系统的稳定性和可维护性：

• 线程安全：SQL 构建方法应避免使用共享变量或状态，建议将每个 SQL 构建方法设计为无状态的静态方法或实例方法。
• 可测试性：将 SQL 构建逻辑独立封装到 Provider 类中，便于单元测试和 Mock 测试。
• 日志记录：建议在开发阶段打印生成的 SQL，以便调试和验证逻辑是否正确。
• 性能优化：避免频繁创建字符串拼接对象，推荐使用 StringBuilder 或 MyBatis 内置的 SQL 类进行构建。

5. 结合 MyBatis Plus 的 Wrapper 与 Provider 实现混合查询

MyBatis Plus 提供的 Wrapper 是一种非常便捷的条件构造方式，但在复杂查询中仍可能不够灵活。此时，可以通过结合 Wrapper 和 Provider 实现更复杂的逻辑。

例如，可以先使用 Wrapper 构建基础查询条件，再通过 Provider 补充额外的 SQL 片段。

public interface CustomUserMapper {
    @SelectProvider(type = CustomUserProvider.class, method = "selectByWrapper")
    List<User> selectByWrapper(@Param(Constants.WRAPPER) Wrapper<User> wrapper);
}

在 Provider 类中，可以获取 Wrapper 并转换为 SQL 条件：

public class CustomUserProvider {
    public String selectByWrapper(Wrapper<User> wrapper) {
        String sqlSegment = wrapper.getTargetSql();
        return "SELECT * FROM user WHERE " + sqlSegment;
    }
}

这种方式可以在保留 Wrapper 简洁性的前提下，扩展出更多自定义逻辑。