一、引言：MyBatis-Plus的灵活性与挑战

MyBatis-Plus作为MyBatis的增强工具，通过内置的Wrapper机制（如QueryWrapper、LambdaQueryWrapper）显著简化了SQL构建过程。然而，在实际开发中，开发者常面临以下挑战：

1. 复杂SQL需求：当业务逻辑涉及多表关联、动态条件或特殊函数时，Wrapper的链式调用可能无法满足需求。
2. 代码重复问题：相似查询逻辑在不同模块中重复编写，维护成本高。
3. 性能优化需求：手动编写的SQL可能未充分利用数据库索引，导致查询效率低下。

本文将聚焦于MyBatis-Plus Wrapper自定义SQL与模板生成技术，探讨如何通过代码生成与自定义模板解决上述问题。

二、MyBatis-Plus Wrapper自定义SQL实现

1. 核心机制：@Select注解与XML映射

MyBatis-Plus允许通过注解或XML文件直接编写自定义SQL。例如，实现一个多表关联查询：

@Mapper
public interface UserMapper extends BaseMapper<User> {
    @Select("SELECT u.*, d.department_name " +
            "FROM user u LEFT JOIN department d ON u.dept_id = d.id " +
            "WHERE u.status = #{status}")
    List<UserWithDept> selectUsersWithDept(@Param("status") Integer status);
}

优势：

• 完全控制SQL逻辑，支持复杂查询。
• 可直接使用数据库函数（如DATE_FORMAT、CONCAT）。

局限性：

• 需手动维护SQL字符串，易出错。
• 动态条件处理需结合<if>标签或@SelectProvider。

2. 动态SQL生成：@SelectProvider

通过@SelectProvider注解，可动态生成SQL。例如：

public class UserSqlProvider {
    public String selectUsersByCondition(Map<String, Object> params) {
        return new SQL() {{
            SELECT("*");
            FROM("user");
            if (params.get("status") != null) {
                WHERE("status = #{status}");
            }
            if (params.get("name") != null) {
                WHERE("name LIKE CONCAT('%', #{name}, '%')");
            }
        }}.toString();
    }
}
@Mapper
public interface UserMapper {
    @SelectProvider(type = UserSqlProvider.class, method = "selectUsersByCondition")
    List<User> selectUsersByCondition(Map<String, Object> params);
}

适用场景：

• 条件动态变化的查询。
• 避免XML中大量<if>标签导致的可读性下降。

三、MyBatis-Plus自定义模板生成

1. 模板引擎选择：Velocity/Freemarker

MyBatis-Plus支持通过模板引擎生成实体类、Mapper接口及XML文件。以Velocity为例，配置templatePath指向自定义模板目录：

mybatis-plus:
  global-config:
    db-config:
      id-type: auto
  configuration:
    template-path: /templates

2. 自定义模板示例：生成带自定义SQL的Mapper

在/templates/mapper.xml.vm中定义模板：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${package.Mapper}.${table.mapperName}">
    <!-- 基础CRUD由MyBatis-Plus自动生成 -->
    <select id="selectCustom" resultType="${package.Entity}.${entity}">
        SELECT * FROM ${table.name}
        WHERE 1=1
        #if($condition.status != null)
            AND status = #{condition.status}
        #end
    </select>
</mapper>

关键点：

• ${table.name}：表名变量。
• #if()：Velocity条件判断语法。
• 可结合@TableName注解实现表名动态映射。

3. 代码生成器配置

通过AutoGenerator配置自定义模板：

AutoGenerator generator = new AutoGenerator();
// 配置模板引擎
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setMapper("/templates/mapper.xml.vm");
generator.template(templateConfig);
// 执行生成
generator.execute();

效果：

• 生成的Mapper文件包含自定义SQL方法。
• 保持与MyBatis-Plus风格一致，降低学习成本。

四、进阶实践：结合Wrapper与自定义SQL

1. 混合使用场景

在复杂查询中，可结合Wrapper与自定义SQL。例如：

@Select("SELECT * FROM user ${ew.customSqlSegment}")
List<User> selectByWrapper(@Param(Constants.WRAPPER) Wrapper<User> wrapper);

调用时：

LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(User::getStatus, 1)
       .like(User::getName, "张");
userMapper.selectByWrapper(wrapper);

原理：

• ${ew.customSqlSegment}会被替换为WHERE status = 1 AND name LIKE '%张%'。

2. 性能优化建议

1. 索引利用：在自定义SQL中确保条件字段有索引。
2. 分页处理：结合Page对象实现物理分页：

   @Select("SELECT * FROM user ${ew.customSqlSegment}")
   IPage<User> selectPageByWrapper(Page<User> page, @Param(Constants.WRAPPER) Wrapper<User> wrapper);

3. 避免N+1查询：多表关联时使用JOIN而非多次查询。

五、总结与建议

1. 优先使用Wrapper：简单查询优先使用QueryWrapper，保持代码简洁。
2. 复杂查询定制化：多表关联、动态条件等场景采用自定义SQL。
3. 模板生成标准化：通过自定义模板统一代码风格，减少重复劳动。
4. 性能监控：定期分析SQL执行计划，优化索引与查询逻辑。

通过合理结合MyBatis-Plus的Wrapper机制与自定义SQL模板生成技术，开发者可显著提升开发效率，同时保证代码的可维护性与查询性能。