【Spring】SpringData通用分页查询

• 通常情况下，SpringData是有提供相应的分页查询接口的，比如在我的另一篇博文中SpringData ES中提到的那样。但是这种方式，一般仅限于最直接的分页查询，不适用于更深层次的嵌套。比如ES中嵌在其他实体中的nested实体，本文也是为了解决这个问题才做的学习。

思路

• 一个最直接的想法就是查询出所需要的数据，一般是一个List，然后将List转成Page.

实现

• List转Page的分页接口

package cn.edu.zucc.syx.rec.util;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageImpl;
import org.springframework.data.domain.Pageable;

import java.util.ArrayList;
import java.util.List;

public interface PageUtil {

    /**
     * Create a {@link org.springframework.data.domain.Page} from a {@link java.util.List} of objects
     *
     * @param list     List数据
     * @param pageable 分页参数.
     * @param <T>     包含数据
     * @return page
     */
    static <T> Page<T> createPageFromList(List<T> list, Pageable pageable) {
        if (list == null) {
            throw new IllegalArgumentException("list不能为空");
        }

        int startOfPage = pageable.getPageNumber() * pageable.getPageSize();
        if (startOfPage > list.size()) {
            return new PageImpl<>(new ArrayList<>(), pageable, 0);
        }

        int endOfPage = Math.min(startOfPage + pageable.getPageSize(), list.size());
        return new PageImpl<>(list.subList(startOfPage, endOfPage), pageable, list.size());
    }
}

• Enttity(Getter,Setter,Construct省略，请自己补全)

@Document(indexName= "sheet", type= "sheet")
public class Sheet {

    @Id
    @Field(type = FieldType.Keyword)
    private String id;
    @Field(type = FieldType.Keyword)
    private String name;
    @Field(type = FieldType.Text)
    private String description;
    @Field(type = FieldType.Keyword)
    private String creator_id;
    @Field(type = FieldType.Keyword)
    private String creator_name;
    @Field(type = FieldType.Boolean)
    private Boolean is_open;
    @Field(type = FieldType.Nested)
    private List<KeySong> songs;

• Repository

public interface SheetRepository extends ElasticsearchRepository<Sheet, Integer> {
    List<Sheet> findByNameLike(String name);
}

• Service接口

public interface SheetService {
    Sheet getInfo(String sheetId);
}

• Service实现类

    @Override
    public Sheet getInfo(String sheetId) {
        return sheetRepository.findById(sheetId);
    }

• Controller

    /**
     * 查看歌单详情(含分页)
     */
    @GetMapping("/get_info")
    public JSONObject getsth(@RequestParam("sheet_id") String sheetId,
                                @RequestParam("page_num") int pageNum,
                                @RequestParam("page_size") int pageSize){
        JSONObject ret = new JSONObject();

        try {
            Sheet sheet = sheetService.getInfo(sheetId);
            List<KeySong> songs = sheet.getSongs();
            Pageable pageable = PageRequest.of(pageNum-1, pageSize);
            Page<KeySong> page = PageUtil.createPageFromList(songs, pageable);
            ret = util.sheetInfoPage2Json(sheet, page);
        }catch (Exception e){
            ret.put("code", "error");
            ret.put("msg", "failed");
        }

        return ret;
    }

• 上面涉及到的工具类

    public JSONObject sheetInfoPage2Json(Sheet sheet, Page<KeySong> page){
        JSONObject ret = new JSONObject();
        JSONObject tmp = new JSONObject();
        tmp.put("sheet_id", sheet.getId());
        tmp.put("sheet_name", sheet.getName());
        tmp.put("description", sheet.getDescription());
        tmp.put("page_total", page.getTotalPages());
        tmp.put("page_num", page.getNumber()+1);
        tmp.put("page_size", page.getSize());
        List<KeySong> songs = page.getContent();
        tmp.put("songs", songs);
        ret.put("code", Statue.SUCCESS);
        ret.put("data", tmp);

        return ret;
    }

参考

1. CSDN, Tonels, 《List对象转Page对象参考，一行代码实现》, https://blog.csdn.net/qq_42105629/article/details/99582595
2. CSDN, Tonels, 《SpringData中Page是个什么东西，架构和数据格式》, https://blog.csdn.net/qq_42105629/article/details/99575507