• Home
• top.openyuan
• jpa-plus
• 1.0.3
• source code
• AbstractPredicateHandler.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

top.openyuan.jpa.specification.handler.AbstractPredicateHandler Maven / Gradle / Ivy

package top.openyuan.jpa.specification.handler;

import org.hibernate.query.criteria.internal.CriteriaBuilderImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import top.openyuan.jpa.exception.BuildSpecificationException;
import top.openyuan.jpa.specification.handler.bean.BetweenValue;
import top.openyuan.jpa.specification.predicate.AbstractSimplePredicateExt;

import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.From;
import javax.persistence.criteria.Path;
import javax.persistence.criteria.Predicate;
import javax.persistence.criteria.Predicate.BooleanOperator;
import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;

/**
 * 用来动态构造 JPA 中 {@link Predicate} 的抽象类.
 *
 * @author lzy
 * @since v1.0.0
 */
public abstract class AbstractPredicateHandler implements PredicateHandler {

    private Logger logger = LoggerFactory.getLogger(AbstractPredicateHandler.class);

    /**
     * 获取对应注解类的 {@code Class} 类型的值.
     *
     * @return {@code Class} 类型的值
     */
    public abstract Class getAnnotation();

    /**
     * 构造 {@code AND} 关系的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 实体类的属性名
     * @param value 对应属性的值
     * @param annotation 前字段使用的注解
     * @param  范型 Z
     * @param  范型 X
     * @return {@link Predicate} 实例
     */
    public abstract  Predicate buildPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value, Annotation annotation);

    /**
     * 构造 {@code AND} 关系的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 属性字段名称
     * @param value 属性条件对应的值
     * @return {@link Predicate} 实例
     */
    @Override
    public Predicate buildPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        return this.buildPredicate(criteriaBuilder, from, fieldName, value, null);
    }

    /**
     * 构造相等条件 {@code Equals} 的 {@link Predicate} 条件.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 实体类的属性名
     * @param value 对应属性的值
     * @param  泛型 Z
     * @param  泛型 X
     * @return {@link Predicate} 实例
     */
    protected  Predicate buildEqualsPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        return criteriaBuilder.equal(from.get(fieldName), value);
    }

    /**
     * 构造不相等条件 {@code Not Equals} 的 {@link Predicate} 条件.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 实体类的属性名
     * @param value 对应属性的值
     * @param  泛型 Z
     * @param  泛型 X
     * @return {@link Predicate} 实例
     */
    protected  Predicate buildNotEqualsPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        return criteriaBuilder.notEqual(from.get(fieldName), value);
    }

    /**
     * 构造大于查询的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 属性字段名称
     * @param value 属性条件对应的值
     * @param  范型 Z
     * @param  范型 X
     * @return {@link Predicate} 实例
     */
    @SuppressWarnings({"unchecked", "rawtypes"})
    protected  Predicate buildGreaterThanPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        this.isValueComparable(value);
        return criteriaBuilder.greaterThan(from.get(fieldName), (Comparable) value);
    }

    /**
     * 构造大于等于查询的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 属性字段名称
     * @param value 属性条件对应的值
     * @param  范型 Z
     * @param  范型 X
     * @return {@link Predicate} 实例
     */
    @SuppressWarnings({"unchecked", "rawtypes"})
    protected  Predicate buildGreaterThanEqualPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        this.isValueComparable(value);
        return criteriaBuilder.greaterThanOrEqualTo(from.get(fieldName), (Comparable) value);
    }

    /**
     * 构造小于查询的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 属性字段名称
     * @param value 属性条件对应的值
     * @param  范型 Z
     * @param  范型 X
     * @return {@link Predicate} 实例
     */
    @SuppressWarnings({"unchecked", "rawtypes"})
    protected  Predicate buildLessThanPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        this.isValueComparable(value);
        return criteriaBuilder.lessThan(from.get(fieldName), (Comparable) value);
    }

    /**
     * 构造小于等于查询的 {@link Predicate} 实例的方法.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 属性字段名称
     * @param value 属性条件对应的值
     * @param  范型 Z
     * @param  范型 X
     * @return {@link Predicate} 实例
     */
    @SuppressWarnings({"unchecked", "rawtypes"})
    protected  Predicate buildLessThanEqualPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value) {
        this.isValueComparable(value);
        return criteriaBuilder.lessThanOrEqualTo(from.get(fieldName), (Comparable) value);
    }

    /**
     * 检查值是否实现了 {@link Comparable} 接口.
     *
     * @param value 值
     */
    private void isValueComparable(Object value) {
        if (!(value instanceof Comparable)) {
            throw new BuildSpecificationException("【Jpa-plus 异常】要比较的 value 值【" + value + "】不是可比较类型的，"
                    + "该值的类型必须实现了 java.lang.Comparable 接口才能正常参与比较，才能用于大于、大于等于、小于、小于等于之类的比较场景.");
        }
    }

    /**
     * 构造空条件 {@code IS NULL} 的 {@link Predicate} 条件.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param value 对应属性的值
     * @param  泛型 Z
     * @param  泛型 X
     * @return {@link Predicate} 实例
     */
    protected  Predicate buildIsNullPredicate(CriteriaBuilder criteriaBuilder, From from, Object value) {
        return criteriaBuilder.isNull(from.get(String.valueOf(value)));
    }

    /**
     * 构造不是空条件 {@code IS NOT NULL} 的 {@link Predicate} 条件.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param value 对应属性的值
     * @param  泛型 Z
     * @param  泛型 X
     * @return {@link Predicate} 实例
     */
    protected  Predicate buildIsNotNullPredicate(
            CriteriaBuilder criteriaBuilder, From from, Object value) {
        return criteriaBuilder.isNotNull(from.get(String.valueOf(value)));
    }

    /**
     * 构造相等条件 {@code Equals} 的 {@link Predicate} 条件.
     *
     * @param criteriaBuilder {@link CriteriaBuilder} 实例
     * @param from {@link From} 实例
     * @param fieldName 实体类的属性名
     * @param value 对应属性的值
     * @param allowNull 是否允许 null 值
     * @param  泛型 Z
     * @param  泛型 X
     * @return {@link Predicate} 实例
     */
    protected  Predicate buildInPredicate(
            CriteriaBuilder criteriaBuilder, From from, String fieldName, Object value, boolean allowNull) {
        value = value.getClass().isArray() ? Arrays.asList((Object[]) value) : value;
        Path