Springboot接口日志加入鏈路追蹤traceId方式

更新時間：2025年08月15日 09:38:17 作者：Geek-SX

文章介紹通過添加依賴、配置logback-spring.xml、使用@LogTrace注解和LogTraceAspect切面實現(xiàn)請求日志追蹤,測試時日志中可顯示traceId

Springboot接口日志加入鏈路追蹤traceId

1.注解 LogTrace

package com.bt.springboot.common.annotation;

import java.lang.annotation.*;

/**
 * 鏈路追蹤
 *
 * @author
 */
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogTrace {
}

2.切面 LogTraceAspect

package com.bt.springboot.common.aspect;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;

import java.util.UUID;

/**
 * 鏈路追蹤
 *
 * @author
 */
@Aspect
@Component
@Slf4j
public class LogTraceAspect {

    /**
	 * 與 logback-spring.xml 中的變量一致
     */
    private static final String TRACE_ID = "traceId";

    /**
     * 定義切點 切點為
     */
    @Pointcut("@within(com.bt.springboot.common.annotation.LogTrace)")
    public void printLog(){
    }

    /**
     * 環(huán)繞通知
     */
    @Around(value = "printLog()")
    public Object webLogAround(ProceedingJoinPoint joinPoint) throws Throwable {
        // 方法執(zhí)行前加上鏈路號
        String traceId = UUID.randomUUID().toString().replaceAll("-", "");
        MDC.put(TRACE_ID, traceId);
        Object proceed = joinPoint.proceed();
        MDC.remove(TRACE_ID);
        return proceed;
    }
}

3.添加依賴

<!-- 鏈路追蹤 -->
        <dependency>
            <groupId>org.apache.skywalking</groupId>
            <artifactId>apm-toolkit-logback-1.x</artifactId>
            <version>8.0.1</version>
        </dependency>

4.修改logback-spring.xml

<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--
         <encoder>：對日志進行格式化。
         <target>：字符串System.out(默認)或者System.err
         -->
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.mdc.TraceIdMDCPatternLogbackLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{traceId}] [%-5level] %logger{50} - %msg%n</pattern>
            </layout>
        </encoder>
    </appender>

5.測試在類或方法上加上注解@LogTrace

package com.bt.springboot.web.controller;

import com.bt.springboot.common.annotation.LogTrace;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.List;

/**
 * @author zkx
 * @Date 2022/4/8 11:36
 */
@LogTrace
@Slf4j
@RestController
public class TestController {

	@GetMapping("/test")
	public void test(){
		log.info("info");
	}
}