Mybatis中Example的用法(QBC查询)

QBC查询
Query By Criteria。Criteria 是 Criterion 的复数形式。意思是：规则、标准、准则。在 SQL 语句中相当于查询条件。QBC 查询是将查询条件通过 Java 对象进行模块化封装。

Example简单介绍

其实就是一个工具，自动帮你生成对应的代码
1.example是Mybatis数据层框架中的一个工具，可以帮我们完成sql语句中where条件句的书写，相当于where后面的部分，我们可以根据不同的条件来查询和操作数据库，简化书写sql的过程。
2.用MyBatis的逆向工程可以自动生成Example类。

Example类的具体用法

1.每个实体类都对应一个xxxExample.java类，这个类可以用来自定义sql，用Mybait自动生成工具生成了这个类后，可以看到类里面一般有这些参数：
 orderByClause：用于指定ORDER BY条件,这个条件没有构造方法,直接通过传递字符串值指定。
 distinct: 是用来指定是否要去重查询的，true为去重，false不去重。
 oredCriteriia:是用来指定查询条件的。

2.Example.java中包含一个static 的内部类 Criteria ，在Criteria中有很多方法，主要是定义SQL 语 句where后的查询条件，Criterion是最基本的Where条件，针对字段进行筛选。

3.Example类中的一些方法说明：
example.setOrderByClause(“字段名 ASC”); 添加升序排列条件，DESC为降序
example.setDistinct(false) 去除重复，boolean型，true为选择不重复的记录。
criteria.andXxxIsNull 添加字段xxx为null的条件
criteria.andXxxIsNotNull 添加字段xxx不为null的条件
criteria.andXxxEqualTo(value) 添加xxx字段等于value条件
criteria.andXxxNotEqualTo(value) 添加xxx字段不等于value条件
criteria.andXxxGreaterThan(value) 添加xxx字段大于value条件
criteria.andXxxGreaterThanOrEqualTo(value) 添加xxx字段大于等于value条件
criteria.andXxxLessThan(value) 添加xxx字段小于value条件
criteria.andXxxLessThanOrEqualTo(value) 添加xxx字段小于等于value条件
criteria.andXxxIn(List<？>) 添加xxx字段值在List<？>条件
criteria.andXxxNotIn(List<？>) 添加xxx字段值不在List<？>条件
criteria.andXxxLike(“%”+value+”%”) 添加xxx字段值为value的模糊查询条件
criteria.andXxxNotLike(“%”+value+”%”) 添加xxx字段值不为value的模糊查询条件
criteria.andXxxBetween(value1,value2) 添加xxx字段值在value1和value2之间条件
criteria.andXxxNotBetween(value1,value2) 添加xxx字段值不在value1和value2之间条件
等等，可以根据需求自定义方法

Examle应用实例

    Long sysUserIdRec = qrySystemUserDetailReq.getSysUserId();
    String sysUserCode = qrySystemUserDetailReq.getSysUserCode();

    SystemUserExample systemUserExample = new SystemUserExample();
    SystemUserExample.Criteria criteria = systemUserExample.createCriteria();

    if (sysUserIdRec != null)
        criteria.andSysUserIdEqualTo(sysUserIdRec);

    if (sysUserCode != null)
        criteria.andSysUserCodeEqualTo(sysUserCode);

    List<SystemUser> systemUserList = systemUserMapper.selectByExample(systemUserExample);

 

这是用where语句处理and查询条件的情况，
对应的mapper.xml：select * from system_user where sys_user_id=#{sysUserId} and sys_user_code=#{sysUserCode}

如果处理不好此处容易出现sql注入情况：下面的condition参数外部可控，便存在sql注入。

public Criteria andCustomCondition(String condition, Object value) {
    this.criteria.add(new Criterion(condition, value));
    return (Criteria)this;
}

 

备注

xxx实体类
xxxExample            一个实体有个对应的xxxExample，每个Example都有个内部类Criteria，Criteria有多个方法 可以自己设置，调用这些方法设置where查询条件，所有查询条件以Criterion对象的list形式保存
Criteria            Criteria有多个方法 可以自己设置，调用这些方法设置where查询条件，所有查询条件以Criterion对象的list形式保存。xxxExample的内部类
Criterion            所有查询条件以Criterion对象的list形式保存。作为Criteria的一个属性