knife4j简单使用(三)

最新推荐文章于 2025-06-21 21:53:27 发布

盛夏光年hs

最新推荐文章于 2025-06-21 21:53:27 发布

阅读量2.9k

点赞数

CC 4.0 BY-SA版权

分类专栏： # Spring Boot

本文链接：https://blog.csdn.net/hs_shengxiaguangnian/article/details/110849121

Spring Boot 专栏收录该内容

28 篇文章

订阅专栏

本文档介绍了如何在Knife4j中配置多个模块下的Swagger包扫描，以实现API文档的正确整合。错误的做法是尝试使用通配符进行包扫描，而正确的解决方案是通过设置共同的父包来指定Controller扫描路径。通过创建一个自定义的Predicate函数，可以遍历并检查每个包是否匹配，从而实现多包扫描。这种方法要求在创建不同模块时保持包名的一致性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

knife4j配置多个扫描多个模块下的包

开始我的思路是使用通配符,就像配置mybatis的包扫描那样.结果好像不行,

错误的示范:

 @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTFul APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(basePackage(
                        "com.aluphy.**.controller"
//                        "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
                ))
                .apis(basePackage(
                        "com.aluphy"
//                        "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
                ))
//                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

主要看下边这块

	.apis(basePackage("com.aluphy.**.controller")

正确的做法:

使用多个controller共同拥有的父包,这就要求我们在创建不同的模块的时候,起包的名字的时候要求统一了

比如我有两个模块 material 和 user,他们的目录结构如下:

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-aMZMWY4v-1607364263287)(/Users/hushai/Library/Application Support/typora-user-images/image-20201208020044358.png)]

此时就可以配置为下边这样就可以了

package com.aluphy.config;

import com.google.common.base.Function;
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Knife4jConfiguration {
    // 定义分隔符,配置Swagger多包
    private static final String splitor = ";";
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //.title("swagger-bootstrap-ui-demo RESTful APIs")
                        .description("# swagger-bootstrap-ui-demo RESTFul APIs")
                        .termsOfServiceUrl("http://www.xx.com/")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                .apis(basePackage(
                        "com.aluphy"
//                        "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
                ))
                .apis(basePackage(
                        "com.aluphy"
//                        "com.aluphy.material.controller"+splitor+"com.aluphy.user.controller"
                ))
//                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

    public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
    }

    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage)     {
        return input -> {
            // 循环判断匹配
            for (String strPackage : basePackage.split(splitor)) {
                boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                if (isMatch) {
                    return true;
                }
            }
            return false;
        };
    }

    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
        return Optional.fromNullable(input.declaringClass());
    }
}