MyBatis Example类的方法总结

╰半夏微凉° 2021-12-16 09:07 274阅读 0赞

**1.先看一个例子，我们想这样表达：**

查询条件1：a=? and (b=? or c=?) 不支持
    
    查询条件2：(a=? And b=?) or (a=? And c=?) 支持

如果我们要得到1的效果，就要改写为2的形式：

Example example=new Example();  
    Example.Criteria criteria1=example.createCriteria();  
    criteria1.andAEqualTo(1).andBEqualTo(2);  
    
    Example.Criteria criteria2=example.createCriteria();  
    criteria2.andAEqualTo(1).andCEqualTo(3);  
    example.or(criteria2);  
    
    //生成的sql语句
    select count(*) from demo WHERE ( a = 1 and b = 2 ) or ( a = 1 and c = 3 )

2.在看一个示例

TestTableExample example = new TestTableExample();
    example.or()
        .andField1EqualTo(5)
        .andField2IsNull();
     
      example.or()
        .andField3NotEqualTo(9)
        .andField4IsNotNull();
     
      List<Integer> field5Values = new ArrayList<Integer>();
      field5Values.add(8);
      field5Values.add(11);
      field5Values.add(14);
      field5Values.add(22);
     
      example.or()
        .andField5In(field5Values);
     
      example.or()
        .andField6Between(3, 7);

*  or()方法会产生一个新的Criteria对象,添加到oredCriteria中,并返回这个Criteria对象，从而可以链式表达，为其添加Criterion。
 *  Example类的distinct字段用于指定DISTINCT查询。
 *  orderByClause字段用于指定ORDER BY条件,这个条件没有构造方法,直接通过传递字符串值指定。

**产生的SQL语句如下：**

where (field1 = 5 and field2 is null)
         or (field3 <> 9 and field4 is not null)
         or (field5 in (8, 11, 14, 22))
         or (field6 between 3 and 7)

*一、mapper接口中的方法解析*\*  
mapper接口中的部分常用方法及功能如下：

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>功能说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>int countByExample(UserExample example) thorws SQLException</td> 
   <td>按条件计数</td> 
  </tr> 
  <tr> 
   <td>int deleteByPrimaryKey(Integer id) thorws SQLException</td> 
   <td>按主键删除</td> 
  </tr> 
  <tr> 
   <td>int deleteByExample(UserExample example) thorws SQLException</td> 
   <td>按条件删除</td> 
  </tr> 
  <tr> 
   <td>String/Integer insert(User record) thorws SQLException</td> 
   <td>插入数据（返回值为ID）</td> 
  </tr> 
  <tr> 
   <td>User selectByPrimaryKey(Integer id) thorws SQLException</td> 
   <td>按主键查询</td> 
  </tr> 
  <tr> 
   <td>ListselectByExample(UserExample example) thorws SQLException</td> 
   <td>按条件查询</td> 
  </tr> 
  <tr> 
   <td>ListselectByExampleWithBLOGs(UserExample example) thorws SQLException</td> 
   <td>按条件查询（包括BLOB字段）。只有当数据表中的字段类型有为二进制的才会产生</td> 
  </tr> 
  <tr> 
   <td>int updateByPrimaryKey(User record) thorws SQLException</td> 
   <td>按主键更新</td> 
  </tr> 
  <tr> 
   <td>int updateByPrimaryKeySelective(User record) thorws SQLException</td> 
   <td>按主键更新值不为null的字段</td> 
  </tr> 
  <tr> 
   <td>int updateByExample(User record, UserExample example) thorws SQLException</td> 
   <td>按条件更新</td> 
  </tr> 
  <tr> 
   <td>int updateByExampleSelective(User record, UserExample example) thorws SQLException</td> 
   <td>按条件更新值不为null的字段</td> 
  </tr> 
 </tbody> 
</table>

**二、Example类解析**  
mybatis的逆向工程中会生成实体类及实体类对应的example类，example类用于添加条件，相当where后面的部分。  
xxxExample example = new xxxExample();  
Criteria criteria = new Example().createCriteria();  
example类中的部分常用方法及功能如下：

<table> 
 <thead> 
  <tr> 
   <th>方法</th> 
   <th>功能说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>example.setOrderByClause(“字段名 ASC”);</td> 
   <td>添加升序排列条件，DESC为降序</td> 
  </tr> 
  <tr> 
   <td>example.setDistinct(false)</td> 
   <td>去除重复，boolean型，true为选择不重复的记录</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxIsNull</td> 
   <td>添加字段xxx为null的条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxIsNotNull</td> 
   <td>添加字段xxx不为null的条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxEqualTo(value)</td> 
   <td>添加xxx字段等于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxNotEqualTo(value)</td> 
   <td>添加xxx字段不等于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxGreaterThan(value)</td> 
   <td>添加xxx字段大于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxGreaterThanOrEqualTo(value)</td> 
   <td>添加xxx字段大于等于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxLessThan(value)</td> 
   <td>添加xxx字段小于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxLessThanOrEqualTo(value)</td> 
   <td>添加xxx字段小于等于value条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxIn(List&lt;？&gt;)</td> 
   <td>添加xxx字段值在List&lt;？&gt;条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxNotIn(List&lt;？&gt;)</td> 
   <td>添加xxx字段值不在List&lt;？&gt;条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxLike(“%”+value+”%”)</td> 
   <td>添加xxx字段值为value的模糊查询条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxNotLike(“%”+value+”%”)</td> 
   <td>添加xxx字段值不为value的模糊查询条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxBetween(value1,value2)</td> 
   <td>添加xxx字段值在value1和value2之间条件</td> 
  </tr> 
  <tr> 
   <td>criteria.andXxxNotBetween(value1,value2)</td> 
   <td>添加xxx字段值不在value1和value2之间条件</td> 
  </tr> 
 </tbody> 
</table>

注：在mybatis逆向工程生成的文件XxxExample.java中包含一个static的内部类Criteria，Criteria中的方法是定义SQL 语句where后的查询条件。