MyBatis in Action——Example类详解

今天突然接触了Mybatsi的Generator：

String config = RunGenerator.class.getClassLoader()
				.getResource("generatorConfig.xml").getFile();

觉得这种方式很清奇，所以特意研究以下。
主要问题有以下几点，希望写该文章的过程中能够得到解答：

1. example的方法只能表达select * from xxx么？是否能够只选择表中的其中几项？如果不能，这样做是否太过于消耗内存？
2. 能表达出join的效果么？能表达类一对多/一对一/多对一的关系么？
3. 是直接手动写入mapper语句好还是使用自动生成的方式好呢？

为了解答上面的疑问，先来了解一下什么是example类，以及它的用法。

Example类

mybatis-generator会为每个字段产生Criterion，为底层的mapper.xml创建动态sql。如果表的字段比较多,产生的example类会十分庞大。理论上通过example类可以构造你想到的任何筛选条件。在mybatis-generator中加以配置，配置数据表的生成操作就可以自动生成example了。

Example类指定如何构建一个动态的where子句. 表中的每个non-BLOB列可以被包括在where子句中. 例子是展示此类用法的最好方式.

Example类可以用来生成一个几乎无限的where子句。

Example类包含一个内部静态类 Criteria 包含一个用 anded 组合在where子句中的条件列表. Example类包含一个 List 属性,所有内部类Criteria中的子句会用 ored组合在一起. 使用不同属性的 Criteria 类允许您生成无限类型的where子句.

创建 Criteria 对象 可以使用Example类中的 createCriteria() 或者 or() . 如果 Criteria 对象是用 createCriteria() 创建的，它会自动为 List 属性添加一个 Criteria 对象 - 这使得它更容易写一个简单的where子句， 如果您不需要 or 或者其他几个子句组合的话. 用 or(Criteria criteria) 方法创建 Criteria 对象, 方法里的 criteria 对象会被添加进 Criteria 对象的列表中.

了解Example成员变量

 //作用：升序还是降序
 //参数格式：字段+空格+asc(desc)
 protected String orderByClause;  
 //作用：去除重复
 //true是选择不重复记录，false，反之
 protected boolean distinct;
 //自定义查询条件
 //Criteria的集合，集合中对象是由or连接
 protected List<Criteria> oredCriteria;
 //内部类Criteria包含一个Cretiron的集合，
 //每一个Criteria对象内包含的Cretiron之间是由  AND连接的
 public static class Criteria extends GeneratedCriteria {
  protected Criteria() {super();}
 }
 //是mybatis中逆向工程中的代码模型
 protected abstract static class GeneratedCriteria {......}
 //是最基本,最底层的Where条件，用于字段级的筛选
 public static class Criterion {......}

Example使用

比如我的example是根据user表生成的，UserMapper属于dao层，UserMapper.xml是对应的映射文件。

UserMapper接口：
long countByExample(CompetingStoreExample example);
List<CompetingStore> selectByExample(CompetingStoreExample example);

在我们的测试类里：
UserExample example = new UserExample();
UserExample.Criteria criteria = example.createCriteria();

查询用户数量:

long count = UserMapper.countByExample(example);
类似于：select count(*) from user

where条件查询或多条件查询:

example.setOrderByClause(“age asc"); //升序
 example.setDistinct(false); //不去重
 if(!StringUtils.isNotBlank(user.getName())){
 Criteria.andNameEqualTo(user.getName());
 }
 if(!StringUtils.isNotBlank(user.getSex())){
 Criteria.andSexEqualTo(user.getSex());
 }
 List<User> userList=userMapper.selectByExample(example);
 
类似于：select * from user where name={#user.name} and sex={#user.sex} order by age asc;

or：

 UserExample.Criteria criteria1 = example.createCriteria();
 UserExample.Criteria criteria2 = example.createCriteria();
 if(!StringUtils.isNotBlank(user.getName())){
 Criteria1.andNameEqualTo(user.getName());
 }
 if(!StringUtils.isNotBlank(user.getSex())){
 Criteria2.andSexEqualTo(user.getSex());
 }
 Example.or(criteria2);
 List<User> userList=userMapper.selectByExample(example);

类似于：select * from user where name={#user.name} or sex={#user.sex} ;

模糊查询：

 if(!StringUtils.isNotBlank(user.getName())){
 criteria.andNameLIke(‘%’+name+’%’);
 }
 List<User> userList=userMapper.selectByExample(example);

类似于：select * from user where name like %{#user.name}%

分页查询:

int start = (currentPage - 1) * rows;
 //分页查询中的一页数量
 example.setPageSize(rows); 
 //开始查询的位置
 example.setStartRow(start);  
 List<User> userList=userMapper.selectByExample(example);
 
类似于：select * from user limit start to rows

综上所述，我不太赞同example类的写法，感觉太过鸡肋。感觉还是手动编写mapper比较方便。