Spring Boot集成SpringFox Swagger的Pageable参数问题

最新推荐文章于 2022-02-28 16:04:33 发布

weixin_34297300

最新推荐文章于 2022-02-28 16:04:33 发布

阅读量5.3k

点赞数

文章标签： java

原文链接：http://blog.51cto.com/7308310/2082742

版权

本文探讨了在Spring Boot项目中，当使用Springfox Swagger生成REST API文档时遇到Pageable参数的问题。由于Swagger默认生成的参数无法被Spring正确解析，需要通过@ApiImplicitParams、OperationBuilderPlugin或AlternateTypeRuleConvention来解决。分别介绍了这三种方法的使用和优缺点，包括添加隐式参数、自定义插件和类型规则约定，以确保传入的page、size、sort参数有效。

摘要由CSDN通过智能技术生成

Spring Boot项目中常使用springfox-swagger来生成REST API文档，使用springfox-swagger-ui进行API测试。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

REST API方法的参数含有org.springframework.data.domain.Pageable时，如未进行其它配置，Swagger根据接口Pageable的get/is方法生成了pageNumber、pageSize、offset、paged、unpaged、sort.sorted、sort.unsorted等参数，但实际上这些参数是无效的。

@ApiOperation(value = "Find airlines")
@GetMapping(value = "/airlines")
public Page<Airline> searchAirlines(Airline airline, Pageable pageable) {
    return repository.findAll(org.springframework.data.domain.Example.of(airline), pageable);
 }

Spring Boot解析Pageable参数的过程请查看org.springframework.data.web.PageableHandlerMethodArgumentResolver的resolveArgument()方法：

@Override
public Pageable resolveArgument(MethodParameter methodParameter, @Nullable ModelAndViewContainer mavContainer,
        NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) {

    assertPageableUniqueness(methodParameter);

    Optional<Pageable> defaultOrFallback = getDefaultFromAnnotationOrFallback(methodParameter).toOptional();

    String pageString = webRequest.getParameter(getParameterNameToUse(pageParameterName, methodParameter));
    String pageSizeString = webRequest.getParameter(getParameterNameToUse(sizeParameterName, methodParameter));

    Optional<Integer> page = parseAndApplyBoundaries(pageString, Integer.MAX_VALUE, true);
    Optional<Integer> pageSize = parseAndApplyBoundaries(pageSizeString, maxPageSize, false);

    if (!(page.isPresent() && pageSize.isPresent()) && !defaultOrFallback.isPresent()) {
        return Pageable.unpaged();
    }

    int p = page.orElseGet(() -> defaultOrFallback.map(Pageable::getPageNumber).orElseThrow(IllegalStateException::new));
    int ps = pageSize.orElseGet(() -> defaultOrFallback.map(Pageable::getPageSize).orElseThrow(IllegalStateException::new));

    // Limit lower bound
    ps = ps < 1 ? defaultOrFallback.map(Pageable::getPageSize).orElseThrow(IllegalStateException::new) : ps;
    // Limit upper bound
    ps = ps > maxPageSize ? maxPageSize : ps;

    Sort sort = sortResolver.resolveArgument(methodParameter, mavContainer, webRequest, binderFactory);

    return PageRequest.of(p, ps,