Mybatis Plus的一种查询构造方案

已于 2024-01-25 15:41:53 修改
阅读量344 收藏
点赞数 1
文章标签： sql mybatis java springboot
于 2023-02-06 18:09:25 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiaoyanhhh/article/details/128906045
版权

Mybatis Plus的一种查询构造方案

! 重要: 遐(瞎)想的思路, 希望各位多多建议

record为jdk17写法, 使用class也不会有问题

背景

身为资深程序员, 上班最重要的事当然是增删改查(bushi).

比如今天, 组长甩给了我一个表, 告诉我根据学号/性别/生日范围/受表扬次数写个接口.

create table test_student(
    id                 bigint primary key comment 'id',
    stu_num            varchar(20) not null comment '学号',
    sex                varchar(10) not null comment '性别, 字典: sex',
    birthday           date        not null comment '生日',
    star_count         int         not null comment '受表扬次数'
) comment '测试用_学生信息';

用的mybatis plus, 有了如下代码, 于是我今天的工作任务就完成了

// 检索对象
/**
 * 学生检索
 *
 * @param stuNum      学号
 * @param sex         性别
 * @param birthdayMin 最小生日
 * @param birthdayMax 最大生日
 * @param starCount   受表扬次数
 */
public record TestStudentQuery(
        String stuNum,
        String sex,
        LocalDate birthdayMin,
        LocalDate birthdayMax,
        Integer starCount
) {
}

// service search方法
@Override
public Page<TestStudent> search(TestStudentQuery query) {
    return this.lambdaQuery()
        // 学号不为空, 则模糊查询
        .like(StringUtils.isNotEmpty(query.stuNum()), TestStudent::getStuNum, query.stuNum())
        // 性别不为空则全等查询
        .eq(StringUtils.isNotEmpty(query.sex()), TestStudent::getSex, query.sex())
        // 生日最小/最大时间均不为空则进行范围查询
        .between(Objects.nonNull(query.birthdayMax()) && Objects.nonNull(query.birthdayMin()),
                 TestStudent::getBirthday, query.birthdayMin(), query.birthdayMax())
        // 受表扬次数不为空则全等查询
        .eq(Objects.nonNull(query.starCount()), TestStudent::getStarCount, query.starCount())
        // 分页
        .page(Paging.startPage());
}

看起来除了有点乱之外, 功能基本是正常的

但是写起来是不是太麻烦了, 这么多判断, 搞不好明天还让我写这玩意, 乏味

构思

问题有了, 想想思路

  1. query对象的字段名, 除了between查询外, 均一致
  2. 如果query的范围查询, 都以Min/Max结尾来表示最大值/最小值, 那么也有迹可循
  3. 查询条件只有query对象中的属性, 如果query对象中添加一些注解, 然后检索时解析这些注解, 好像是可行的
  4. 所以只需要写一个工具类, 来解析query中的注解就行了呀

基于上面的想法, 把我想要的写法写了出来:

query对象:

public record TestStudentQuery(
        @MbpQuery(type = QueryTypeEnum.LIKE)
        String stuNum,
        @MbpQuery(type = QueryTypeEnum.EQ)
        String sex,
        @MbpQuery(type = QueryTypeEnum.BETWEEN)
        LocalDate birthdayMin,
        @MbpQuery(type = QueryTypeEnum.BETWEEN)
        LocalDate birthdayMax,
        @MbpQuery(type = QueryTypeEnum.EQ)
        Integer starCount
) {
}

service中写法:

@Override
public Page<TestStudent> anotherSearch(TestStudentQuery query) {
    // 用法1: 自动解析query对象, 整理为mybatis plus理解的代码, 只构建查询条件, 不进行自动分页查询, 便于后续查询
    MbpUtil.buildSearch(this, query)
    // 用法2: 相对于buildSearch, 并自动解析分页
    return MbpUtil.page(this, query);
}

实现

  1. 定义查询类型

    列举一下项目中用的到的检索类型, 篇幅有限, 删掉了注释, 注释版可见github

    public enum QueryTypeEnum {
    EQ,
    NE,
    GT,
    GE,
    LT,
    LE,
    BETWEEN,
    NOT_BETWEEN,
    LIKE,
    NOT_LIKE,
    LIKE_LEFT,
    LIKE_RIGHT,
    NOT_LIKE_LEFT,
    NOT_LIKE_RIGHT,
    IN,
    NOT_IN
}

  2. 定义注解

    @Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface MbpQuery {
    QueryTypeEnum type();
}

  3. 定义工具类

    @SuppressWarnings("AlibabaConstantFieldShouldBeUpperCase")
public class MbpUtil1 {
    /**
     * between字段区间开始标识
     */
    private static final String betweenMin = "Min";
    /**
     * between字段区间结尾标识
     */
    private static final String betweenMax = "Max";

    /**
     * 用于快速构建检索条件
     *
     * @param service service对象
     * @param query   检索条件, query对象
     * @param <M>     mapper interface
     * @param <T>     实体类
     * @return 构建完成的检索条件
     */
    public static <M extends BaseMapper<T>, T> LambdaQueryChainWrapper<T> buildSearch(ServiceImpl<M, T> service, Object query) {
        QueryChainWrapper<T> result = service.query();
        // switch (query 的字段){
        //     找到各种注解, 根据不同的注解去调用不同的方法并判断非空
        // }
        // 这里返回lambda/还是非lambda更合适?
        return result;
    }

    /**
     * 快速构建检索条件并分页
     * @param service service对象
     * @param query   检索条件, query对象
     * @param <M>     mapper interface
     * @param <T>     实体类
     * @return 分页结果
     */
    public static <M extends BaseMapper<T>, T> Page<T> page(ServiceImpl<M, T> service, Object query) {
        return buildSearch(service, query).page(Paging.startPage());
    }
}

  4. 卡住了

    这里如果使用mybatis plus的QueryChain好像没啥事, 但是这里需要返回半成品的查询对象, 那么外面继续添加检索条件时, 就无法使用lambda方式了

    字符串里面写东西不好, 不好排查, 没有代码提示, 不能查找引用

    那么还是要使用lambda方式构建查询

解决问题

那么非要使用lambda的话, 第一个参数怎么传递呢

service中调用this.lambdaQuery().eq方法, 字段名使用SFunction类型接收, 这个参数必须是lambda方式, 否则无法获取方法名, 也就无法获取变量名

让我们来看一眼它是怎么获取方法名的吧, 最终我找到了这个工具方法: com.baomidou.mybatisplus.core.toolkit.LambdaUtils#extract

/**
 * 该缓存可能会在任意不定的时间被清除
 *
 * @param func 需要解析的 lambda 对象
 * @param <T>  类型，被调用的 Function 对象的目标类型
 * @return 返回解析后的结果
 */
public static <T> LambdaMeta extract(SFunction<T, ?> func) {
    // 1. IDEA 调试模式下 lambda 表达式是一个代理
    if (func instanceof Proxy) {
        return new IdeaProxyLambdaMeta((Proxy) func);
    }
    // 2. 反射读取
    try {
        Method method = func.getClass().getDeclaredMethod("writeReplace");
        return new ReflectLambdaMeta((SerializedLambda) ReflectionKit.setAccessible(method).invoke(func));
    } catch (Throwable e) {
        // 3. 反射失败使用序列化的方式读取
        return new ShadowLambdaMeta(com.baomidou.mybatisplus.core.toolkit.support.SerializedLambda.extract(func));
    }
}

最终返回了一个LambdaMeta接口(两个方法, 一个获取实体类名, 一个获取字段名)

查看其注释, 我们要构造一个SFunction的实现类, 其具有writeReplace方法, 返回值是一个SerializedLambda对象

此对象不会是代理, 因为我们无法使用lambda, 也不会反序列化失败, 所以只需要兼容其第二步即可

声明这么一个对象看看效果:

/**
 * 构造mbp的lambda表达式, 用以欺骗mbp
 *
 * @author ly-chn
 * @see com.baomidou.mybatisplus.core.toolkit.support.SFunction
 */
@SuppressWarnings("AlibabaClassNamingShouldBeCamel")
@AllArgsConstructor
public class SFunctionMask<T> implements SFunction<T, Object> {
    private String fieldName;

    @Override
    public Object apply(T t) {
        return null;
    }

    @SuppressWarnings("unused")
    private SerializedLambda writeReplace() {
        return new SerializedLambda(
                null,
                null,
                null,
                null,
                0,
                null,
                "get" + fieldName,
                null,
                "LY" + instantiatedMethodType + ";",
                new Object[0]
        );
    }
}

SFunctionMask的目的很明确, 就是实现SFunction, 且有一个能够返回SerializedLambda对象的writeReplace方法

返回的SerializedLambda只用到了两个内容: 所属类名, 方法名

类名即实体类名, 调用service.getEntityClass()即可获取, 添加"LY"前缀和分号后缀的原因见com.baomidou.mybatisplus.core.toolkit.support.ReflectLambdaMeta#getInstantiatedClass;

方法名需要以get/set开头, mybatis plus会自动去掉

那么, 问题解决了

工具类最终实现

篇幅有限, 删掉注释和导包, 完整代码见github

public class MbpUtil {
    private static final String betweenMin = "Min";
    private static final String betweenMax = "Max";

    public static <M extends BaseMapper<T>, T> LambdaQueryChainWrapper<T> buildSearch(ServiceImpl<M, T> service, Object query) {
        LambdaQueryChainWrapper<T> result = service.lambdaQuery();
        HashMap<Field, Object> fieldValueMap = new HashMap<>();

        for (Field field : FieldUtils.getFieldsListWithAnnotation(query.getClass(), MbpQuery.class)) {
            try {
                Object value = FieldUtils.readField(field, query, true);
                if (Objects.isNull(value) || (value instanceof String && StringUtils.isEmpty((String) value))) {
                    continue;
                }
                fieldValueMap.put(field, value);
            } catch (IllegalAccessException ignored) {
            }
        }
        if (fieldValueMap.isEmpty()) {
            return result;
        }
        HashMap<Field, Object> betweenFieldValueMap = new HashMap<>();

        String entityClassName = service.getEntityClass().getName();
        Function<String, SFunctionMask<T>> nameMask = fieldName -> new SFunctionMask<>(fieldName, entityClassName);
        Function<Field, SFunctionMask<T>> mask = field -> new SFunctionMask<>(field.getName(), entityClassName);
        // 处理非between字段
        fieldValueMap.forEach((field, value) -> {
            MbpQuery annotation = field.getAnnotation(MbpQuery.class);
            // noinspection AlibabaSwitchStatement
            switch (annotation.type()) {
                case EQ -> result.eq(mask.apply(field), value);
                case NE -> result.ne(mask.apply(field), value);
                case GT -> result.gt(mask.apply(field), value);
                case GE -> result.ge(mask.apply(field), value);
                case LT -> result.lt(mask.apply(field), value);
                case LE -> result.le(mask.apply(field), value);
                case LIKE -> result.like(mask.apply(field), value);
                case NOT_LIKE -> result.notLike(mask.apply(field), value);
                case LIKE_LEFT -> result.likeLeft(mask.apply(field), value);
                case LIKE_RIGHT -> result.likeRight(mask.apply(field), value);
                case NOT_LIKE_LEFT -> result.notLikeLeft(mask.apply(field), value);
                case NOT_LIKE_RIGHT -> result.notLikeRight(mask.apply(field), value);
                case IN -> result.in(mask.apply(field), value);
                case NOT_IN -> result.notIn(mask.apply(field), value);
                case BETWEEN, NOT_BETWEEN -> betweenFieldValueMap.put(field, value);
                default -> throw new LyException.Panic("架构支持能力不足");
            }
        });
        // 处理between字段
        betweenFieldValueMap.forEach((field, value) -> {
            if (field.getName().endsWith(betweenMin)) {
                String fieldName = field.getName().substring(0, field.getName().length() - betweenMin.length());
                String maxFieldName = fieldName + betweenMax;
                Optional<Field> maxFieldOptional = betweenFieldValueMap.keySet().stream()
                        .filter(it -> it.getName().contentEquals(maxFieldName)).findFirst();
                if (maxFieldOptional.isEmpty()) {
                    return;
                }
                Field maxField = maxFieldOptional.get();
                Object maxValue = betweenFieldValueMap.get(maxField);
                MbpQuery annotation = field.getAnnotation(MbpQuery.class);
                // noinspection AlibabaSwitchStatement
                switch (annotation.type()) {
                    case BETWEEN -> result.between(nameMask.apply(fieldName), value, maxValue);
                    case NOT_BETWEEN -> result.notBetween(nameMask.apply(fieldName), value, maxValue);
                    default -> throw new LyException.Panic("架构支持能力不足");
                }
            }
        });
        return result;
    }

    public static <M extends BaseMapper<T>, T> Page<T> page(ServiceImpl<M, T> service, Object query) {
        return buildSearch(service, query).page(Paging.startPage());
    }
}

跑一下试试

controller:

@RestController
@RequestMapping("/test-student")
@RequiredArgsConstructor
@Slf4j
public class TestStudentController {

    private final TestStudentService service;


    @GetMapping("search")
    public Page<TestStudent> search(TestStudentQuery query) {
        return service.search(query);
    }
}

query:

public record TestStudentQuery(
        @MbpQuery(type = QueryTypeEnum.LIKE)
        String stuNum,
        @MbpQuery(type = QueryTypeEnum.EQ)
        String sex,
        @MbpQuery(type = QueryTypeEnum.BETWEEN)
        LocalDate birthdayMin,
        @MbpQuery(type = QueryTypeEnum.BETWEEN)
        LocalDate birthdayMax,
        @MbpQuery(type = QueryTypeEnum.EQ)
        Integer starCount
) {
}

service impl:

@Override
public Page<TestStudent> search(TestStudentQuery query) {
    return MbpUtil.page(this, query);
}

test.http:

### 全部
GET http://localhost:8937/test-student/search?stuNum=1&sex=man&birthdayMin=2000-01-01&birthdayMax=2022-01-01&starCount=10
### between需要校验最大最小不能为空
GET http://localhost:8937/test-student/search?birthdayMax=2022-01-01

查看一下SQL日志:
在这里插入图片描述

确实是我们想要的

总结

多多少少还是有些弊端的, 如:

  1. 相较于原来, 缺少了实体类与检索pojo类的关联, 导致删字段时不方便查找引用
  2. 暂时还没遇到, 可能性能会有点问题, 我认为影响很小, 尤其是后台管理项目
    t.http:
### 全部
GET http://localhost:8937/test-student/search?stuNum=1&sex=man&birthdayMin=2000-01-01&birthdayMax=2022-01-01&starCount=10
### between需要校验最大最小不能为空
GET http://localhost:8937/test-student/search?birthdayMax=2022-01-01

查看一下SQL日志:

在这里插入图片描述

确实是我们想要的

总结

多多少少还是有些弊端的, 如:

  1. 相较于原来, 缺少了实体类与检索pojo类的关联, 导致删字段时不方便查找引用
  2. 暂时还没遇到, 可能性能会有点问题, 我认为影响很小, 尤其是后台管理项目
  3. 我不太擅长写文章, 没写清楚思路
ly-chn
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Mybatis-plus将查询结果封装到指定实体
加瓦攻城狮的博客
06-03 2422
需求背景: 需要将岗位角色与广告配置建立多对多的关系,通过多选岗位角色作为条件来查询广告配置 在网上看了几篇类似的文章,感觉都不太靠谱,自己总结一下 关键记录下Mybatis-plus中foreach和collection的使用 还有判断集合使用 list.size > 0 废话不多说,直接上代码 实体类 //广告类 @TableName(value = "TB_ADVERTISEMENT") public class Advertisement { @TableId(value = "ID")
mybatis plus的3种查询方式(小结)
09-07
主要介绍了mybatis plus的3种查询方式(小结)，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
使用MyBatisPlus让数据库和实体类字段自动映射
最新发布
qq_44624290的博客
06-18 1166
因为解析的时候是直接把User实体的name属性当做了插入语句的列名，而实际上我们需要的是user_name，因此这里就会出现异常了。那我就突然想到，会不会当我们使用MyBatisPlus自带的查询方法的时候，我们使用@TableField注解的查询也会自动映射呢？就是实现起来过于复杂，要写的东西太多了，因此我们后续又出现了MyBatisPlus提供的映射方式，就是我们可以直接通过注解映射。数据库表中的字段名字，与实体类中的属性名字不一致，我们想要让二者映射起来的时候，该怎么操作？
使用 MyBatisPlus 的注解方式进行 SQL 查询，它结合了条件构造器（Wrapper）和自定义 SQL 片段来构建查询语句。
Microhoo_苏福的博客
09-22 1159
MyBatis-Plus 是一个基于 MyBatis 的增强工具，它提供了一套方便的注解方式来进行 SQL 查询。其中，它结合了条件构造器（Wrapper）和自定义 SQL 片段来构建查询语句。
MyBatis Plus 分页 构造查询 子查询
if_else1的博客
05-16 8139
/** * @author xp * @description mybatis-plus分页 * @date 2019/3/15 11:03 */ @RequestMapping("/selectUserPage") @ResponseBody public IPage<User> selectUserPage...
MyBatis-Plus 条件构造器之实体（Entity）查询
热门推荐
kaven
10-09 1万+
MyBatis-Plus 条件构造器之实体（Entity）查询 首先创建一个数据库表，如下图所示： 然后创建一个Spring Boot项目，pom.xml和配置如下： <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
myabtis-plus根据实体类查询（根据对象非空字段查询）
Y_ANXI的博客
01-02 2799
mybatis根据实体对象查询所有非空字段
MyBatis-plus 模糊查询的使用
09-07
在实际开发中，模糊查询是一种常见的查询方式，用于查找包含特定字符或模式的数据。MyBatis-plus提供了简单易用的模糊查询功能。 在MyBatis-plus中，模糊查询主要通过`QueryWrapper`类来实现。`QueryWrapper`是一个...
详解MyBatis-Plus Wrapper条件构造器查询大全
08-24
MyBatis-Plus Wrapper 条件构造器查询大全是 MyBatis-Plus 框架中的一种强大查询功能，通过使用 Wrapper 条件构造器，可以实现复杂的查询操作。本文将通过示例代码，详细介绍 MyBatis-Plus Wrapper 条件构造器查询...
浅析Mybatis Plus和Mybatis的区别
09-07
3. **Mybatis Plus** 在Mybatis的基础上进行了增强，提供了诸如自动填充字段（例如创建时间和更新时间）、条件构造器（无需为每个查询条件写单独的方法）、分页插件、乐观锁等功能。此外，MP还提供了SQL性能监控、...
MyBatis-Plus 分页查询以及自定义sql分页的实现
09-07
public class MyBatisPlusConfig { @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); } } ``` 配置完成后，MyBatis-Plus 将自动处理分页逻辑。 ## 三、...
Mybatis-plus 实体类自定义查询注解
qq_33775107的博客
06-21 4028
自定义查询注解是为实体类中某些实体属性作为查询条件定义的，在实体属性上引入注解可以实现自动生成查询条件QueryWrapper的功能。
Mybatis查询结果封装到属性
weixin_44971379的博客
03-16 1154
对于数据库表来说，字段设计的规则一般由下划线组成 user_name user_age 而实体类属性一般遵循驼峰命名法 userName userAge 那么如何将数据库查询结果封装到实体类呢 select user_name,user_age from user 提供如下两种方法： 1：配置文件中配置Mabatis查询结果表字段，转驼峰 mybatis.configuration....
使用mybatis联合查询，封装对象
weixin_40686505的博客
11-05 1117
<resultMap id="BaseResultMapWithdepartment" type="crud.bean.Employee"> <id column="Id" jdbcType="INTEGER" property="id" /> <result column="name" jdbcType="VARCHAR" property="nam...
Mybatis查询结果映射实体类必须有空构造函数
北辰之北灬的博客
12-09 1958
提问：Mybatis查询结果映射到实体类的时候，实体类为什么必须有一个空的构造函数？ 答：Mybatis框架会调用这个默认构造方法来构造实例对象，即实体类需要通过Mybatis进行动态反射生成。 反射的Class.forName("className").newInstance();需要对应的类提供一个无参构造函数。 备注： 如果在类中没有提供任何构造方法，虚拟机会自动提供默认构造方法（无...
Mybatis-plus自动生成CRUD接口，可以实现通过实体类任意属性查询，CRUD神器
jjj___jjj的博客
05-27 973
后端的程序员往往苦于写CRUD的编写，但是在出现Mybatis-Plus之后，大大简化了编写sql完成CRUD操作的繁琐步骤。当然自动生成代码也是快速编写代码的重要的一步，对此由于之前有写过相关的博客，这边就不多赘述了，可以参考https://blog.csdn.net/jjj___jjj/article/details/117172161言归正传，面对重复的业务，还是需要编写许多重复的代码去完成CRUD操作，那有没有什么方法可以减少大量重复的代码编写呢？请接往下看。
MyBatis中将结果集封装到指定类型详解（反射Class.forName详解）
Small_Tsky的博客
06-17 969
文章目录1.将结果集封装到指定类型中1.1指定类型：1.2将信息存入到mapper中1.3反射1.3.1获取全限定类名,加载类并且实例化1.3.2执行SQL语句，生成的结果集获取元信息，把每列的数据存入到指定类型中1.4Class.forName方法扩展理解 Class.forName()Class.forName() 与 xxx.class的区别小结：初始化和实例化的区别： 1.将结果集封装到指定类型中 1.1指定类型： 1.2将信息存入到mapper中 mapper的构造：成员变量：`` privat
通过myBatis将sql语句返回的值自动包装成一个java对象（1）以及SqlSessionFactory
qq_52315213的博客
01-15 1163
（我可以通过mysql的用户界面访问数据库，创建会话，也可以通过idea来访问数据库，这两种访问方式虽然都访问了相同的数据库，但相互没有关联）。所以在这个类里，即使字段默认为protected的，也没有编写getter和setter方法，但是在这个类外，我们依旧可以使用getter和setter方法来编辑类。要想把数据库里的数据映射成一个java对象，首先我们需要有一个对应的java类来描述数据库中的这个对象。-- 定义映射器命名空间，通常与对应的 Java 接口或类的全限定名一致 -->
mybatis原理：结果集封装详解
qiuxinfa123的博客
09-10 5068
经过sql参数解析、sql动态组装和执行sql，相对而言，结果集的封装，是mybatis数据处理的最后一环。这里只对查询结果而言，因为更新语句一般都是返回影响的行数。抛开mybatis，如果让我们组装结果，我们该如何进行呢？mybatis的查询结果统一表示为： List<E> 即使是查询单个对象，它的查询结果还是封装成 List<E> 对象，然后返回list集合的第一个元素。 个人根据mybatis的源码，将mybatis对结果集的封装，分成两步： （1）通...
mybatis plus 单条件查询
05-16
对于单条件查询，Mybatis Plus提供了很多便捷的方法，以下是其中一种方法的示例代码： 假设我们有一个用户表，包含id、username、age三个字段，我们要查询年龄等于18的用户信息，可以使用如下代码： ``` Query...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值