SpringCloud_Sleuth分布式链路请求跟踪的示例代码

下面是关于“SpringCloud_Sleuth分布式链路请求跟踪的示例代码”的攻略。

什么是SpringCloud_Sleuth？

SpringCloud_Sleuth是SpringCloud的一个组件，主要是用来实现分布式链路请求跟踪的。它基于Dapper的思想，通过为每个请求生成唯一的trace id和span id，来实现分布式系统中的链路跟踪。同时，它也提供了一些有用的工具，比如Zipkin，来实现链路跟踪数据的可视化和分析。

SpringCloud_Sleuth的使用

引入依赖

在使用SpringCloud_Sleuth之前，需要在pom.xml文件中引入相应的依赖。具体依赖如下：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
    <version>2.2.5.RELEASE</version>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-zipkin</artifactId>
    <version>2.2.5.RELEASE</version>
</dependency>

配置启动类

在启动类中可以通过设置@EnableSleuth和@EnableZipkinServer注解，来启用SpringCloud_Sleuth和Zipkin的功能。具体代码如下：

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

配置application.yml

在application.yml文件中，需要配置一些信息，包括应用名称（spring.application.name）、Zipkin服务器的地址（spring.zipkin.base-url）、采样率（spring.sleuth.sampler.probability）等。具体配置如下：

spring:
  application:
    name: sleuth-demo
  zipkin:
    base-url: http://localhost:9411/
  sleuth:
    sampler:
      probability: 1

示例说明

下面给出两个示例说明。

示例1：单体应用

在单体应用中，我们可以使用SpringMVC来模拟一个简单的接口，并通过RestTemplate来模拟接口之间的调用关系。

@RestController
@RequestMapping
@Slf4j
public class DemoController {

    private final RestTemplate restTemplate;

    public DemoController(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    @GetMapping("/hello")
    public String hello() {
        log.info("处理/hello请求");
        String result = restTemplate.getForObject("http://localhost:8080/hello2", String.class);
        log.info("请求/hello2返回结果：{}", result);
        return "hello";
    }

    @GetMapping("/hello2")
    public String hello2() {
        log.info("处理/hello2请求");
        return "hello2";
    }
}

通过上述代码，我们可以看到，在/hello接口中，我们调用了/hello2接口，并在日志中输出了请求/hello2的结果。此时，我们启动应用，并在浏览器中访问http://localhost:8080/hello的时候，可以看到在控制台中输出了以下日志信息：

2022-02-16 14:30:22.135  INFO [sleuth-demo,ef8f1de84c80d771,ef8f1de84c80d771,false] 2825 --- [nio-8080-exec-1] demo.controller.DemoController          : 处理/hello请求
2022-02-16 14:30:22.205  INFO [sleuth-demo,ef8f1de84c80d771,5f6b790a19bd4d8b,false] 2825 --- [nio-8080-exec-1] demo.controller.DemoController          : 处理/hello2请求
2022-02-16 14:30:22.209  INFO [sleuth-demo,ef8f1de84c80d771,5f6b790a19bd4d8b,false] 2825 --- [nio-8080-exec-1] demo.controller.DemoController          : 请求/hello2返回结果：hello2

从日志中可以看到，每个请求都有一个独特的trace id和span id，同时，我们在请求/hello2接口的时候，也能够看到对应的日志信息。

示例2：微服务应用

在微服务应用中，我们可以使用SpringCloud进行构建。下面是一个简单的示例：

@SpringBootApplication
@EnableDiscoveryClient
public class ProducerApplication {

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

    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
}

@RestController
@RequestMapping
@Slf4j
public class ProducerController {

    private final RestTemplate restTemplate;

    public ProducerController(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    @GetMapping("/hello")
    public String hello() {
        log.info("处理/hello请求");
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        HttpEntity<String> entity = new HttpEntity<>(null, headers);
        String result = restTemplate.exchange("http://consumer/hello2", HttpMethod.GET, entity, String.class).getBody();
        log.info("请求/hello2返回结果：{}", result);
        return "hello";
    }
}

@SpringBootApplication
@EnableDiscoveryClient
public class ConsumerApplication {

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

}

@RestController
@RequestMapping
@Slf4j
public class ConsumerController {

    @GetMapping("/hello2")
    public String hello2() {
        log.info("处理/hello2请求");
        return "hello2";
    }
}

在上述示例中，我们创建了一个名为producer的服务，它的/hello接口会调用名为consumer的服务的/hello2接口。在启动服务之前，我们需要启动Zipkin服务器。然后，启动producer和consumer服务，并在浏览器中访问http://localhost:8081/hello，此时，我们可以在Zipkin的web界面中看到分布式的链路跟踪信息。

总结

通过这篇攻略，我们了解了SpringCloud_Sleuth的基本用法，以及应用在单体应用和微服务应用中的示例。同时，我们也把握了如何启用Zipkin服务器，来实现分布式链路请求跟踪的功能。