knife4j基于Spring Cloud Gateway搭建demo

柔光的暖阳◎ 2022-12-22 13:26 179阅读 0赞

**目录**

1.参看地址(官网)

2.基本目录结构（官网）

3.我的demo 目录结构

4.service-server的配置(demo1)

4.1 pom.xml内容

4.2 application.yml 内容

4.3 启动类

5.service-user 的配置(demo2)

5.1 pom文件内容

5.2 application.yml 内容

5.3  SwaggerConfiguration.java

5.4 测试类  TestController.class

5.5启动类

6.service-doc 的配置（demo3）

6.1 pom.xml 文件内容

6.2 application.yml 内容

6.3  SwaggerHeaderFilter.java

6.4  SwaggerResourceConfig.java

6.5 SwaggerHandler.java

6.6 启动类

7.测试 按顺序启动 demo1，demo2，demo3

--------------------

## 1.参看地址(官网) ##

[https://doc.xiaominfo.com/solution/ui-front-gateway.html\#eureka%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83][https_doc.xiaominfo.com_solution_ui-front-gateway.html_eureka_E6_B3_A8_E5_86_8C_E4_B8_AD_E5_BF_83]

## 2.基本目录结构（官网） ##

|-----service-doc	//文档聚合中心,是所有微服务文档的出口
    |-----service-order //订单服务,包含所有与订单业务模块相关的接口
    |-----service-server //eureka 注册中心
    |-----service-user //用户服务,包含所有的用户接口

## 3.我的demo 目录结构 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70][]

##  4.service-server的配置(demo1) ##

### 4.1 pom.xml内容 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> 
      </parent>
      <groupId>com.example</groupId>
      <artifactId>myjson-spring-boot-starter</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <name>myjson-spring-boot-starter</name>
      <description>Demo project for Spring Boot</description>
    
      <properties>
        <java.version>11</java.version>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    
        <dependency>
          <groupId>com.alibaba</groupId>
          <artifactId>fastjson</artifactId>
          <version>1.2.21</version>
        </dependency>
    
        
        <dependency>
          <groupId>com.github.xiaoymin</groupId>
          <artifactId>knife4j-spring-boot-starter</artifactId>
          <version>2.0.1</version>
        </dependency>
    
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-tomcat</artifactId>
          
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-gateway-core</artifactId>
          <version>2.2.5.RELEASE</version>
          <scope>compile</scope>
        </dependency>
        <dependency>
          <groupId>org.springframework</groupId>
          <artifactId>spring-web</artifactId>
        </dependency>
        <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
        </dependency>
    
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
          <version>2.2.5.RELEASE</version>
        </dependency>
    
      </dependencies>
    
      <build>
        <plugins>
          <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
        </plugins>
      </build>
    
    </project>

### 4.2 application.yml 内容 ###

server:
      port: 10000
    eureka:
      instance:
        hostname: localhost
      client:
        register-with-eureka: false
        fetch-registry: false
        service-url:
          defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
    spring:
      application:
        name: knife4j-gateway-server

### 4.3 启动类 ###

package com.example.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
    
    @SpringBootApplication
    @EnableEurekaServer
    public class MyjsonSpringBootStarterApplication {
    
      public static void main (String[] args) {
        SpringApplication.run(MyjsonSpringBootStarterApplication.class, args);
      }
    
    }

## 5.service-user 的配置(demo2) ##

### 5.1 pom文件内容 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> 
      </parent>
      <groupId>com.example</groupId>
      <artifactId>demo</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <name>test-myjson-spring-boot-starter</name>
      <description>Demo project for Spring Boot</description>
    
      <properties>
        <java.version>1.8</java.version>
      </properties>
    
      <dependencies>
       
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
          <version>2.2.5.RELEASE</version>
          <exclusions>
    
            <exclusion>
              <artifactId>archaius-core</artifactId>
              <groupId>com.netflix.archaius</groupId>
            </exclusion>
            <exclusion>
              <artifactId>guava</artifactId>
              <groupId>com.google.guava</groupId>
            </exclusion>
          </exclusions>
        </dependency>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
        </dependency>
        <dependency>
    
          <groupId>com.github.xiaoymin</groupId>
          <artifactId>knife4j-micro-spring-boot-starter</artifactId>
          <version>2.0.4</version>
        </dependency>
    
      </dependencies>
    
      <build>
        <plugins>
          <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
        </plugins>
      </build>
    
    </project>

### 5.2 application.yml 内容 ###

server:
      port: 10001
    spring:
      application:
        name: service-user
    eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:10000/eureka/

### 5.3  SwaggerConfiguration.java ###

package com.example.demo.config;
    
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Import;
    import org.springframework.core.annotation.Order;
    import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
    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.EnableSwagger2;
    
    /**
     * @author hanzl
     * @date 2020/11/18 6:02 下午
     */
    @Configuration
    @EnableSwagger2
    @Import(BeanValidatorPluginsConfiguration.class)
    public class SwaggerConfiguration {
    
      @Bean(value = "userApi")
      @Order(value = 1)
      public Docket groupRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(groupApiInfo())
            .select()
            //.apis(RequestHandlerSelectors.basePackage("com.xiaominfo.swagger.service.user.controller"))
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) //修改自己的扫描包
            .paths(PathSelectors.any())
    
            .build();
      }
    
      private ApiInfo groupApiInfo(){
        return new ApiInfoBuilder()
            .title("swagger-bootstrap-ui很棒~~~！！！")
            .description("<div style='font-size:14px;color:red;'>swagger-bootstrap-ui-demo RESTful APIs</div>")
            .termsOfServiceUrl("http://www.group.com/")
            .contact("group@qq.com")
            .version("1.0")
            .build();
      }
    
    
    }

### 5.4 测试类  TestController.class ###

package com.example.demo.controller;
    
    import io.swagger.annotations.Api;
    import io.swagger.annotations.ApiOperation;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author hanzl
     * @date 2020/11/19 7:31 下午
     */
    @RestController("/user")
    public class TestController {
    
      @PostMapping("/abc")
      @ApiOperation(httpMethod = "POST",value = "ApiResult测试数组参数，多个")
      public void test(){
    
      }
    
    }

### 5.5启动类 ###

package com.example.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    
    @SpringBootApplication
    @EnableEurekaClient
    public class TestMyjsonSpringBootStarterApplication {
    
      public static void main (String[] args) {
        SpringApplication.run(TestMyjsonSpringBootStarterApplication.class, args);
      }
    
    }

## 6.service-doc 的配置（demo3） ##

### 6.1 pom.xml 文件内容 ###

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> 
      </parent>
      <groupId>com.example</groupId>
      <artifactId>demo</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <name>service-doc</name>
      <description>Demo project for Spring Boot</description>
    
      <properties>
        <java.version>1.8</java.version>
      </properties>
    
      <dependencies>
        
        
    
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
          <version>2.2.5.RELEASE</version>
        </dependency>
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
        </dependency>
        <dependency>
    
          <groupId>com.github.xiaoymin</groupId>
          <artifactId>knife4j-micro-spring-boot-starter</artifactId>
          <version>2.0.4</version>
          <exclusions>
            <exclusion>
              <artifactId>guava</artifactId>
              <groupId>com.google.guava</groupId>
            </exclusion>
          </exclusions>
        </dependency>
    
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-gateway-core</artifactId>
          <version>2.2.5.RELEASE</version>
          <scope>compile</scope>
        </dependency>
        <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-gateway</artifactId>
          <version>2.2.5.RELEASE</version>
        </dependency>
        <dependency>
          <groupId>org.projectlombok</groupId>
          <artifactId>lombok</artifactId>
        </dependency>
    
        <dependency>
          <groupId>com.github.xiaoymin</groupId>
          <artifactId>knife4j-spring-ui</artifactId>
          <version>2.0.4</version>
        </dependency>
      </dependencies>
    
      <build>
        <plugins>
          <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
          </plugin>
        </plugins>
      </build>
    
    </project>

### 6.2 application.yml 内容 ###

server:
      port: 10003
    spring:
      application:
        name: service-doc
      cloud:
        gateway:
          discovery:
            locator:
              #          enabled: true
              lowerCaseServiceId: true
          routes:
            - id: service-user
              uri: lb://service-user
              predicates:
                - Path=/user/**
              #            - Header=Cookie,Set-Cookie
              filters:
                - SwaggerHeaderFilter
                - StripPrefix=1
            - id:  service-order
              uri: lb://service-order
              predicates:
                - Path=/order/**
              filters:
                - SwaggerHeaderFilter
                - StripPrefix=1
    
    
    eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:10000/eureka/
    
    logging:
      level:
        org.springframework:cloud.gateway: debug

### 6.3  SwaggerHeaderFilter.java ###

package com.example.demo.config;
    import org.springframework.cloud.gateway.filter.GatewayFilter;
    import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
    import org.springframework.http.server.reactive.ServerHttpRequest;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    import org.springframework.web.server.ServerWebExchange;
    
    /**
     * @author hanzl
     * @date 2020/11/18 5:56 下午
     */
    @Component
    public class SwaggerHeaderFilter extends AbstractGatewayFilterFactory {
      private static final String HEADER_NAME = "X-Forwarded-Prefix";
      private static final String URI = "/v2/api-docs";
      @Override
      public GatewayFilter apply(Object config) {
        return (exchange, chain) -> {
          ServerHttpRequest request = exchange.getRequest();
          String path = request.getURI().getPath();
          if (!StringUtils.endsWithIgnoreCase(path,URI )) {
            return chain.filter(exchange);
          }
          String basePath = path.substring(0, path.lastIndexOf(URI));
          ServerHttpRequest newRequest = request.mutate().header(HEADER_NAME, basePath).build();
          ServerWebExchange newExchange = exchange.mutate().request(newRequest).build();
          return chain.filter(newExchange);
        };
      }
    }

### 6.4  SwaggerResourceConfig.java ###

package com.example.demo.config;
    import java.util.ArrayList;
    import java.util.List;
    
    import lombok.AllArgsConstructor;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.cloud.gateway.config.GatewayProperties;
    import org.springframework.cloud.gateway.route.RouteLocator;
    import org.springframework.cloud.gateway.support.NameUtils;
    import org.springframework.context.annotation.Primary;
    import org.springframework.stereotype.Component;
    import springfox.documentation.swagger.web.SwaggerResource;
    import springfox.documentation.swagger.web.SwaggerResourcesProvider;
    
    @Slf4j
    @Component
    @Primary
    @AllArgsConstructor
    public class SwaggerResourceConfig implements SwaggerResourcesProvider {
    
      private final RouteLocator routeLocator;
      private final GatewayProperties gatewayProperties;
    
    
      @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("**", "v2/api-docs"))));
        });
    
        return resources;
      }
    
      private SwaggerResource swaggerResource(String name, String location) {
        log.info("name:{},location:{}",name,location);
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion("2.0");
        return swaggerResource;
      }
    }

### 6.5 SwaggerHandler.java ###

package com.example.demo.controller;
    
    /**
     * @author hanzl
     * @date 2020/11/18 8:39 下午
     */
    
    import java.util.Optional;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    import reactor.core.publisher.Mono;
    import springfox.documentation.swagger.web.SecurityConfiguration;
    import springfox.documentation.swagger.web.SecurityConfigurationBuilder;
    import springfox.documentation.swagger.web.SwaggerResourcesProvider;
    import springfox.documentation.swagger.web.UiConfiguration;
    import springfox.documentation.swagger.web.UiConfigurationBuilder;
    @RestController
    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("/swagger-resources/configuration/security")
      public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
        return Mono.just(new ResponseEntity<>(
            Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
      }
    
      @GetMapping("/swagger-resources/configuration/ui")
      public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
        return Mono.just(new ResponseEntity<>(
            Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
      }
    
      @GetMapping("/swagger-resources")
      public Mono<ResponseEntity> swaggerResources() {
        return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
      }
    }

### 6.6 启动类 ###

package com.example.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
    import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
    @EnableDiscoveryClient
    @EnableEurekaClient
    @SpringBootApplication
    public class DemoApplication {
    
      public static void main (String[] args) {
        SpringApplication.run(DemoApplication.class, args);
      }
    
    }

## 7.测试 按顺序启动 demo1，demo2，demo3 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 1][]

访问地址 [http://localhost:10003/doc.html][http_localhost_10003_doc.html]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 3][]

[https_doc.xiaominfo.com_solution_ui-front-gateway.html_eureka_E6_B3_A8_E5_86_8C_E4_B8_AD_E5_BF_83]: https://doc.xiaominfo.com/solution/ui-front-gateway.html#eureka%E6%B3%A8%E5%86%8C%E4%B8%AD%E5%BF%83
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70]: /images/20221120/370bfdf92fc147538a19885e1f6ca48e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 1]: /images/20221120/7b776fbbdd244c4b96bd0384348b51a0.png
[http_localhost_10003_doc.html]: http://localhost:10003/doc.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 2]: /images/20221120/d9f2e136e6504faca74317af7b9d50e1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2hhbnpsMQ_size_16_color_FFFFFF_t_70 3]: /images/20221120/1a5f2b91ec5e428c8a9e28e6012a5b96.png