title: 通用查询 permalink: /pages/010203/ article: false

date: 2022-02-09 10:50:01

通用查询

本项目对 Jpa 的查询进行了封装，现可以通过 @Query 注解实现简单的查询与复杂查询

简单查询：等于(默认)、大于等于、小于等于、左模糊、右模糊、中模糊、多字段模糊、NOT_EQUAL 、BETWEEN 、NOT_NULL。

复杂查询：包含（IN）查询、左连接、右连接等

参数说明

字段名称 字段描述 默认值
propName 对象的属性名，如果字段名称与实体字段一致，则可以省略 “”
type 查询方式，默认为 EQUAL
blurry 多字段模糊查询，值为实体字段名称 “”
joinName 关联实体的名称 “”
join 连接查询方式，左连接或者右连接 LEFT

使用方式

1、创建一个查询类 QueryCriteria

  1. @Data
  2. public class QueryCriteria {
  4.     // 等于
  5.     @Query
  6.     private String a;
  8.     // 左模糊
  9.     @Query(type = Query.Type.LEFT_LIKE)
  10.     private String b;
  12.     // 右模糊
  13.     @Query(type = Query.Type.RIGHT_LIKE)
  14.     private String c;
  16.     // 大于等于
  17.     @Query(type = Query.Type.GREATER_THAN, propName = "createTime")
  18.     private Timestamp startTime;
  20.     // 小于等于
  21.     @Query(type = Query.Type.LESS_THAN, propName = "createTime")
  22.     private Timestamp endTime;
  24.     // BETWEEN
  25.     @Query(type = Query.Type.BETWEEN)
  26.     private List<Timestamp> startTime;
  28.     // 多字段模糊查询，blurry 为字段名称
  29.     @Query(blurry = "a,b,c")
  30.     private String blurry;
  32.     // IN 查询
  33.     @Query(type = Query.Type.IN)
  34.     private List<String> d;
  36.     // 左关联查询，left Join ， joinName为关联实体名称 , propName为关联实体 字段
  37.     @Query(joinName = "", propName="")
  38.     private String e;
  40.     // 右关联查询，right Join ， joinName为关联实体名称 , propName为关联实体 字段
  41.     @Query(joinName = "", propName="", join = Query.Join.RIGHT)
  42.     private String f;
  44.     // NOT_EQUAL 不等于
  45.     @Query(type = Query.Type.NOT_EQUAL)
  46.     private String g;
  48.     // NOT_NULL 不为空
  49.     @Query(type = Query.Type.NOT_NULL)
  50.     private String g;
  51. }

2、在控制器中使用

  1. // Pageable 分页查询
  2. public ResponseEntity query(QueryCriteria criteria, Pageable pageable){
  3.     return new ResponseEntity(service.queryAll(criteria,pageable), HttpStatus.OK);
  4. }

3、Service 中查询

  1. @Override
  2. public Object queryAll(QueryCriteria criteria, Pageable pageable){
  3.     Page<实体> page = repository.findAll(((root, criteriaQuery, cb) -> QueryHelp.getPredicate(root, criteria, cb)),pageable);
  4.     return page;
  5. }

::: tip 如果需要添加一个字段查询，只需要在查询类 QueryCriteria 中添加就可以了，可节省大量时间。

源码可以查看 eladmin-common 模块中的 me.zhengjie.annotation.Query 与 me.zhengjie.utils.QueryHelp :::