SpringJPA 做分页条件查询的代码实践_Java

前言:

相信小伙伴们的项目很多都用到springjpa框架的吧,对于单表的增删改查利用jpa是很方便的,但是对于条件查询并且分页是不是很多小伙伴不经常写到. 今天我整理了一下在这里分享一下.
话不多说直接上代码:

controller:

@restcontroller
public class productinstancecontroller {
    @autowired
    private productinstanceservice productinstanceservice;
    @postmapping("page-find-instance")
    public pageinfovo<productinst> pagefindinstance(@requestbody productinstparams productinstparams) {
        return productinstanceservice.pagefindinstance(productinstparams);
    }
}

service:

@service
public class productinstanceservice {
    @autowired
    private productinstrepository productinstrepository;
    public pageinfovo<productinst> pagefindinstance(productinstparams productinstparams) {
        sort.direction direction = sort.direction.desc;
        //创建一个pageable对象，其中包含了请求的页码(productinstparams.getpageno())，每页大小(productinstparams.getpagesize())，排序规则以及排序字段名。
        pageable pageable = pagerequest.of(productinstparams.getpageno(), productinstparams.getpagesize(), direction, "createdtime");
		//将传入的字符串类型的开始日期(startdate)和结束日期(enddate)转换成date类型
        date start = dateutil.parseutc(productinstparams.getstartdate());
        date end = dateutil.parseutc(productinstparams.getenddate());
        //执行jpa分页查询：
        page<productinst> productinstpage = productinstrepository.findall((root, query, criteriabuilder) -> {
        //初始化一个arraylist<predicate>，存储多个谓词条件，这些条件最终会被组合成一个逻辑与（and）表达式
            list<predicate> predicatesandlist = new arraylist<>();
            // deleted = 'true'
            if (null != productinstparams.getisdeleted()) {
				predicatesandlist.add(criteriabuilder.equal(root.get("deleted").as(boolean.class), productinstparams.getisdeleted()));
            }
            // name like %name%
            if (stringutils.isnotblank(productinstparams.getname())) {
                predicatesandlist.add(criteriabuilder.like(root.get("name").as(string.class), productinstparams.getname()));
            }
            // runstatus = "运行中"
            if (stringutils.isnotblank(productinstparams.getrunstatus())) {
                predicatesandlist.add(criteriabuilder.equal(root.get("runstatus").as(string.class), productinstparams.getrunstatus()));
            }
            // createdtime >= start
            if (!objects.isnull(start)) {
                predicatesandlist.add(criteriabuilder.greaterthanorequalto(root.get("createdtime").as(date.class), start));
            }
            // createdtime <= end
            if (!objects.isnull(end)) {
                predicatesandlist.add(criteriabuilder.lessthanorequalto(root.get("createdtime").as(date.class), end));
            }
            // id in ('1','2')
            if (!collectionutils.isempty(productinstparams.getids())) {
                criteriabuilder.in<string> in = criteriabuilder.in(root.get("id").as(string.class));
                productinstparams.getids().foreach(in::value);
                predicatesandlist.add(in);
            }
            predicate andpredicate = criteriabuilder.and(predicatesandlist.toarray(new predicate[predicatesandlist.size()]));
            query.where(andpredicate);
            return query.getrestriction();
        }, pageable);
        return pageutil.generatepageinfovo(productinstpage);
    }
}

解释:
jpa分页查询调的方法是:
page findall(@nullable specification spec, pageable pageable);
该方法接受两个参数：
一个是 specification 对象，用于构建复杂的查询条件；
另一个是之前创建的pageable对象，用于指定分页及排序信息。
点进去可以直接看到

下面我再解释一下这行代码

criteriabuilder.equal(root.get("runstatus").as(string.class), productinstparams.getrunstatus());

1. criteriabuilder 是javax.persistence.criteria.criteriabuilder的一个实例，它是用来构建jpql查询条件的对象。

2. root 是代表查询主表的root对象，它指向productinst实体类对应的数据库表。

3. root.get(“runstatus”) 表示获取productinst实体类中的runstatus属性(注意:这地方写的不是数据库的字段,我数据库的字段是:run_status)。这个方法返回的是一个path<未知类型>对象，表示runstatus字段在查询路径上的位置。

4. .as(string.class) 是类型转换，确保runstatus被视为string类型，因为在数据库中它可能被映射为varchar或者其他文本类型字段。

5. productinstparams.getrunstatus() 获取传入参数对象productinstparams中的runstatus属性值，这是一个待匹配的实际值。
综上所述:这段代码对应的sql

where run_status = 'xxxx'

repository:

@repository
public interface productinstrepository extends jparepository<productinst, string>, jpaspecificationexecutor<productinst> {
}

pageinfovo:

package com.king.alice.common.base;
import lombok.getter;
import lombok.setter;
import java.util.list;
/**
 * @author wlt
 * @description 分页数据中的元素
 * @date 2022/8/26
 **/
@getter
@setter
public class pageinfovo<t> extends basevo{
    private static final long serialversionuid = -3542944936096780651l;
    /**
     * 总记录数
     */
    private long total;
    /**
     * 当前页
     */
    private int pagenum;
    /**
     * 每页的数量
     */
    private int pagesize;
    /**
     * 结果集
     */
    private list<t> list;
}

pageutil:

package com.king.alice.common.util;
import com.king.alice.common.base.pageinfovo;
import org.springframework.data.domain.page;
/**
 * @author 大魔王
 * @description:
 * @date 2024/3/22 11:02
 */
public class pageutil {
    /**
     * 根据page对象生成pageinfovo
     *
     * @param page page包装对象
     * @return pagedto 对象
     */
    @suppresswarnings({"unchecked"})
    public static <t> pageinfovo<t> generatepageinfovo(page page) {
        pageinfovo result = new pageinfovo();
        result.setpagenum(page.getnumber() + 1);
        result.setpagesize(page.getpageable().getpagesize());
        result.settotal(page.gettotalelements());
        result.setlist(page.getcontent());
        return result;
    }
}

productinstparams:

package com.king.alice.manage.instance.params;
import lombok.data;
import java.util.list;
/**
 * @author 大魔王
 * @description: todo
 * @date 2024/3/21 16:56
 */
@data
public class productinstparams {
    /**
     * 当前页
     */
    private int pageno;
    /**
     * 每页的数量
     */
    private int pagesize;
    /**
     * 名字
     */
    private list<string> ids;
    /**
     * 名字
     */
    private string name;
    /**
     * 运行状态
     */
    private string runstatus;
    private string startdate;
    private string enddate;
    private boolean isdeleted;
}