对webmvc分页和排序的支持(非常实用)

在实际⼯工作中，我们经常有排序和分⻚页的需求，很多⼩小伙伴都在写⾃自⼰己的 Page 对象和排序逻辑，通过本节内容我们来看下 Spring Data JPA 对分⻚页和排序做了哪些⽀支持。

Spring Data 附带各种 Web ⽀支持如果模块⽀支持库的编程模型。

通过 @EnableSpringDataWebSupport 这个注解可以启⽤用 Web 集成⽀支持。

@EnableSpringDataWebSupport 注解配置在 JavaConfig 类上即可，如下：@Configuration @EnableWebMvc //开启⽀支持Spring Data web 的⽀支持@EnableSpringDataWebSupport public class WebConfiguration { }@Controller 上直接使⽤用 org.springframework.data.domain.Pageable 接收 Page 和分⻚页相关参数，利⽤用org.springframework.data.domain.Page 可以返回相关的 Page 对象的值，如下：第10课：对 MVCWeb 的⽀支持分⻚页和排序的⽀支持配置⽅方法利⽤用 @EnableSpringDataWebSupport G i t C h a timport org.springframework.data.domain.Page;import org.springframework.data.domain.PageRequest;import org.springframework.data.domain.Sort;@Controller @RequestMapping(path = "/demo")public class UserInfoController { @Autowired private UserRepository userRepository;/** * 案例1：使⽤用分⻚页和排序的 Pageable 对象返回 Page 对象。

* @param pageable * @return */@RequestMapping(path = "/user/page")@ResponseBody public Page<UserInfoEntity> findAllByPage(Pageable pageable) { return userRepository.findAll(pageable);}/** * 案例2：单独使⽤用排序，返回 HttpEntity 结果 * @param sort * @return */@RequestMapping(path = "/user/sort")@ResponseBody public HttpEntity<List<UserInfoEntity>> findAllBySort(Sort sort) { return new HttpEntity(userRepository.findAll(sort));}}这种⽅方法签名会导致 Spring MVC 尝试可分⻚页实例，⽽而请求参数使⽤用默认配置如下：Pageable ⾥里⾯面的字段描述page 你想要查找的第⼏几⻚页，如果你不传，默认是 0size 分⻚页⼤大⼩小，默认是 20sort 属性，应按格式 property,property(ASC|DESC)。

默认排序升序从⼩小到⼤大 ASC ，使⽤用多个 sort 参数，如果你想切换⽅方向，例如，?sort=firstname&sort=lastname,asc 所以请求的⽅方式如下。

（1）$ curl http://127.0.0.1:8080/demo/user/page G i t C h a t学习过 Spring MVC 的同学都知道实现 HandlerMethodArgumentResolver 接⼝口可以⾃自定义参数解析。

⽽而Spring Data JPA 正是利⽤用此特性，有两个参数解析类：PageableHandlerMethodArgumentResolver 的实例和 SortHandlerMethodArgumentResolver 的实例，帮我们解析 URL ⾥里⾯面的 Query Param 的 Page 相关的和Sort 相关的参数。

（1）@EnableSpringDataWebSupport 注解帮我们导⼊入 SpringDataWebConfiguration 关键源码如下：public String[] selectImports(AnnotationMetadata importingClassMetadata) { List<String> imports = new ArrayList<>(); imports.add(ProjectingArgumentResolverRegistrar.class.getName()); imports.add(resourceLoader// .filter(it -> ClassUtils.isPresent("org.springframework.hateoa s.Link", it))// .map(it -> HateoasAwareSpringDataWebConfiguration.class.getNam e())// .orElseGet(() -> SpringDataWebConfiguration.class.getName())); resourceLoader// .filter(it -> ClassUtils.isPresent("com.fasterxml.jackson.data bind.ObjectMapper", it))// .map(it -> SpringFactoriesLoader.loadFactoryNames(SpringDataJa cksonModules.class, it))// .ifPresent(it -> imports.addAll(it)); return imports.toArray(new String[imports.size()]); }（2）SpringDataWebConfiguration 帮我们加载 SortHandlerMethodArgumentResolver 和PageableHandlerMethodArgumentResolver ，关键源码如下：HandlerMethodArgumentResolvers 可分⻚页和排序G i t C h a t@Bean public PageableHandlerMethodArgumentResolver pageableResolver() { PageableHandlerMethodArgumentResolver pageableResolver = // new PageableHandlerMethodArgumentResolver(sortResolver()); customizePageableResolver(pageableResolver); return pageableResolver; } /* * (non-Javadoc) * @see org.springframework.data.web.config.SpringDataWebConfiguration#sortRes olver() */ @Bean public SortHandlerMethodArgumentResolver sortResolver() { SortHandlerMethodArgumentResolver sortResolver = new SortHandlerMethodArgu mentResolver(); customizeSortResolver(sortResolver); return sortResolver; }（3）PageableHandlerMethodArgumentResolver 的关键源码如下：通过此段源码其实也可以发现 Spring Data JPA 有默认分⻚页的⼤大⼩小，最⼤大 2000 size ，主要解析 page 和 size 参数。

G i t C h a tpublic class PageableHandlerMethodArgumentResolver implements PageableArgumentReso lver { private static final SortHandlerMethodArgumentResolver DEFAULT_SORT_RESOLVER = new SortHandlerMethodArgumentResolver(); private static final String INVALID_DEFAULT_PAGE_SIZE = "Invalid default page size configured for method %s! Must not be less than one!"; private static final String DEFAULT_PAGE_PARAMETER = "page"; private static final String DEFAULT_SIZE_PARAMETER = "size"; private static final String DEFAULT_PREFIX = ""; private static final String DEFAULT_QUALIFIER_DELIMITER = "_"; private static final int DEFAULT_MAX_PAGE_SIZE = 2000; static final Pageable DEFAULT_PAGE_REQUEST = PageRequest.of(0, 20); @Override public Pageable resolveArgument(MethodParameter methodParameter, @Nullable Mod elAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFact ory) { assertPageableUniqueness(methodParameter); Optional<Pageable> defaultOrFallback = getDefaultFromAnnotationOrFallback(methodParameter).toOptional(); String pageString = webRequest.getParameter(getParameterNameToUse(pagePara meterName, methodParameter)); String pageSizeString = webRequest.getParameter(getParameterNameToUse(size ParameterName, methodParameter));......return PageRequest.of(p, ps, sort.isSorted() ? sort : defaultOrFallback.map(Pageable::getSort).orElseGet(Sort::unsorted));}}通过此段源码其实还可以发现 PageRequest 是 Pageable 的默认实现类，此处给我们提供了⼀一种思路，当使⽤用 RPC 的 Service 的调⽤用的时候，可以⽤用过 new PageRequest 传递分⻚页逻辑。