MyBatis中Example如何使用

发布时间：2021-07-30 16:22:26 作者：Leah
来源：亿速云阅读：354

# MyBatis中Example如何使用

## 一、Example概述

Example是MyBatis Generator（MBG）自动生成的一种查询辅助类，主要作用是通过面向对象的方式构建动态SQL查询条件，避免手动编写复杂WHERE子句。它特别适用于单表查询场景，能显著提升开发效率。

## 二、Example核心类结构

### 1. 主要组成部分
```java
// 典型Example类结构
public class UserExample {
    protected String orderByClause;  // 排序字段
    protected boolean distinct;    // 是否去重
    protected List<Criteria> oredCriteria; // 条件集合
    
    // Criteria内部类
    protected abstract static class GeneratedCriteria {
        protected List<Criterion> criteria;
        // 各种条件方法...
    }
    
    public static class Criteria extends GeneratedCriteria {
        // 具体实现...
    }
}

2. 关键组件说明

orderByClause：指定排序规则（如”create_time DESC”）
distinct：控制是否返回唯一结果
oredCriteria：存储多个条件组（Criteria），组间默认OR关系
Criteria：包含具体条件表达式（如andNameEqualTo）

三、基础使用方法

1. 创建Example实例

UserExample example = new UserExample();

2. 设置查询条件

// 创建条件对象
UserExample.Criteria criteria = example.createCriteria();

// 等值查询
criteria.andUsernameEqualTo("admin");

// 范围查询
criteria.andAgeBetween(18, 30);

// IN查询
criteria.andIdIn(Arrays.asList(1, 2, 3));

// 模糊查询
criteria.andNameLike("%张%");

3. 组合条件查询

// 第一个条件组
UserExample.Criteria criteria1 = example.createCriteria();
criteria1.andStatusEqualTo(1);

// 第二个条件组（OR连接）
UserExample.Criteria criteria2 = example.createCriteria();
criteria2.andIsVipEqualTo(true);
example.or(criteria2);

4. 排序与分页

// 设置排序
example.setOrderByClause("create_time DESC, id ASC");

// 分页（需配合PageHelper）
PageHelper.startPage(1, 10);
List<User> users = userMapper.selectByExample(example);

四、高级用法

1. 复杂条件组合

// 嵌套条件
example.createCriteria()
    .andAgeGreaterThan(18)
    .andGenderEqualTo("M")
    .andCreateTimeBetween(startDate, endDate);

2. 自定义条件

// 添加自定义SQL条件
criteria.andCondition("salary > (select avg(salary) from user)");

// 使用函数
criteria.andCondition("date_format(create_time,'%Y-%m')='2023-01'");

3. 关联查询模拟

虽然Example主要用于单表查询，但可通过子查询模拟关联：

criteria.andDeptIdIn(
    deptMapper.selectByExample(
        new DeptExample().createCriteria()
            .andNameLike("技术%")
    ).stream().map(Dept::getId).collect(Collectors.toList())
);

五、实际应用示例

1. 动态搜索接口实现

public List<User> searchUsers(String username, Integer minAge, 
                             Integer maxAge, String sortField) {
    UserExample example = new UserExample();
    Criteria criteria = example.createCriteria();
    
    if(StringUtils.isNotBlank(username)){
        criteria.andUsernameLike("%"+username+"%");
    }
    if(minAge != null){
        criteria.andAgeGreaterThanOrEqualTo(minAge);
    }
    if(maxAge != null){
        criteria.andAgeLessThanOrEqualTo(maxAge);
    }
    if(StringUtils.isNotBlank(sortField)){
        example.setOrderByClause(sortField + " DESC");
    }
    
    return userMapper.selectByExample(example);
}

2. 批量更新配合Example

User record = new User();
record.setStatus(0); // 待更新字段

UserExample example = new UserExample();
example.createCriteria()
    .andLastLoginTimeLessThan(DateUtils.addMonths(new Date(), -6));
    
userMapper.updateByExampleSelective(record, example); // 只更新非null字段

六、注意事项

性能问题：复杂条件可能导致索引失效
使用限制：
- 仅适用于单表操作
- 不支持联表查询
- 部分数据库方言可能不兼容
最佳实践：
- 简单查询使用Example
- 复杂查询建议手写XML
- 避免在循环中创建Example

七、常见问题解答

Q：如何实现WHERE (A AND B) OR (C AND D)结构？

UserExample example = new UserExample();

// 第一组：A AND B
Criteria criteria1 = example.createCriteria();
criteria1.andAEqualTo(value1);
criteria1.andBEqualTo(value2);

// 第二组：C AND D（OR连接）
Criteria criteria2 = example.createCriteria();
criteria2.andCEqualTo(value3);
criteria2.andDEqualTo(value4);
example.or(criteria2);

Q：如何清空已有条件？

example.clear();  // 重置所有条件

通过合理使用Example，可以大幅减少样板代码，使查询逻辑更加清晰。但对于复杂业务场景，建议结合XML映射文件实现更灵活的SQL控制。 “`