Mybatis Example的高级用法详解

更新时间：2021年12月14日 10:16:24 作者：弦上的梦

这篇文章主要介绍了Mybatis Example的高级用法详解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

Mybatis Example的高级用法

近几个项目一直使用的mybatis来对数据库做查询，期间用到了很多高效简洁的查询方法，特此记录和分享。

一. mapper接口中的函数及方法

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

二. example实例方法

example 用于添加条件，相当于where后面的部分，理论上单表的任何复杂条件查询都可以使用example来完成。

方法	说明
example.setOrderByClause(“字段名 ASC”);	添加升序排列条件，DESC为降序
example.setDistinct(false)	去除重复，boolean型，true为选择不重复的记录。
example.and(Criteria criteria)	为example添加criteria查询条件，关系为与
example.or(Criteria criteria)	为example添加criteria查询条件，关系为或
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之间条件

三. 使用案例

1.基本字段查询

      // 1.使用criteria
      Example example = new Example(User.class);
            Criteria criteria = example.createCriteria();
            criteria.andEqualTo("name", name);
            criteria.andNotEqualTo("id", id);
            criteria.andEqualTo("userId", uid);
            List<User> list = userMapper.selectByExample(example);
            
            // 不使用criteria，实则example.and()本质底层还是返回的criteria，倒是可以简便写法。
            Example example = new Example(User.class);
   example.and()
                .andEqualTo("name", name)
                .andEqualTo("id", id)
                .andEqualTo("userId", uid);
    List<User> list = userMapper.selectByExample(example);
  等效于：select * from user where name = #{name} and id = #{id} and uid = #{uid}

2. and or 查询

  Example example = new Example(User.getClass());
        // where 条件
        Criteria criteria = example.createCriteria();
        Criteria criteria1 = example.createCriteria();
        
        criteria.andIn("id", ids);
        criteria1.orLike("des", "%" + des + "%");
        criteria1.orLike("name", "%" + name + "%");
        example.and(criteria1);
        example.and().andEqualTo("status", staus)
 等效于：where id in ( #{ids} ) and ( name like concat(‘%', #{name} ,'%') or des like concat(‘%', #{des} ,'%') ) and status = #{status}

注意：如果不加 example.and(criteria1);，则默认example只添加生成的第一个criteria，criteria1 将不会加到此条件中

3. 数组参数的条件查询

public Example test(List<String> names, String sex) {
  Example example = new Example(User.getClass());
  example.and().andEqualTo("sex", sex)
        Example.Criteria criteria = example.createCriteria();
        for (String str : names) {
             criteria.orLike("name", str);
         }
         example.and(criteria);
         List<User> list = userMapper.selectByExample(example);
            
 等效于：where sex = #{sex} and ( name like concat(‘%', #{name1} ,'%') or name like concat(‘%', #{name2} ,'%') )
}

说说Mybatis Example常见用法

一. 说明

我们在使用mybatis example做业务增/删/改/查时，会遇到一些场景。做一下记录。

二. 排序查询

使用mybatis example方式做查询时候，业务需要按照条件排序，比如：创建时间倒序

example.setOrderByClause("create_time desc");

2.1 示例：

 @Override
    public UpgradeNotifyInfoDTO queryLatestNotify(Integer appType) {
        UpgradeNotifyInfoDTO notifyDTO=new UpgradeNotifyInfoDTO();
        SportAppUpgradeNotifyExample example = new SportAppUpgradeNotifyExample();
        example.setOrderByClause("`create_time` desc");
        SportAppUpgradeNotifyExample.Criteria criteria =  example.createCriteria();
        criteria.andAppTypeEqualTo(appType);
        // 0- 禁用 1-启用
        criteria.andStatusEqualTo(1);
        List<SportAppUpgradeNotify> list = upgradeNotifyMapper.selectByExample(example);
        if (!CollectionUtils.isEmpty(list)){
            BeanUtils.copyProperties(list.get(0),notifyDTO);
        }
        return notifyDTO;
    }

注: 多条件排序写法如下：

   ReservationProductOrderDetailExample example = new ReservationProductOrderDetailExample();
        example.setOrderByClause("`reservate_time` desc,`reservate_start_time` desc, `create_time` desc");
        ReservationProductOrderDetailExample.Criteria criteria = example.createCriteria();

三. 查询limit, 只返回前50条数据

3.1 借助PageHelper

我们通过Pagehelper做分页查询，那么limit同样可以使用Pagehelper。如下，查询符合条件中的前50条。这里不会返回数据总数 count

PageHelper.startPage(1, 50);
 public List<ShopCityInfoRespDTO> queryShopList(String shopCityName,String shopCityId) {
        List<ShopCityInfoRespDTO> shopCityList = new ArrayList<>();
        ShopInfoExample example = new ShopInfoExample();
        ShopInfoExample.Criteria criteria =  example.createCriteria();
        criteria.andStatusEqualTo("0");
        if(!StringUtils.isEmpty(shopCityId)) {
            criteria.andShopIdEqualTo(shopCityId);
        }
        if(!StringUtils.isEmpty(shopCityName)) {
            criteria.andShopNameLike("%" + shopCityName + "%");
        }
        // 这里限制查询50条数据，但不能返回总数
        PageHelper.startPage(1, 50);
        List<ShopInfo>  shopInfoList = shopInfoMapper.selectByExample(example);
        if(CollectionUtils.isEmpty(shopInfoList)){
           return shopCityList;
        }
        for (ShopInfo shopInfo : shopInfoList){
            ShopCityInfoRespDTO  respDTO = new ShopCityInfoRespDTO();
            respDTO.setCompanyId(shopInfo.getCompanyId());
            respDTO.setShopCityId(shopInfo.getShopId());
            respDTO.setShopCityName(shopInfo.getShopName());
            respDTO.setShopCityCode(shopInfo.getShopCode());
            respDTO.setShopType(1);
            shopCityList.add(respDTO);
        }
        return shopCityList;
    }

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java滑动窗口算法题目练习(附详细图文及代码)
在数据处理和算法中,滑动窗口是一种常见的技术,用于解决一些数组或字符串相关的问题,这篇文章主要介绍了Java滑动窗口算法题目练习的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
2025-10-10
java中常用注解@TableId的详细解析
@TableId注解是一种常见的Java注解,通常在使用关系型数据库进行对象关系映射(ORM)时使用,这篇文章主要介绍了java中常用注解@TableId的详细解析,文中通过代码介绍的非常详细,需要的朋友可以参考下
2025-06-06
基于spring+springmvc+hibernate 整合深入剖析
这篇文章主要介绍了于spring+springmvc+hibernate整合实例，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
JAVA设计模式零基础解析之单例模式的八种方式
设计模式（Design pattern）是一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结。使用设计模式是为了可重用代码、让代码更容易被他人理解、保证代码可靠性
2021-10-10
Jenkins Host key verification failed问题解决
这篇文章主要介绍了Jenkins Host key verification failed问题解决,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-11-11
MyBatis批量插入大量数据(1w以上)
MyBatis进行批量插入数时，一次性插入超过一千条的时候MyBatis开始报错，本文主要介绍了MyBatis批量插入大量数据的解决方法，感兴趣的可以了解一下
2022-01-01
微服务通过Feign调用进行密码安全认证操作
这篇文章主要介绍了微服务通过Feign调用进行密码安全认证操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
java中数组的定义及使用方法(推荐)
下面小编就为大家带来一篇java中数组的定义及使用方法(推荐)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2016-07-07
Java通过驱动包(jar包)连接MySQL数据库的步骤总结及验证方式
本文详细介绍如何使用Java通过JDBC连接MySQL数据库,包括下载驱动、配置Eclipse环境、检测数据库连接等关键步骤,感兴趣的朋友一起看看吧
2025-07-07
java将XML文档转换成json格式数据的示例
本篇文章主要介绍了java将XML文档转换成json格式数据的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-12-12