springboot+cloud 學習（四）Zuul整合Swagger2

前言

在微服務架構下，服務是分散的，怎么把所有服務接口整合到一起是我們需要關注的。

下面舉例用zuul作為分布式系統的網關，同時使用swagger生成文檔，想把整個系統的文檔整合在同一個頁面上來說明。

項目結構

eureka-server：eureka服務注冊中心，端口8761,

eureka-server2：eureka服務注冊中心，端口8762, 

eureka-server3：eureka服務注冊中心，端口8763, 

zuul-swagger2：zuul網關，端口8090, 

management-device：外接設備系統，端口8083, 

management-equip：設備管理系統，端口8082, 

Zuul整合Swagger2

eureka注冊中心的搭建這里不再講述，直接來看zuul-swagger2項目里怎么集成swagger

pom.xml文件中引入依賴：

<!-- 必須要引入 springboot parent ，幫我們實現了很多jar包的依賴管理 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.2.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <dependencyManagement>
        <dependencies>
            <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Finchley.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- 版本集中配置 -->
    <properties>
        <swagger2.version>2.9.0</swagger2.version>
    </properties>


    <dependencies>
        <!-- eureka client -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!-- zuul -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>

        <!-- swagger2 依賴 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
    </dependencies>

在配置文件application.yml中添加配置（這里只做了eureka注冊，沒有做路由映射）：

#端口
server:
  port: 8090
#應用名稱
spring:
  application:
    name: zuul-swagger2
#服務注冊
eureka:
  instance:
    hostname: zuul-swagger2
  client:
    serviceUrl:
      defaultZone: http://skyworth:skyworth1@eureka-server:8761/eureka/,http://skyworth:skyworth2@eureka-server2:8762/eureka/,http://skyworth:skyworth3@eureka-server3:8763/eureka/
# 路由配置方式一
#zuul:
#  routes:
#所有請求management-equip的請求，都會被攔截，並且轉發到equip上
#    management-equip: /equip/** 

# 路由配置方式二
#zuul:
#  routes:
#    # 其中equip是路由名稱，可以隨便定義，但是path和service-id需要一一對應
#    equip: 
#      path: /equip/**
#      # management-equip為注冊到Eureka上的服務名
#      service-id: management-equip

Swagger2配置類：

這里比較重要的是2個配置類。第一個：SwaggerConfig.class是swagger的配置類，DocumentationConfig，用於整合配置接口文檔

SwaggerConfig.class

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket buildDocket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(buildApiInf()) // .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage(""))// 需要生成文檔的包的位置
        .paths(PathSelectors.any())
        .build();
    }

    private ApiInfo buildApiInf() {
    return new ApiInfoBuilder()
        .title("海外智能雲平台系統接口詳情")
        .description("Zuul+Swagger2構建RESTful APIs")
        .termsOfServiceUrl("http://www.skyworth.com")
        .contact(new Contact("skyworth", "http://www.skyworth.com", ""))
        .version("1.0")
        .build();
    }
}

DocumentationConfig.class(注意紅色部分，通過遍歷eureka路由方式自動添加所有微服務 API 文檔，SwaggerResourcesProvider 是資源提供者，我們重寫他，把各個微服務的API文檔資源路徑返回，注釋部分為手動添加的方式)

 

 

@Component
@Primary
public class DocumentationConfig implements SwaggerResourcesProvider {
    private final RouteLocator routeLocator;

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

    @Override
    public List<SwaggerResource> get() {
    List<SwaggerResource> resources = new ArrayList<>();
    List<Route> routes = routeLocator.getRoutes();
    routes.forEach(route -> {
        resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", "v2/api-docs"), "1.0"));
    });
    return resources;
    }
    
//    @Override
//        public List<SwaggerResource> get() {
//            List resources = new ArrayList<>();
//            resources.add(swaggerResource("外接設備系統", "/management-device/v2/api-docs", "1.0"));
//            resources.add(swaggerResource("設備管理系統", "/management-equip/v2/api-docs", "1.0"));
//            return resources;
//        }




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

最后是啟動類Application

@SpringBootApplication
@EnableZuulProxy
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

 運行相關服務和zuul-swagger網關，輸入：http://localhost:8090/swagger-ui.html

 

另外談談遇到的一個坑，之前沒有加eureka.instance.prefer-ip-address=true，導致zuul一直訪問不到其他服務（可能是eureka.instance.prefer-ip-address = true 就可以將IP注冊到Eureka Server上，而如果不配置就是機器的主機名，而主機名沒有做ip映射導致訪問不大，具體原因需要探究）。

#服務注冊
eureka:
  instance:
    hostname: device
    prefer-ip-address: true