怎么在SpringBoot中使用Logback实现链路追踪功能?很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。
Spring Boot默认使用LogBack日志系统,并且已经引入了相关的jar包,所以我们无需任何配置便可以使用LogBack打印日志。
MDC(Mapped Diagnostic Context,映射调试上下文)是log4j和logback提供的一种方便在多线程条件下记录日志的功能。
实现思路是在一个请求开始时,将请求相关的上下文信息(例如客户ID、客户的IP地址、sessionId、请求参数等)添加到MDC,然后配置好logback-spring.xml,则Logback组件将会在每条日志中打印出存放到MDC的信息,从而实现一个ID贯穿用户的所有操作。
新建一个spring boot项目spring-boot-log,按照下面步骤操作。
新建日志拦截器
日志拦截器在请求开始获取用户的sessionId,当然也可以生成一个UUID,生成后存放到MDC中。
SessionInterceptor代码如下:
/** * 日志拦截器 * @Author: Java碎碎念 * */ public class SessionInterceptor extends HandlerInterceptorAdapter { /** * 会话ID */ private final static String SESSION_KEY = "sessionId"; @Override public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception { } @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // String token = UUID.randomUUID().toString().replaceAll("-",""); //本例测试使用sessionId,也可以使用UUID等 String token = request.getSession().getId(); MDC.put(SESSION_KEY, token); return true; } @Override public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3) throws Exception { // 删除 MDC.remove(SESSION_KEY); } }
新建配置类
新建InterceptorConfig,注册刚才的日志拦截器。
InterceptorConfig代码如下:
@Configuration public class InterceptorConfig implements WebMvcConfigurer { @Bean public SessionInterceptor getSessionInterceptor() { return new SessionInterceptor(); } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(getSessionInterceptor()).addPathPatterns("/*"); } }
修改logback-spring.xml
配置logback-spring.xml,获取日志拦截器添加的sessionId并打印到日志中,配置文件中获取方式如下:
%X{sessionId}
本例中打印sessionId到控制台和文件,完整配置如下:
<?xml version="1.0" encoding="UTF-8"?> <configuration> <property name="log.base" value="./log/logback"/> <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n </pattern> </encoder> </appender> <appender name="logfile" class="ch.qos.logback.core.rolling.RollingFileAppender"> <File>${log.base}.log</File> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <FileNamePattern>${log.base}.%d{yyyy -MM-dd}.log.zip</FileNamePattern> </rollingPolicy> <encoder> <pattern> %date [%thread] [%X{sessionId}] %-5level %logger{80} - %msg%n </pattern> </encoder> </appender> <logger name="com.sample" level="TRACE"/> <root> <level value="INFO"/> <appender-ref ref="stdout"/> <appender-ref ref="logfile"/> </root> </configuration>
添加controller
新建TestLogController,打印日志。
代码如下:
@RestController public class TestLogController { Logger log = LoggerFactory.getLogger(getClass()); /** * 测试登录 */ @RequestMapping(value = "/testLogin") public String testLogin() { log.info("用户登录成功!"); return "ok"; } /** * 测试下单 */ @RequestMapping(value = "/testNewOrder") public String testNewOrder() { log.info("用户创建了订单!"); log.info("请求完成,返回ok!"); return "ok"; } /** * 测试购买 */ @RequestMapping(value = "/testPay") public String testPay() { log.info("用户付款!"); return "ok"; } }
看完上述内容是否对您有帮助呢?如果还想对相关知识有进一步的了解或阅读更多相关文章,请关注亿速云行业资讯频道,感谢您对亿速云的支持。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。