百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 编程网 > 正文

MybatisPlus这样用简直就是不要太香,你还不快来试试!

yuyutoo 2024-10-12 00:03 6 浏览 0 评论

在平时的开发中大多数都是重复的增删改查业务,特别是查询这个频率最高。查询又有按id查询,按组合条件查询,最烦琐的就是按条件查询。明明是多个业务之间重复的工作,只是表名字不一样,却要重复的去做查询组装。例如有一个产品表,需要按照各种查询条件进行查询,一般我们使用mybatis的话会在xml中这样配置:

	<select id="selectList" parameterType="Prodct" resultMap="ProductResult">
	    <include refid="selectProductVo"/>
		<where>
			<if test="code != null and code != ''">
				AND code like concat('%', #{code}, '%')
			</if>
		<if test="name != null and name != ''">
				AND name like concat('%', #{name}, '%')
			</if>
			<if test="cateId != null ">
				AND cateId = #{cateId},
			</if>
    <!-- 后面省略其他更多的条件组装 -->
		</where>
	</select>

如果还有一个用户表,订单表 都需要按业务字段查询,咱们也必须重复上面的配置,虽然是可以复制粘贴过来,但是这种方式还是太过于繁琐。那试试用 MybatisPlus又会怎样呢?MybatisPlus提供了查询器,可以使用代码按条件进行包装查询,具体用法如下:

  LambdaQueryWrapper<ProductEntity> wrapper = new LambdaQueryWrapper<ProductEntity>();
        if (StringUtils.isNotBlank(queryDto.getCode())) {
            wrapper.eq(ProductEntity::getCode, queryDto.getCode());
        }
        if (StringUtils.isNotBlank(queryDto.getName())) {
            wrapper.like(ProductEntity::getName, queryDto.getName());
        }
        if (StringUtils.isNotBlank(queryDto.getKeywork())) {
            wrapper.like(ProductEntity::getKeywork, queryDto.getKeywork());
        }
        if (queryDto.getIsDel() != null) {
            wrapper.eq(ProductEntity::getIsDel, queryDto.getIsDel());
        }
        if (queryDto.getIsShow() != null) {
            wrapper.eq(ProductEntity::getIsShow, queryDto.getIsShow());
        }
        if (queryDto.getIsHot() != null) {
            wrapper.eq(ProductEntity::getIsHot, queryDto.getIsHot());
        }
        if (queryDto.getIsRecom() != null) {
            wrapper.eq(ProductEntity::getIsRecom, queryDto.getIsRecom());
        }

可以看到,用MybatisPlus一样也少不了你得手动去组装这些查询条件,只不过是由xml切换到了代码去组装。有人就说了 MybatisPlus不是提供了Lambda链式查询吗?是的Lambda链式查询确实不错,但是如果使用Lambda链式查询代码看起来还不如上面的舒服。如下面的代码:

  new LambdaQueryWrapper<ProductEntity>()
                .eq(StringUtils.isNotBlank(queryDto.getCode()),ProductEntity::getCode,queryDto.getCode())
                .like(StringUtils.isNotBlank(queryDto.getName()),ProductEntity::getName,queryDto.getName());

这还只是组装两个查询条件,要是8个10个或者更多的查询条件,这个链式看起来头都大,而且你调试的是否非常不方便,所以不要太迷恋链式调用这种形式。上面两种常规方式都不能让这种不同的业务单表查询变得更简单或者减少重复工作。

鉴于以上这种代码的弊端,我提出一个优化需求:

  1. 能不能传入一个java对象就可以自动的返回查询包装器
  2. 返回的查询组装能支持等于,小于,大于,模糊匹配等这些类型
  3. 这个方法能支持所有的业务表
  4. 查询类型可以通过字段定义而不是代码写死

以上四点需求满后,最理想的效果如下:

// 商品查询
ProductQuery productQuery=new ProductQuery();
// 用户查询
UserQuery  userQuery =UserQuery();
// 动态查询方法,入参是 商品查询对象
QueryWrapper<ProductEntity> wrapper = getDynamicaWrapper(productQuery);
// 动态查询方法,入参是 用户查询对象
QueryWrapper<UserEntity> wrapper = getDynamicaWrapper(userQuery);

今天和大家分享一个简单的方法,让这种没有技术含量的条件组装变得简单,让你使用MybatisPlus一下子爽起来,毕竟减少重复工作一种都是编程领域的终极目标。下面把所以的实现过程贴出来,方便大家需要的时候可以复制粘贴。

首先,先定义一个枚举类,这个枚举类基本包含了SQL查询的类型:

public enum QueryFiledEnum {
    EQ,
    LIKE,
    NOT_LIKE,
    NE,
    GE,
    GT,
    LE,
    IN,
    NOT_IN,
    LEFT_LIKE,
    RIGHT_LIKE,
    BETWEEN,
    NOT_BETWEEN,
}

然后,咱们还得定义一个注解,用于配置字段

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface QueryFiled {
   // 查询的类型(比如等于,大于,小于 ,模糊查询等),对应上面的枚举类
    public QueryFiledEnum type() default QueryFiledEnum.EQ;
    // 是否排除这个字段的组装,默认是不排除
    public boolean exclude() default false;
}

接着,你需要定义一个通用的服务类,把这种重复的条件组装封装起来,做成一个通用的方法调用

public class BaseService<M extends BaseMapper<T>, T> extends ServiceImpl<M, T> {
  /***
   这个就是动态的条件组装方法,看到入参是Object类型,所以这个方法可以接受任何的查询对象
   方法返回一个QueryWrapper ,拿到这个QueryWrapper后你可以继续做其他的查询组装
  **/
  protected QueryWrapper<T> getDynamicaWrapper(Object baseQuery) {
        QueryWrapper<T> wrapper = new QueryWrapper<>();
        if (baseQuery == null) {
            return wrapper;
        }
       // 采用反射
        Field[] fields = baseQuery.getClass().getDeclaredFields();
        for (Field field : fields) {
            try {
                field.setAccessible(true);
                Object fieldValue = field.get(baseQuery);
                if (isNotEmpty(fieldValue)) {
                   // 获取字段注解
                    QueryFiled annotation = field.getAnnotation(QueryFiled.class);
                    // 把字段名称转换为数据库字段
                    String fieldName = fieldToColumn(field.getName());
                    // 没有注解,默认使用等于查询
                    if (annotation == null) {
                        wrapper.eq(fieldName, fieldValue);
                    } else {
                        QueryFiledEnum type = annotation.type();
                        if (!annotation.exclude()) {
                            // 根据查询类型 动态拼接查询器
                            setQueryWrapper(type, fieldName, fieldValue, wrapper);
                        }
                    }
                }
            } catch (Exception e) {
                if (log.isDebugEnabled()) {
                    log.debug(e.getMessage());
                }
            }
        }
        return wrapper;
    }

   /***
    这个是具体的查询组装的逻辑,后期需要扩展查询类型,就需要改这个地方代码即可
   **/
    private final void setQueryWrapper(QueryFiledEnum type, String fieldName, Object fieldValue, QueryWrapper<T> wrapper) {
        String tn = type.name();
        switch (type) {
            case EQ:
                wrapper.eq(fieldName, fieldValue);
                break;
            case NE:
                wrapper.ne(fieldName, fieldValue);
                break;
            case GE:
                wrapper.ge(fieldName, fieldValue);
                break;
            case LE:
                wrapper.le(fieldName, fieldValue);
                break;
            case GT:
                wrapper.gt(fieldName, fieldValue);
                break;
            case LIKE:
                wrapper.like(fieldName, fieldValue);
                break;
            case LEFT_LIKE:
                wrapper.likeLeft(fieldName, fieldValue);
                break;
            case RIGHT_LIKE:
                wrapper.likeRight(fieldName, fieldValue);
                break;
            case NOT_LIKE:
                wrapper.notLike(fieldName, fieldValue);
                break;
            case IN:
                if (fieldValue instanceof Collection || fieldValue instanceof Object[]) {
                    wrapper.in(fieldName, fieldValue);
                }
                break;
            case NOT_IN:
                if (fieldValue instanceof Collection || fieldValue instanceof Object[]) {
                    wrapper.notIn(fieldName, fieldValue);
                }
                break;
            case BETWEEN:
                if (fieldValue instanceof Object[]) {
                    Object[] fv = (Object[]) fieldValue;
                    wrapper.between(fieldName, fv[0], fv[1]);
                }
                break;
            case NOT_BETWEEN:
                if (fieldValue instanceof Object[]) {
                    Object[] fv = (Object[]) fieldValue;
                    wrapper.notBetween(fieldName, fv[0], fv[1]);
                }
                break;
            default:
                break;
        }
    }
  
    // 将java 字段转换成数据库字段
    private String fieldToColumn(String field) {
        StringBuilder sb = new StringBuilder(10);
        for (int i = 0; i < field.length(); i++) {
            if ('A' <= field.charAt(i) && field.charAt(i) <= 'Z') {
                sb.append("_").append(Character.toLowerCase(field.charAt(i)));
            } else {
                sb.append(field.charAt(i));
            }
        }
        return sb.toString();
    }
}

代码比较简单,逻辑也不复杂,只是通过反射把动态组装查询这个地方做了封装,让查询基于一个可配置的对象即可自动完成,看注释就可以明白。下面咱看看具体怎么使用这个超级方法。

按照不同业务,首先得定义一个查询对象,比如我的商品查询对象:

@Data
public class ProductQuery{
    // 这个字段没有注解,说明是默认使用 等于 查询
    private String code;
    // 排除掉这个字段的动态组装,也就是动态查询方法里面不组装这个条件
    @QueryFiled(exclude = true)
    private Long cateId;
    // 这个注解指定了查询的类型
    @QueryFiled(type = QueryFiledEnum.LIKE)
    private String name;
    @QueryFiled(type = QueryFiledEnum.LIKE)
    private String keywork;
    private Integer isHot;
    private Integer isNew;
    private Integer isShow;
    private Integer isRecom;
    private Integer isDel;
}

可以看到,所有查询的条件都在这个类上面完成了,包括查询的字段,查询的类型,查询的参数都通过这个类去完成。注意的是 这个字段的命名要和你的实体 ProductEntity一样。其实我们也可以完全把这些配置写在ProductEntity上就不需要重复而且要求必须这些字段一样了。但是为了更规范,一般我们实体类和业务类不混淆一起使用,比如ProductEntity一般有很多的字段,咱不能为了查询就在这个实体类上添加那么多于数据库无关的配置吧,所以单独创建一个查询类是比较标准的做法。

然后就是开头上面的代码那样使用了

ProductQuery productQuery=new ProductQuery();
// 动态查询方法,入参是 商品查询对象
QueryWrapper<ProductEntity> wrapper = getDynamicaWrapper(productQuery);

如果你的业务中还有用户,订单等后续就可以只需要创建*Query这样的查询类简单的配置就可以不用写那些一大堆重复的if else或者xml了。这样简单一个封装,让你的工作量瞬间减少,作为程序员最怕的就是重复的工作。那这个动态查询方法有什么优点吗?

  1. 封装各业务表重复的查询条件
  2. 基于查询描述类进行动态查询拼接,不需要手动去组装
  3. 支持注解配置查询参数
  4. 对原有查询无侵入性,返回QueryWrapper后可以继续QueryWrapper的所有功能
  5. 不依赖具体查询配置类,只依赖其中的属性命名

如果你觉得这种方式好用,可以在你的代码中试一试,你会瞬间摆脱那种重复烦人无技术含量的查询条件拼装,要是觉得好用记得点赞关注,鼓励支持下。

相关推荐

史上最全的浏览器兼容性问题和解决方案

微信ID:WEB_wysj(点击关注)◎◎◎◎◎◎◎◎◎一┳═┻︻▄(页底留言开放,欢迎来吐槽)●●●...

平面设计基础知识_平面设计基础知识实验收获与总结
平面设计基础知识_平面设计基础知识实验收获与总结

CSS构造颜色,背景与图像1.使用span更好的控制文本中局部区域的文本:文本;2.使用display属性提供区块转变:display:inline(是内联的...

2025-02-21 16:01 yuyutoo

写作排版简单三步就行-工具篇_作文排版模板

和我们工作中日常word排版内部交流不同,这篇教程介绍的写作排版主要是用于“微信公众号、头条号”网络展示。写作展现的是我的思考,排版是让写作在网格上更好地展现。在写作上花费时间是有累积复利优势的,在排...

写一个2048的游戏_2048小游戏功能实现

1.创建HTML文件1.打开一个文本编辑器,例如Notepad++、SublimeText、VisualStudioCode等。2.将以下HTML代码复制并粘贴到文本编辑器中:html...

今天你穿“短袖”了吗?青岛最高23℃!接下来几天气温更刺激……

  最近的天气暖和得让很多小伙伴们喊“热”!!!  昨天的气温到底升得有多高呢?你家有没有榜上有名?...

CSS不规则卡片,纯CSS制作优惠券样式,CSS实现锯齿样式

之前也有写过CSS优惠券样式《CSS3径向渐变实现优惠券波浪造型》,这次再来温习一遍,并且将更为详细的讲解,从布局到具体样式说明,最后定义CSS变量,自定义主题颜色。布局...

柠檬科技肖勃飞:大数据风控助力信用社会建设

...

你的自我界限够强大吗?_你的自我界限够强大吗英文

我的结果:A、该设立新的界限...

行内元素与块级元素,以及区别_行内元素和块级元素有什么区别?

行内元素与块级元素首先,CSS规范规定,每个元素都有display属性,确定该元素的类型,每个元素都有默认的display值,分别为块级(block)、行内(inline)。块级元素:(以下列举比较常...

让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华
让“成都速度”跑得潇潇洒洒,地上地下共享轨交繁华

去年的两会期间,习近平总书记在参加人大会议四川代表团审议时,对治蜀兴川提出了明确要求,指明了前行方向,并带来了“祝四川人民的生活越来越安逸”的美好祝福。又是一年...

2025-02-21 16:00 yuyutoo

今年国家综合性消防救援队伍计划招录消防员15000名

记者24日从应急管理部获悉,国家综合性消防救援队伍2023年消防员招录工作已正式启动。今年共计划招录消防员15000名,其中高校应届毕业生5000名、退役士兵5000名、社会青年5000名。本次招录的...

一起盘点最新 Chrome v133 的5大主流特性 ?

1.CSS的高级attr()方法CSSattr()函数是CSSLevel5中用于检索DOM元素的属性值并将其用于CSS属性值,类似于var()函数替换自定义属性值的方式。...

竞走团体世锦赛5月太仓举行 世界冠军杨家玉担任形象大使

style="text-align:center;"data-mce-style="text-align:...

学物理能做什么?_学物理能做什么 卢昌海

作者:曹则贤中国科学院物理研究所原标题:《物理学:ASourceofPowerforMan》在2006年中央电视台《对话》栏目的某期节目中,主持人问过我一个的问题:“学物理的人,如果日后不...

你不知道的关于这只眯眼兔的6个小秘密
你不知道的关于这只眯眼兔的6个小秘密

在你们忙着给熊本君做表情包的时候,要知道,最先在网络上引起轰动的可是这只脸上只有两条缝的兔子——兔斯基。今年,它更是迎来了自己的10岁生日。①关于德艺双馨“老艺...

2025-02-21 16:00 yuyutoo

取消回复欢迎 发表评论: