Gateway集成knife4j多模块分组踩坑

Gateway集成knife4j多模块分组踩坑

学习、踩坑、不断前进，记录一下

pom.xml

其他子模块

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    <version>2.0.9</version>
</dependency>
<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>29.0-jre</version>
    <optional>true</optional>
</dependency>

Gateway模块

 <dependency>
     <groupId>com.github.xiaoymin</groupId>
     <artifactId>knife4j-spring-boot-starter</artifactId>
     <version>2.0.9</version>
</dependency>

swagger配置

配置分组

通用工具模块配置

package com.xxx.common.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

/**
 * @Author fxx
 * @Date 2021/7/21 8:44
 */
@Configuration
@EnableKnife4j
@EnableSwagger2WebMvc
public class Swagger2Config {

    //默认的api，这里有个坑，就是groupName("default")这里配的default是默认的分组名，
    //Swagger2ControllerWebMvc的getDocumentation方法，也就是/v2/api-docs接口需要加参数group和分组名，不然的话就是查的default分组
    //而默认访问doc.html的时候，发送的/v2/api-docs是不带group参数的
    //源码如下：
    /**public ResponseEntity<Json> getDocumentation(@RequestParam(value = "group",required = false) String swaggerGroup, 		HttpServletRequest servletRequest) {
        *String groupName = (String)Optional.ofNullable(swaggerGroup).orElse("default");
        *Documentation documentation = this.documentationCache.documentationByGroup(groupName);
        **/
    
    
//    @Bean(value = "defaultApi")
//    public Docket defaultApi() {
//        return new Docket(DocumentationType.SWAGGER_2)
//                .groupName("default")
//                .apiInfo(apiInfo())
//                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.ndss.admin"))
//                .paths(PathSelectors.any())
//                .build();
//    }

    //下面可以配置多个分组，一个bean就是一个分组模块
    @Bean(value = "xxxApi")
    public Docket adminApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("xxx_admin")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.admin"))
                .paths(PathSelectors.any())
                .build();
    }

    @Bean(value = "mmmApi")
    public Docket authApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .enable(true)
                .groupName("xxx_auth")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.auth"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx")
                .description("yyy")
                .termsOfServiceUrl("http://localhost:8080/")
                .version("1.0")
                .build();
    }
}

gateway模块配置

spring:
  cloud:
    gateway:
      discovery:        #开启动态路由配置
        locator:
          enabled: true
      routes:
        - id: xxx_payment           #路由的ID，没有固定规则但要求唯一，建议配合服务名
          #          uri: http://localhost:8001  #匹配后提供服务的路由地址
          uri: lb://xxx-payment #匹配后提供服务的路由地址
          predicates:                 #匹配后提供服务的路由地址
            - Path=/payment/**    # 断言，路径相匹配的进行路由
          filters:
            #            去掉/payment
            - StripPrefix=1

@RestController
@RequestMapping("/swagger-resources")
public class SwaggerHandler {

    @Autowired(required = false)
    private SecurityConfiguration securityConfiguration;

    @Autowired(required = false)
    private UiConfiguration uiConfiguration;

    private final SwaggerResourcesProvider swaggerResources;

    @Autowired
    public SwaggerHandler(SwaggerResourcesProvider swaggerResources) {
        this.swaggerResources = swaggerResources;
    }

    @GetMapping("/configuration/security")
    public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));

    }

    @GetMapping("/configuration/ui")
    public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
        return Mono.just(new ResponseEntity<>(
                Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
    }

    @GetMapping("")
    public Mono<ResponseEntity> swaggerResources() {
        Mono<ResponseEntity> just = Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
        return just;
    }
}

@Configuration
@Primary  //代表是Swagger主 配置
public class DocumentationConfig implements SwaggerResourcesProvider {

    public static final String API_URI = "v2/api-docs";
    private final RouteLocator routeLocator;
    private final GatewayProperties gatewayProperties;

    public DocumentationConfig(RouteLocator routeLocator, GatewayProperties gatewayProperties) {
        this.routeLocator = routeLocator;
        this.gatewayProperties = gatewayProperties;
    }

    //注意，这个方法，.replace("**", API_URI + "?group=" + route.getId())这一句是找到我们在gateway配置的路由信息，然后将每个路由的"**"替换成
    //v2/api-docs + 参数group分组信息，我这里的分组用的是配置路由时候用的id，route.getId()，"**"也可以改成自己需要的样子
    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<String> routes = new ArrayList<>();
        routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
        gatewayProperties.getRoutes().stream().filter(routeDefinition -> routes.contains(routeDefinition.getId())).forEach(route -> {
            route.getPredicates().stream()
                    .filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
                    .forEach(predicateDefinition -> resources.add(swaggerResource(route.getId(),
                            predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0")
                                    .replace("**", API_URI + "?group=" + route.getId()))));
        });
        return resources;
    }

    private SwaggerResource swaggerResource(String name, String location) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion("1.0");
        return swaggerResource;
    }
}

这一步完成之后已经实现了分组了，但是如果配置了springsecurity的话还需要放行一些静态资源

springsecurity配置

@Override
protected void configure(HttpSecurity http) throws Exception {
    http
        .authorizeRequests()
        .antMatchers("/login/**",
                     "/doc.html/**",
                     "/webjars/**",
                     "/swagger-ui.html",
                     "/v2/**",
                     "/swagger-resources",
                     "/swagger-resources/**",
                     "/favicon.ico").permitAll()
        .anyRequest().authenticated()
        .and().cors() //允许跨域
        .and()
        .csrf().disable();
}

最后可能还存在的一个问题就是：访问doc.html的时候，404了

官方给的解法是：

public class AppApplication implements WebMvcConfigurer {
    public static void main(String[] args) {
        SpringApplication.run(AuthApplication.class, args);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");

        /** 配置knife4j 显示文档 */
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath*:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath*:/META-INF/resources/webjars/");
    }
}

但是，配置了这个资源映射器之后，我还是报404了，找了好久也没找到原因，所以干脆找到knife4j的ui包，然后把整个META-INF文件夹复制到我自己模块下的classpath下了

然后修改了资源映射器配置：

public class AuthApplication implements WebMvcConfigurer {
    public static void main(String[] args) {
        SpringApplication.run(AuthApplication.class, args);
    }

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        /** 配置knife4j 显示文档 */
        registry.addResourceHandler("doc.html")
                .addResourceLocations("classpath:/META-INF/resources/");
    }
}

复制之后的样子：

然后就好使了，只要用网关端口访问，就可以换成多个分组了