springboot jpa 分页查询工具类

1、查询关系匹配枚举

package com.xx.xxx.enums;

/**
 * @description: 查询条件关系匹配
 * @author: fangzhao
 * @create: 2020/4/1 15:34
 * @update: 2020/4/1 15:34
 */
public enum MatchCondition {
    /**
     * equal-相等,notEqual-不等于,like-模糊匹配,notLike-,
     * gt-大于,ge-大于等于,lt-小于,le-小于等于,
     * greaterThan-大于,greaterThanOrEqualTo-大于等于,lessThan-小于,lessThanOrEqualTo-小于等于
     */
    EQUAL,
    NOT_EQUAL,
    LIKE,
    NOT_LIKE,

    GT,
    GE,
    LT,
    LE,

    GREATER_THAN,
    GREATER_THAN_OR_EQUAL_TO,
    LESS_THAN,
    LESS_THAN_OR_EQUAL_TO
}

2、查询条件注解

package com.xx.xxx.annotations;

import com.xx.xxx.enums.MatchCondition;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @description: 查询条件
 * @author: fangzhao
 * @create: 2020/4/1 15:34
 * @update: 2020/4/1 15:34
 */
@Target({ElementType.FIELD,ElementType.CONSTRUCTOR })
@Retention(RetentionPolicy.RUNTIME)
public @interface QueryCondition {

    /**
     * 数据库中字段名,默认为空字符串,则Query类中的字段要与数据库中字段一致
     */
    String column() default "";

    /**
     * @see MatchCondition
     */
    MatchCondition func() default MatchCondition.EQUAL;

    /**
     * object是否可以为null
     */
    boolean nullable() default false;

    /**
     * 字符串是否可为空
     */
    boolean emptyable() default false;
}

3、分页工具类

package com.xx.xxx.utils;

import com.xx.xxx.annotations.QueryCondition;
import com.xx.xxx.vo.OrderInfoVo;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.lang.Nullable;
import org.springframework.util.CollectionUtils;

import javax.persistence.criteria.*;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.time.LocalDateTime;
import java.util.*;

/**
 * @description: 分页和排序工具类
 * @author: fangzhao
 * @create: 2020/3/24 13:09
 * @update: 2020/3/24 13:09
 */
@Slf4j
public class PageUtil<T> {

    /**
     * 描述:排序处理,默认id降序
     *
     * @param orderInfos,这里也可以使用可变长度的参数列表 OrderInfoVo... 
     * @return org.springframework.data.domain.Sort
     * @author fangzhao at 2020/11/13 9:22
     */
    public static Sort getSortOrder(List<OrderInfoVo> orderInfos) {
        List<Sort.Order> sortOrders = new ArrayList<>();
        if (null == orderInfos || CollectionUtils.isEmpty(orderInfos)) {
            Sort.Order sortOrder = new Sort.Order(Sort.Direction.DESC, "id");
            sortOrders.add(sortOrder);
        } else {
            for (OrderInfoVo order : orderInfos) {
                String orderField = order.getOrderField();
                String orderType = order.getOrderType();
                Sort.Order sortOrder = new Sort.Order("asc".equalsIgnoreCase(orderType) ? Sort.Direction.ASC : Sort.Direction.DESC, orderField);
                sortOrders.add(sortOrder);
            }
        }
        return Sort.by(sortOrders);
    }

    /**
     * 描述:生成查询条件
     *
     * @param rangeTime
     * @param timeStart
     * @param timeEnd
     * @return org.springframework.data.jpa.domain.Specification<T>
     * @author fangzhao at 2020/11/13 9:24
     */
    public Specification<T> specification(String rangeTime, LocalDateTime timeStart, LocalDateTime timeEnd) {

        return (Specification<T>) (root, criteriaQuery, criteriaBuilder) -> {
            // 增加筛选条件
            Predicate predicate = criteriaBuilder.conjunction();
            // 起始日期
            if (null != timeStart) {
                predicate.getExpressions().add(criteriaBuilder.greaterThanOrEqualTo(root.get(rangeTime).as(LocalDateTime.class), timeStart));
            }
            // 结束日期
            if (null != timeEnd) {
                predicate.getExpressions().add(criteriaBuilder.lessThan(root.get(rangeTime).as(LocalDateTime.class), timeEnd));
            }
            return predicate;
        };
    }

    /**
     * @description: 根据注解信息生成查询条件
     * @creater: fangzhao
     * @updater:
     * @create: 2020/3/24 13:09
     * @update: 2020/3/24 13:09
     * @Param: request entity
     * @return:
     */
    public Specification specification(T request, T entity) {

        List<Field> reqFieldList = getAllFieldsWithRoot(request.getClass());
        Map<T, List<Field>> map = new HashMap<>(16);
        map.put(request, reqFieldList);
        for (Field field : reqFieldList) {
            if (field.getType().equals(entity.getClass())) {
                List<Field> entityFieldList = getAllFieldsWithRoot(field.getType());
                map.put(entity, entityFieldList);
                break;
            }
        }
        return getSpecification(request, map);
    }

    /**
     * 描述:根据注解信息生成查询条件
     *
     * @param request
     * @return org.springframework.data.jpa.domain.Specification
     * @author fangzhao at 2020/4/9 10:00
     */
    public Specification specification(T request) {

        List<Field> reqFieldList = getAllFieldsWithRoot(request.getClass());
        Map<T, List<Field>> map = new HashMap<>(4);
        map.put(request, reqFieldList);
        return getSpecification(request, map);
    }

    /**
     * 描述:获取类clazz的所有Field,包括其父类的Field
     *
     * @param clazz
     * @return java.util.List<java.lang.reflect.Field>
     * @author fangzhao at 2020/4/9 10:00
     */
    private List<Field> getAllFieldsWithRoot(Class<?> clazz) {
        List<Field> fieldList = new ArrayList<>();
        Field[] dFields = clazz.getDeclaredFields();
        if (ArrayUtils.isNotEmpty(dFields)) {
            fieldList.addAll(Arrays.asList(dFields));
        }

        // 若父类是Object,则直接返回当前Field列表
        Class<?> superClass = clazz.getSuperclass();
        if (Object.class == superClass) {
            return Arrays.asList(dFields);
        }

        // 递归查询父类的field列表
        List<Field> superFields = getAllFieldsWithRoot(superClass);

        if (!CollectionUtils.isEmpty(superFields)) {
            superFields.stream().
                    filter(field -> !fieldList.contains(field)).
                    forEach(field -> fieldList.add(field));
        }
        return fieldList;
    }

    /**
     * 描述:生成查询条件
     *
     * @param request
     * @param map
     * @return org.springframework.data.jpa.domain.Specification
     * @author fangzhao at 2020/4/9 9:59
     */
    private Specification getSpecification(T request, Map<T, List<Field>> map) {
        Specification<T> specification = new Specification<T>() {
            @Nullable
            @Override
            public Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder criteriaBuilder) {
                Predicate predicate = criteriaBuilder.conjunction();
                if (null == map || CollectionUtils.isEmpty(map)) {
                    return predicate;
                }
                Set objects = map.keySet();
                for (Object obj : objects) {
                    List<Field> fieldList = map.get(obj);
                    for (Field field : fieldList) {
                        QueryCondition qc = field.getAnnotation(QueryCondition.class);
                        if (null == qc) {
                            continue;
                        }
                        // 如果主注解上colume为默认值"",则以field为准
                        String column = StringUtils.isNotBlank(qc.column()) ? qc.column() : field.getName();
                        field.setAccessible(true);

                        Object value = null;
                        // 默认getter方法获取属性值,如果是boolean基本类型,设置为is
                        String getValueType = "boolean".equals(field.getGenericType().toString()) ? "is" : "get";
                        char[] chars = field.getName().toCharArray();
                        chars[0] -= 32;
                        try {
                            Method method = obj.getClass().getMethod(getValueType + new String(chars));
                            value = method.invoke(obj);
                        } catch (Exception e) {
                            log.error("dataMiddle tools: {}", e.getMessage());
                        }
                        // 如果值为null,且注解未标注nullable,跳过
                        if (null == value && !qc.nullable()) {
                            continue;
                        }
                        if (null != value && String.class.isAssignableFrom(value.getClass())) {
                            String s = (String) value;
                            // 如果值为"",且注解未标注emptyable,跳过
                            if ("".equals(s) && !qc.emptyable()) {
                                continue;
                            }
                        }
                        // 通过注解上func属性,构建路径表达式
                        Path path = null;
                        try {
                            path = root.get(column);
                        } catch (IllegalArgumentException e) {
                            log.error("dataMiddle tools: {}", e.getMessage());
                        }
                        if (null != path) {
                            switch (qc.func()) {
                                case EQUAL:
                                    predicate.getExpressions().add(criteriaBuilder.equal(path, value));
                                    break;
                                case LIKE:
                                    predicate.getExpressions().add(criteriaBuilder.like(path, "%" + value + "%"));
                                    break;
                                case GE:
                                    if (value instanceof LocalDateTime) {
                                        predicate.getExpressions().add(criteriaBuilder.greaterThanOrEqualTo(path.as(LocalDateTime.class), (LocalDateTime) value));
                                    }
                                    break;
                                case LT:
                                    if (value instanceof LocalDateTime) {
                                        predicate.getExpressions().add(criteriaBuilder.lessThan(path.as(LocalDateTime.class), (LocalDateTime) value));
                                    }
                                    break;
                                default:
                            }
                        }
                    }
                }
                return predicate;
            }
        };
        return specification;
    }
}

4、使用

public Page<DataStandardTypeEntity> getPage(DataStandardTypeReqVO request) {

        Sort sortOrder = PageUtil.getSortOrder(request.getOrderInfo());
        Pageable pageable = PageRequest.of(request.getPageNum() - 1, request.getPageSize(), sortOrder);
        Specification<DataStandardTypeEntity> specification = new PageUtil<>().specification(request, request.getEntity());
        return dataStandardTypeRepository.findAll(specification, pageable);
}

DataStandardTypeReqVO 字段添加响应的注解

package com.xx.xxx.vo;

import com.yss.datamiddle.po.DataStandardTypeEntity;

/**
 * @description: 数据标准类型请求类
 * @author: fangzhao
 * @create: 2020/3/24 13:09
 * @update: 2020/3/24 13:09
 */
public class DataStandardTypeReqVO extends RangeRequest{

    private DataStandardTypeEntity entity = new DataStandardTypeEntity();

    public DataStandardTypeEntity getEntity() {
        return entity;
    }

    public void setEntity(DataStandardTypeEntity entity) {
        this.entity = entity;
    }
}
package com.xxx.xxx.vo;

import com.xxx.xxx.annotations.QueryCondition;
import com.xxx.xxx.enums.MatchCondition;
import io.swagger.annotations.ApiModelProperty;
import org.springframework.format.annotation.DateTimeFormat;
import lombok.Data;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;

/**
 * @ClassName RangeRequest
 * @Description 请求范围
 * @Author fangzhao
 * @Date 2020/3/18 16:07
 */
public class RangeRequest<T> extends PageInfo {

    @ApiModelProperty(value = "创建时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.ge, column = "createTime")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTimeStart;

    @ApiModelProperty(value = "创建时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.lt, column = "createTime")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTimeEnd;

    @ApiModelProperty(value = "修改时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.ge, column = "modifyTime")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime modifyTimeStart;

    @ApiModelProperty(value = "修改时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.lt, column = "modifyTime")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime modifyTimeEnd;

    @ApiModelProperty(value = "有效期开始时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.ge, column = "validDate")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime validDateStart;

    @ApiModelProperty(value = "有效期截止时间", example = "2020-03-23 14:40:10", hidden = true)
    @QueryCondition(func = MatchCondition.lt, column = "validDate")
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime validDateEnd;

    @ApiModelProperty("排序信息")
    private List<OrderInfoVo> orderInfo = new ArrayList<>();
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,688评论 1 330
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,559评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,749评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,581评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,741评论 3 271
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,684评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,122评论 2 292
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,847评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,441评论 0 228
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,939评论 2 232
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,333评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,783评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,275评论 3 220
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,830评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,444评论 0 180
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,553评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,618评论 2 249

推荐阅读更多精彩内容