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;
    }

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

您可能感兴趣的文章:

MyBatis Excutor 拦截器的巧妙用法
这里要讲的巧妙用法是用来实现在拦截器中执行额外 MyBatis 现有方法的用法，并提供了解决拦截Executor时想要修改MappedStatement时解决并发的问题。感兴趣的朋友一起看看吧
2017-10-10
利用线程实现动态显示系统时间
编写Applet小程序，通过在HTML文档中接收参数，显示当前的系统时间，需要的朋友可以参考下
2015-10-10
Java Web学习之MySQL在项目中的使用方法
mysql数据库是我们在日常开发中经常会用到的，下面这篇文章主要给大家介绍了关于Java Web学习之MySQL在项目中的使用方法，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧。
2018-04-04
Java中性能优化的35种方法汇总
很多同学在日常写Java的时候很少去关心性能问题，但是在我们写代码的过程中必须考虑到性能对程序的影响。小到我们使用位运算来实现算术运算，大到我们对 Java 代码的总体架构设计，性能其实离我们很近。本文介绍了Java中性能优化的35种方法,需要的朋友可以参考下。
2017-01-01
关于SpringCloud整合RabbitMQ的实例
这篇文章主要介绍了关于SpringCloud整合RabbitMQ的实例,消息队列是指利用高效可靠的消息传递机制进行与平台无关的数据交流,并基于数据通信来进行分布式系统的集成,是在消息的传输过程中保存消息的容器,需要的朋友可以参考下
2023-07-07
mybatis实现图书管理系统
这篇文章主要为大家详细介绍了mybatis实现图书管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-06-06
浅谈Java HttpURLConnection请求方式
这篇文章主要介绍了浅谈Java HttpURLConnection请求方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-08-08
基于jstree使用JSON数据组装成树
这篇文章主要为大家详细介绍了基于jstree使用JSON数据组装成树，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-08-08
Java调用wsdl接口的两种方法(axis和wsimport)
本文主要介绍了Java调用wsdl接口的两种方法(axis和wsimport)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
mybatis集成到spring的方式详解
这篇文章主要介绍了mybatis是如何集成到spring的,将mybatis集成到spring之后，就可以被spring的ioc容器托管，再也不用自己创建SqlSessionFactory 、打开SqlSession等操作，本文结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
2023-05-05