MyBatis-Flex QueryWrapper实战：从基础查询到复杂关联

【免费下载链接】mybatis-flex mybatis-flex is an elegant Mybatis Enhancement Framework 项目地址: https://gitcode.com/gh_mirrors/my/mybatis-flex

MyBatis-Flex是一款优雅的MyBatis增强框架，其核心组件QueryWrapper提供了强大的SQL构建能力，让开发者能够以面向对象的方式轻松构建复杂查询。本文将从基础查询到复杂关联，全面解析QueryWrapper的实战应用技巧，帮助新手快速掌握这一高效工具。

一、QueryWrapper基础入门

QueryWrapper是MyBatis-Flex中用于构造SQL查询条件的核心类，它提供了直观的链式API，让SQL构建过程变得简单而灵活。无论是简单的单表查询还是复杂的多表关联，QueryWrapper都能轻松应对。

1.1 创建QueryWrapper

创建QueryWrapper有两种常用方式，效果完全相同：

// 方式一：使用构造函数
QueryWrapper query = new QueryWrapper();

// 方式二：使用create()静态方法
QueryWrapper query = QueryWrapper.create();

1.2 基本查询条件

QueryWrapper提供了丰富的条件构造方法，以下是一些常用示例：

// 等于条件
QueryWrapper query = QueryWrapper.create()
    .eq("username", "张三");

// 模糊查询
query.like("nickname", "张");

// 范围查询
query.between("age", 18, 30);

// 排序
query.orderBy("create_time", false);

这些方法可以链式调用，轻松构建复杂的查询条件。

二、高级查询技巧

2.1 动态条件构建

在实际开发中，查询条件往往是动态变化的。QueryWrapper的一大优势是当传入的参数为null时，会自动忽略该条件，无需额外的判断逻辑：

QueryWrapper queryWrapper = QueryWrapper.create()
    .eq(StringUtils.isNotBlank(username), "username", username)
    .between(ageStart != null && ageEnd != null, "age", ageStart, ageEnd);

这种特性极大简化了动态SQL的构建过程。

2.2 Entity转化为QueryWrapper

QueryWrapper提供了将实体对象直接转化为查询条件的功能，非常适合根据实体属性进行查询的场景：

Account account = new Account();
account.setStatus(1);
account.setRole("admin");

QueryWrapper qw = QueryWrapper.create(account);

这将自动构建出WHERE status = 1 AND role = 'admin'的查询条件。

MyBatis-Flex代码生成器可以帮助快速生成实体类和QueryWrapper相关代码

三、复杂关联查询

QueryWrapper不仅支持单表查询，还可以轻松实现多表关联查询。通过leftJoin、innerJoin等方法，可以方便地构建关联查询条件。

3.1 多表关联基础

QueryWrapper queryWrapper = QueryWrapper.create()
    .select("a.id", "a.name", "b.department_name")
    .from("account a")
    .leftJoin("department b on a.dept_id = b.id")
    .eq("a.status", 1);

3.2 关联条件高级用法

对于更复杂的关联条件，可以使用on方法进行详细配置：

QueryWrapper queryWrapper = QueryWrapper.create()
    .select("a.*", "b.order_no", "c.product_name")
    .from("account a")
    .leftJoin("orders b")
    .on("a.id = b.user_id")
    .leftJoin("products c")
    .on("b.product_id = c.id and c.status = 1")
    .eq("a.id", userId);

四、QueryWrapper高级特性

4.1 子查询

QueryWrapper支持子查询功能，可以在查询条件中嵌套子查询：

QueryWrapper subQuery = QueryWrapper.create()
    .select("user_id")
    .from("orders")
    .where("order_date > '2023-01-01'");

QueryWrapper queryWrapper = QueryWrapper.create()
    .in("id", subQuery)
    .eq("status", 1);

4.2 分组与聚合

QueryWrapper也支持分组查询和聚合函数：

QueryWrapper queryWrapper = QueryWrapper.create()
    .select("dept_id", "count(*) as user_count")
    .from("account")
    .groupBy("dept_id")
    .having("count(*) > 10");

在配置文件中可以对QueryWrapper的行为进行全局配置

五、QueryWrapper实用技巧

5.1 克隆QueryWrapper

当需要基于已有QueryWrapper创建新的查询条件时，可以使用clone()方法：

QueryWrapper queryWrapper = QueryWrapper.create()
    .eq("status", 1);

// 克隆一份并添加额外条件
QueryWrapper clone = queryWrapper.clone()
    .like("name", "张");

5.2 序列化与传输

QueryWrapper支持序列化，可以在分布式项目中通过RPC进行传输：

// 序列化
byte[] bytes = SerialUtil.serialize(queryWrapper);

// 反序列化
QueryWrapper newWrapper = (QueryWrapper) SerialUtil.deserialize(bytes);

5.3 与MyBatis-Plus兼容

从MyBatis-Flex v1.7.2开始，QueryWrapper添加了对MyBatis-Plus兼容的API，方便从MyBatis-Plus迁移的用户快速适应：

// MyBatis-Plus风格的API
QueryWrapper queryWrapper = new QueryWrapper();
queryWrapper.eq("name", "张三")
    .like("email", "@qq.com")
    .orderByDesc("create_time");

六、实战案例：复杂查询场景

以下是一个综合运用QueryWrapper各种特性的实战案例：

// 构建复杂查询条件
QueryWrapper queryWrapper = QueryWrapper.create()
    .select("a.id", "a.name", "a.email", "d.dept_name", "r.role_name")
    .from("account a")
    .leftJoin("department d on a.dept_id = d.id")
    .leftJoin("account_role ar on a.id = ar.account_id")
    .leftJoin("role r on ar.role_id = r.id")
    .eq("a.status", 1)
    .in("r.role_code", Arrays.asList("admin", "manager"))
    .likeIfPresent("a.name", keyword)
    .between("a.create_time", startDate, endDate)
    .groupBy("a.id")
    .having("count(r.id) > 0")
    .orderBy("a.create_time", false);

// 执行查询
List<AccountDTO> accounts = accountMapper.selectListByQuery(queryWrapper);

这个案例展示了如何使用QueryWrapper构建包含多表关联、动态条件、分组聚合等复杂查询。

七、总结

MyBatis-Flex QueryWrapper为开发者提供了强大而灵活的SQL构建能力，通过直观的链式API，大大简化了复杂查询的实现过程。无论是简单的单表查询还是复杂的多表关联，QueryWrapper都能帮助开发者轻松应对。

掌握QueryWrapper的使用技巧，能够显著提高数据访问层的开发效率，减少重复代码，让开发者更专注于业务逻辑的实现。如果你正在使用MyBatis，不妨尝试MyBatis-Flex和QueryWrapper，体验更优雅的数据库操作方式。

要开始使用MyBatis-Flex，只需克隆仓库：git clone https://gitcode.com/gh_mirrors/my/mybatis-flex，然后参考官方文档docs/zh/base/querywrapper.md进行配置和使用。

【免费下载链接】mybatis-flex mybatis-flex is an elegant Mybatis Enhancement Framework 项目地址: https://gitcode.com/gh_mirrors/my/mybatis-flex