使用spring data的page和pageable如何实现分页查询
作者:scluis
这篇文章主要介绍了使用spring data的page和pageable如何实现分页查询,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
spring data的page和pageable实现分页查询
总结一下利用pageable和page实现分页查询的方法
Pageable
Pageable 是Spring Data中定义的一个接口,用于构造分页查询请求,通过该接口,我们可以得到和分页查询请求相关的所有信息,这样,Jpa就能够通过Pageable来查询数据库。
Pageable的属性如下:
{ "page"://查询第几页,从0开始,默认为0也就是查询第一页 "size"://每一页的显示的数量,默认为20 "sort"://排序相关的信息,可以指明查询结果在页面显示的排序方式 }
Page
Page用来存储我们查询返回的结果,包含了分页查询结果的必要属性。
page的属性如下:
{ "content":,//数据内容 "last":false,//是否最后一页 "totalPages":,//总页数 "totalElements":,//总数据数 "size":,//一页数据大小 "number":,//当前显示的是第几页,0代表第一页 "first":,//是否第一页 "sort":[{//每页数据排序方式 "direction":"DESC",//排序方式 "property":"id",//排序依据的属性 "ignoreCase":false, "nullHandling":"NATIVE", "ascending":false }], "numberOfElements":15 }
代码实现
前端(thymeleaf):
<a href="#" rel="external nofollow" class="item" th:href="@{/admin/types}" rel="external nofollow" >列表</a>
后端controller:
@Controller @RequestMapping("/admin/types") public class typeController { @Autowired private typeService typeService; @GetMapping //分页显示type列表,PageableDefault注解指明分页的默认参数 public String types(@PageableDefault(size = 6,sort = {"id"},direction = Sort.Direction.DESC) Pageable pageable , Model model){//利用spring data pageable实现分页,注意是org.springframework.data.domain包下 //把查询出的数据放到model model.addAttribute("page",typeService.getTypeList(pageable)); return "admin/types"; }
后端service:
public Page<Type> getTypeList(Pageable pageable) { return typeRepository.findAll(pageable); }
后端dao:
public interface typeRepository extends JpaRepository<Type,Long> { }
(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; }
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。