SpringJPA?做分頁條件查詢的代碼實踐

更新時間：2024年03月28日 10:52:56 作者：大魔王的日常Log

相信小伙伴們的項目很多都用到SpringJPA框架的吧,對于單表的增刪改查利用jpa是很方便的,但是對于條件查詢并且分頁?是不是很多小伙伴不經(jīng)常寫到,今天給大家分享SpringJPA?做分頁條件查詢的案例代碼,感興趣的朋友一起看看吧

前言:

相信小伙伴們的項目很多都用到SpringJPA框架的吧,對于單表的增刪改查利用jpa是很方便的,但是對于條件查詢并且分頁是不是很多小伙伴不經(jīng)常寫到. 今天我整理了一下在這里分享一下.
話不多說直接上代碼:

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;
        //創(chuàng)建一個Pageable對象，其中包含了請求的頁碼(productInstParams.getPageNo())，每頁大小(productInstParams.getPageSize())，排序規(guī)則以及排序字段名。
        Pageable pageable = PageRequest.of(productInstParams.getPageNo(), productInstParams.getPageSize(), direction, "createdTime");
		//將傳入的字符串類型的開始日期(startDate)和結(jié)束日期(endDate)轉(zhuǎn)換成Date類型
        Date start = DateUtil.parseUTC(productInstParams.getStartDate());
        Date end = DateUtil.parseUTC(productInstParams.getEndDate());
        //執(zhí)行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分頁查詢調(diào)的方法是:
Page findAll(@Nullable Specification spec, Pageable pageable);
該方法接受兩個參數(shù)：
一個是 Specification 對象，用于構(gòu)建復(fù)雜的查詢條件；
另一個是之前創(chuàng)建的pageable對象，用于指定分頁及排序信息。
點進去可以直接看到

下面我再解釋一下這行代碼

criteriaBuilder.equal(root.get("runStatus").as(String.class), productInstParams.getRunStatus());

1. criteriaBuilder 是javax.persistence.criteria.CriteriaBuilder的一個實例，它是用來構(gòu)建JPQL查詢條件的對象。

2. root 是代表查詢主表的Root對象，它指向ProductInst實體類對應(yīng)的數(shù)據(jù)庫表。

3. root.get(“runStatus”) 表示獲取ProductInst實體類中的runStatus屬性(注意:這地方寫的不是數(shù)據(jù)庫的字段,我數(shù)據(jù)庫的字段是:run_status)。這個方法返回的是一個Path<未知類型>對象，表示runStatus字段在查詢路徑上的位置。

4. .as(String.class) 是類型轉(zhuǎn)換，確保runStatus被視為String類型，因為在數(shù)據(jù)庫中它可能被映射為VARCHAR或者其他文本類型字段。

5. productInstParams.getRunStatus() 獲取傳入?yún)?shù)對象productInstParams中的runStatus屬性值，這是一個待匹配的實際值。
綜上所述:這段代碼對應(yīng)的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 分頁數(shù)據(jù)中的元素
 * @Date 2022/8/26
 **/
@Getter
@Setter
public class PageInfoVO<T> extends BaseVO{
    private static final long serialVersionUID = -3542944936096780651L;
    /**
     * 總記錄數(shù)
     */
    private long total;
    /**
     * 當(dāng)前頁
     */
    private int pageNum;
    /**
     * 每頁的數(shù)量
     */
    private int pageSize;
    /**
     * 結(jié)果集
     */
    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 {
    /**
     * 根據(jù)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 {
    /**
     * 當(dāng)前頁
     */
    private int pageNo;
    /**
     * 每頁的數(shù)量
     */
    private int pageSize;
    /**
     * 名字
     */
    private List<String> ids;
    /**
     * 名字
     */
    private String name;
    /**
     * 運行狀態(tài)
     */
    private String runStatus;
    private String startDate;
    private String endDate;
    private Boolean isDeleted;
}