SpringBoot实现简单的日志链路追踪

更新时间：2023年10月10日 11:49:56 作者：Ethan

随着分布式应用的普及,现在的一些应用系统不再像以前,所有的文件（前后端程序）都打包在一个包中,本文通过一个简单的SpringBoot应用来总结,我们如何将日志串联起来,文中有详细的代码示例,需要的朋友可以参考下

一. 背景

随着分布式应用的普及，现在的一些应用系统不再像以前，所有的文件（前后端程序）都打包在一个包中，现在的很多应用都是模块化开发，开发的团队也是不一样，服务与服务之间的调用也比较多，在这种情况下，系统的日志就显得尤其的重要，然而，在多数情况下，当我们的系统出现了异常，需要查看日志时，就会很抓狂。为了避免这种情况，我们需要把同一次的业务调用链上的日志串联起来。

本次通过一个简单的SpringBoot应用来总结，我们如何将日志串联起来，以下截图是最终的实现效果

二. 代码演示

1. 创建一个SpringBoot项目

使用idea创建一个SpringBoot项目的详细步骤，本文不介绍了，具体的步骤，网上有很多例子可以参考

1.1. 我的SpringBoot项目名称是：springboot-track，以下是工程pom.xml文件中所需要的必要依赖

<dependencies>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-web</artifactId>
 ?</dependency>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-logging</artifactId>
 ?</dependency>
?
 ?<dependency>
 ? ?<groupId>org.projectlombok</groupId>
 ? ?<artifactId>lombok</artifactId>
 ? ?<optional>true</optional>
 ?</dependency>
 ?<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-starter-test</artifactId>
 ? ?<scope>test</scope>
 ?</dependency>
</dependencies>

1.2. 在项目的resource目录下，创建日志框架整合配置文件：logback-spring.xml文件内容配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
 ?<!--日志存储路径-->
 ?<property name="log" value="/Users/username/Downloads"/>
 ?<!-- 控制台输出 -->
 ?<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
 ? ?<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
 ? ? ?<!--输出格式化-->
 ? ? ?<pattern>[%X{TRACE_ID}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
 ? ?</encoder>
 ?</appender>
 ?<!-- 按天生成日志文件 -->
 ?<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
 ? ?<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
 ? ? ?<!--日志文件名-->
 ? ? ?<FileNamePattern>${log}/%d{yyyy-MM-dd}.log</FileNamePattern>
 ? ? ?<!--保留天数-->
 ? ? ?<MaxHistory>30</MaxHistory>
 ? ?</rollingPolicy>
 ? ?<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
 ? ? ?<pattern>[%X{TRACE_ID}] %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
 ? ?</encoder>
 ? ?<!--日志文件最大的大小-->
 ? ?<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
 ? ? ?<MaxFileSize>10MB</MaxFileSize>
 ? ?</triggeringPolicy>
 ?</appender>
?
 ?<!-- 日志输出级别 -->
 ?<root level="INFO">
 ? ?<appender-ref ref="console"/>
 ? ?<appender-ref ref="file"/>
 ?</root>
</configuration>

1.3. 在项目的resource目录下的主配置文件(application.yml)中添加日志整合配置信息，添加内容如下：

需要注意的是：使用idea创建的SpringBoot项目，application文件的默认后缀是.properties，本人比较喜欢.yml文件，所以将文件后缀名修改了一下

server:
  port: 8080
logging:
  config: classpath:logback-springboot.xml
  pattern:
 ?  dateformat: MM-dd HH:mm:ss

1.4. 自定义日志拦截器：LogInterceptor.java

public class LogInterceptor implements HandlerInterceptor {
?
 ?private static final String TRACE_ID = "TRACE_ID";
?
 ?@Override
 ?public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 ? ?// 使用UUID自动生成链路ID
 ? ?String tid = UUID.randomUUID().toString().replace("-", "");
 ? ?// 客户端可以传入链路ID，需要唯一性
 ? ?String traceId = request.getHeader(TRACE_ID);
 ? ?if (!StringUtils.isEmpty(traceId)) {
 ? ? ?tid = request.getHeader(TRACE_ID);
 ?  }
 ? ?// MDC(Mapped Diagnostic Context)诊断上下文映射，是@Slf4j提供的一个支持动态打印日志信息的工具
 ? ?MDC.put(TRACE_ID, tid);
 ? ?return true;
  }
?
 ?@Override
 ?public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 ? ?MDC.remove(TRACE_ID);
  }
}

自定义的拦截器需要实现HandlerInterceptor.java接口，然后重写preHandle方法；MDC(Mapped Diagnostic Context)诊断上下文映射，@Slf4j提供的动态打印日志工具。

1.5. 添加拦截器：WebConfigurerAdapter.java

@Configuration
public class WebConfigurerAdapter implements WebMvcConfigurer {
?
 ?@Bean
 ?public LogInterceptor logInterceptor() {
 ? ?return new LogInterceptor();
  }
?
 ?@Override
 ?public void addInterceptors(InterceptorRegistry registry) {
 ? ?registry.addInterceptor(logInterceptor())
 ? ? ?// 自定义需要拦截的和不需要拦截的
 ? ?  .addPathPatterns("/**")
 ? ?  .excludePathPatterns("/test***.html");
?
  }
}

经过上述的几个步骤，基本上就可以简单的将同一次的业务调用链上的日志串联起来了。

2. 测试验证

简单的写一个测试类：TestController.java

@RestController
@Slf4j
public class TestController {
?
 ?@Resource(name = "userService")
 ?private IUserService userService;
?
 ?@PostMapping("/test")
 ?public String testTrace01(@RequestParam("name") final String name) {
 ? ?log.info("入参 name={}", name);
 ? ?testTrace02();
 ? ?log.info("调用结束name={}", name);
 ? ?return "Hello," + name;
  }
}

使用Postman调用接口：http://localhost:8080/test?name=张三

控制台的输出如下：

至此，一个最简单的日志串联就做好了

到此这篇关于SpringBoot实现简单的日志链路追踪的文章就介绍到这了,更多相关SpringBoot日志链路追踪内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

minio安装部署及使用的详细过程
MinIO是一个基于Apache License v2.0开源协议的对象存储服务,下面这篇文章主要给大家介绍了关于minio安装部署及使用的详细过程,文中通过实例代码以及图文介绍的非常详细,需要的朋友可以参考下
2022-09-09
Spring整合JUnit详解
Spring 是目前主流的 Java Web 开发框架，是 Java 世界最为成功的框架。该框架是一个轻量级的开源框架，这篇文章主要介绍如何配置数据源、注解开发以及整合Junit，感兴趣的同学可以参考一下
2023-04-04
Servlet简单实现登录功能
这篇文章主要为大家详细介绍了Servlet简单实现登录功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-03-03
使用Java实现通用树形结构构建工具类
这篇文章主要为大家详细介绍了如何使用Java实现通用树形结构构建工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
2025-03-03
基于获取JAVA路径,包括CLASSPATH外的路径的方法详解
本篇文章是对获取JAVA路径,包括CLASSPATH外的路径的方法进行了详细的分析介绍，需要的朋友参考下
2013-05-05
解决Spring Cloud中Feign/Ribbon第一次请求失败的方法
这篇文章主要给大家介绍了关于解决Spring Cloud中Feign/Ribbon第一次请求失败的方法，文中给出了三种解决的方法，大家可以根据需要选择对应的方法，需要的朋友们下面来一起看看吧。
2017-02-02
Java实现浪漫流星表白的示例代码
本文将利用Java语言实现浪漫流星表白，可以实现这些功能：播放音乐、自定义流星数量、飞行速度、光晕大小、流星大小，自定义表白话语，感兴趣的可以学习一下
2022-05-05
一招教你使用Java执行groovy脚本的两种方式
本文主要介绍了一招教你使用Java执行groovy脚本的两种方式,一种是通过脚本引擎ScriptEngine提供的eval(String)方法执行脚本内容,一种是执行groovy脚本,感兴趣的可以了解一下
2023-09-09
Springcloud中的Nacos Config服务配置流程分析
这篇文章主要介绍了Springcloud中的Nacos Config服务配置,本文以用户微服务为例，进行统一的配置，结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
2022-09-09
SpringSecurity实现访问控制url匹配
本文主要介绍了SpringSecurity实现访问控制url匹配，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08