Spring Boot Jpa之构建动态SQL查询语句

小灰灰 2022-06-15 03:11 453阅读 0赞

# Spring Boot Jpa之构建动态SQL查询语句 #

引入依赖包：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

**DAO接口继承`JpaSpecificationExecutor<T>`**。

该接口允许基于JPA标准的API规范的运行。

开始构建动态where子句要实现`Specification<T>`接口的  
`Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);`方法，该接口是领域驱动设计意义上的规范：

private Specification<ExportSubsidyPersonnel> getWhereClause(final long userId, final String agency, final Date startDate, final Date endDate,
                                                                     final String jobLevel, final String certificateGrade, final String remark) {
            return new Specification<ExportSubsidyPersonnel>() {
                @Override
                public Predicate toPredicate(Root<ExportSubsidyPersonnel> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
                    Predicate predicate = criteriaBuilder.conjunction();
                    predicate.getExpressions().add(
                            criteriaBuilder.and(root.<UserInfo>get("userInfo").in(userId))
                    );
                    if (!StringUtils.isEmpty(agency)) {
                        predicate.getExpressions().add(
                                criteriaBuilder.and(root.<String>get("agency").in(agency)));
                    }
                    predicate.getExpressions().add(
                            criteriaBuilder.between(root.<Date>get("time"), startDate, endDate)
                    );
                    if (!StringUtils.isEmpty(jobLevel)) {
                        predicate.getExpressions().add(
                                criteriaBuilder.and(root.<String>get("jobLevel").in(jobLevel)));
                    }
                    if (!StringUtils.isEmpty(certificateGrade)) {
                        predicate.getExpressions().add(
                                criteriaBuilder.and(root.<String>get("certificateGrade").in(certificateGrade)));
                    }
                    if (!Const.UNLIMITED.equals(remark)) {
                        predicate.getExpressions().add(
                                criteriaBuilder.and(root.<String>get("remark").in(remark)));
                    }
                    return predicate;
                }
            };
        }

`CriteriaBuilder`接口用来构建`Predicate`，而`Predicate`接口用来连接子句，每次添加到predicate之前都要进行参数非空判断。

其中`Root<X>`接口代表where子句的引用类型，如，

`root.<UserInfo>get("userInfo").in(userId)`,其中是ExportSubsidyPersonnel持有userInfo的属性，并且注解如下：

@ManyToOne(cascade = CascadeType.MERGE)
    @JoinColumn(name = "userId")
    private UserInfo userInfo;

`in`方法参数的userId即注解时的列名。相当于sql语法的in关键字。

`CriteriaBuilder`接口其中还包括`equal`等常用方法，对应sql语法的=。该接口用于构建标准查询，复合选择，表达式，谓词，排序。

最后将`getWhereClause`方法作为参数传入到被调用的方法中即可，如：

Page<ExportSubsidyPersonnel> exportSubsidyPersonnelPage = exportSubsidyPersonnelService
                    .querySubsidyPersonnelDetailed(getWhereClause(userId, agency, startDate, endDate, jobLevel,
                            certificateGrade, remark));

输出语句形如：

select
            count(exportsubs0_.id) as col_0_0_ 
        from
            export_subsidy_personnel exportsubs0_ 
        where
            (
                exportsubs0_.training_agency in (
                    ?
                )
            ) 
            and (
                exportsubs0_.time between ? and ?
            ) 
            and (
                exportsubs0_.remark in (
                    ?
                )
            )

以上。。。