正文

轻松学会！Swagger2完美对接Spring Cloud Sleuth，实现服务追踪与监控

/0 浏览量
0602

在微服务架构中，服务追踪和监控是非常重要的功能，它可以帮助开发者和运维人员了解系统的健康状况，追踪请求在各个服务间的传播路径。Spring Cloud Sleuth 和 Swagger2 都是 Spring Cloud 微服务架构中的核心组件，前者专注于追踪，后者则是用来生成文档。将它们结合使用，可以实现更加完善的微服务追踪和监控体系。以下是一篇详细指南，带你轻松学会如何使用 Swagger2 完美对接 Spring Cloud Sleuth。

1. Spring Cloud Sleuth 简介

Spring Cloud Sleuth 是一个服务追踪工具，它可以自动生成跟踪数据，并通过 zipkin 或其他存储系统来存储和查询。通过 Sleuth，你可以在每个微服务之间添加跟踪信息，这样就能清晰地看到请求是如何从入口到出口，经过了哪些服务的。

2. Swagger2 简介

Swagger2 是一个基于 RESTful API 的平台，它提供了一系列强大的功能，如文档生成、交互式 API 等。使用 Swagger2 可以生成清晰的 API 文档，便于其他开发者和团队成员了解和使用你的服务。

3. 依赖引入

要在项目中引入 Swagger2 和 Spring Cloud Sleuth，你需要在 pom.xml 或 build.gradle 文件中添加以下依赖：

对于 Maven 项目：

<!-- Swagger 依赖 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- Spring Cloud Sleuth 依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
    <version>2.2.6.RELEASE</version>
</dependency>

对于 Gradle 项目：

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.9.2'
    implementation 'io.springfox:springfox-swagger-ui:2.9.2'
    implementation 'org.springframework.cloud:spring-cloud-starter-sleuth:2.2.6.RELEASE'
}

4. 配置 Spring Cloud Sleuth

在 application.properties 或 application.yml 文件中配置 Sleuth：

spring.sleuth.sampler.probability=1.0
spring.application.name=your-service-name

这里 spring.sleuth.sampler.probability 参数控制生成追踪数据的概率，1.0 表示每个请求都会生成追踪数据。

5. 配置 Swagger2

在 application.properties 或 application.yml 文件中配置 Swagger2：

# Swagger 配置
swagger:
  base-path: /api-docs
  enable: true
  # 其他配置...

6. 创建 Swagger 文档

创建一个 Swagger 配置类，用于生成 Swagger 文档：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

7. 添加 Swagger 2.0 的图标和版本

在你的 HTML 页面的 <head> 标签中添加以下内容，以便为 Swagger 文档添加图标和版本信息：

<link rel="stylesheet" href="https://unpkg.com/swagger-ui/dist/css/swagger-ui.css" />
<link rel="icon" type="image/x-icon" href="favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="favicon-16x16.png" sizes="16x16" />
<link rel="manifest" href="/manifest.json" />

8. 运行并测试

启动你的应用，并在浏览器中访问 http://localhost:8080/api-docs。你应该能看到生成的 Swagger 文档界面，包括 API 列表和交互式测试。

9. 结合使用

现在，你的 Spring Cloud 应用已经可以通过 Swagger2 生成文档，并且通过 Spring Cloud Sleuth 实现了服务追踪。你可以通过访问生成的 Swagger 文档，来测试你的服务，同时也能够在追踪系统中查看请求的传播路径。

通过以上步骤，你就可以轻松学会如何使用 Swagger2 完美对接 Spring Cloud Sleuth，实现服务追踪与监控了。记住，这是微服务架构中非常重要的一环，可以帮助你更好地管理和维护你的微服务系统。

-- 展开阅读全文 --