JAVA注解:@Pageable以及前端传参

Pageable 是Spring Data库中定义的一个接口，该接口是所有分页相关信息的一个抽象，通过该接口，我们可以得到和分页相关所有信息（例如pageNumber、pageSize等）。

Pageable定义了很多方法，但其核心的信息只有两个：一是分页的信息（page、size），二是排序的信息。

在请求中只需要在方法的参数中直接定义一个pageable类型的参数，当Spring发现这个参数时，Spring会自动的根据request的参数来组装该pageable对象。
Spring支持的request参数如下：

page ：第几页，从0开始，默认为第0页
size ：每一页的大小，默认为10
sort ：排序相关的信息，以`property[,ASC|DESC]`的方式组织，例如:
`sort=firstname&sort=lastname,desc`表示在按firstname正序排列基础上按lastname倒序排列。

下面举例说明：

一、服务端代码

@GetMapping("/orginfo/all")
public ResponseModel<Page> getAll(@PageableDefault(sort = {"name"}, direction = Sort.Direction.DESC) Pageable pageable) {
    Page<Org> orgs = orgInfoService.getAllOrg(pageable);
    return ResponseModel.ok().setBody(orgs);
}

可以看下@PageableDefault注解的源码定义：

package org.springframework.data.web;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.data.domain.Sort.Direction;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER})
public @interface PageableDefault {
    int value() default 10;

    int size() default 10;

    int page() default 0;

    String[] sort() default {};

    Direction direction() default Direction.ASC;
}

@PageableDefault(sort = {"name"}, direction = Sort.Direction.ASC) 注解表示默认以name正向排序，size默认为10个，page默认为第0页。

请注意：@PageableDefault注释也有一个sort属性，但如果我们要定义多个字段以按不同方向排序，我们必须使用@SortDefault。

@GetMapping("/orginfo/all")
public ResponseModel<Page> getAll(@PageableDefault(page = 0, size = 20)
    @SortDefault.SortDefaults({
    @SortDefault(sort = "name", direction = Sort.Direction.DESC),
    @SortDefault(sort = "id", direction = Sort.Direction.ASC)
    }) Pageable pageable) {
    Page<Org> orgs = orgInfoService.getAllOrg(pageable);
    return ResponseModel.ok().setBody(orgs);
}

二、客户端请求：
如果什么参数都不传

http://localhost:8080/orginfo/all

就用服务端接口定义的默认值，也就是以name降序排序，返回第0页，返回10条数据。

也可以这样请求：

http://localhost:8080/orginfo/all?size=100&page=3&sort=id,asc&sort=name,desc

以id正向排序再以name倒序排序，请求第3页，返回100条数据。

tips:

1、前端传参时注意sort属性是一个整体，因此是传入的参数应该是

sort=name,desc

而不是

sort=name&direction=desc

2、针对mysql数据库，中文字段排序可能不是按照拼音来排序的，可以把排序字段做一下特殊处理CONVERT(name USING GBK),如下

http://localhost:8080/orginfo/all?size=100&page=3&sort=id,asc&sort=CONVERT(name+USING+GBK),desc