Springboot+MDC+traceId日志中打印唯一traceId

先看一张图：

有同学问：日志中[]中类似uuid的这个traceid是怎么实现的，这边文章就介绍下如何在springboot工程下用mdc实现日志文件中打印traceid。

1. 为什么需要这个traceid

我们在定位问题的时候需要去日志中查找对应的位置，当我们一个接口的请求同用唯一的一个traceid，那我们只需要知道这个traceid，使用 grep ‘traceid' xxx.log 语句就能准确的定位到目标日志。在这边文章会介绍如何去设置这个traceid，而后如何在接口返回这个traceid。

#接口返回：
{
    "code": "0",
    "dealstatus": "1",
    "trace_id": "a10e6e8d-9953-4de9-b145-32eee6aa5562"
}
#查询日志
 grep 'a10e6e8d-9953-4de9-b145-32eee6aa5562' xxxx.log

2.通过mdc设置traceid

笔者目前遇到的项目，可以有三种情况去设置traceid。先简单的介绍mdc

 #mdc定义
 mapped diagnostic context，即：映射诊断环境。
 mdc是 log4j 和 logback 提供的一种方便在多线程条件下记录日志的功能。
 mdc 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。
 #mdc的使用方法
 向mdc中设置值：mdc.put(key, value);
 从mdc中取值：mdc.get(key);
 将mdc中内容打印到日志中：%x{key}

2.1 使用filter过滤器设置traceid

新建一个过滤器，实现filter，重写init，dofilter，destroy方法，设置traceid放在dofilter中，在destroy中调用mdc.clear()方法。

@slf4j
@webfilter(filtername = "traceidfilter",urlpatterns = "/*")
public class traceidfilter implements filter {

	/**
     * 日志跟踪标识
     */
    private static final string trace_id = "trace_id";
    
    @override
    public void init(filterconfig filterconfig) throws servletexception {
    }

    @override
    public void dofilter(servletrequest servletrequest, servletresponse servletresponse, filterchain filterchain)
            throws ioexception, servletexception {
        mdc.put(trace_id, uuid.randomuuid().tostring());
        filterchain.dofilter(request, servletresponse);
    }

    @override
    public void destroy() {
    	mdc.clear();
    }
}

2.2 使用jwt token过滤器的项目

springboot项目经常使用spring security+jwt来做权限限制，在这种情况下，我们通过新建filter过滤器来设置traceid，那么在验证token这部分的日志就不会带上traceid，因此我们需要把代码放在jwtfilter中，如图：

/**
 * token过滤器 验证token有效性
 *
 * @author china
 */
@component
public class jwtauthenticationtokenfilter extends onceperrequestfilter {
    @autowired
    private tokenservice tokenservice;

    /**
     * 日志跟踪标识
     */
    private static final string trace_id = "trace_id";

    @override
    protected void dofilterinternal(httpservletrequest request, httpservletresponse response, filterchain chain)
            throws servletexception, ioexception {
        mdc.put(trace_id, uuid.randomuuid().tostring());
        loginuser loginuser = tokenservice.getloginuser(request);
        if (stringutils.isnotnull(loginuser) && stringutils.isnull(securityutils.getauthentication())) {
            tokenservice.verifytoken(loginuser);
            usernamepasswordauthenticationtoken authenticationtoken = new usernamepasswordauthenticationtoken(loginuser, null, loginuser.getauthorities());
            authenticationtoken.setdetails(new webauthenticationdetailssource().builddetails(request));
            securitycontextholder.getcontext().setauthentication(authenticationtoken);
        }
        chain.dofilter(request, response);
    }
    
    @override
    public void destroy() {
        mdc.clear();
    }
}

2.3 使用interceptor拦截器设置traceid

定义一个拦截器，重写prehandle方法，在方法中通过mdc设置traceid

/**
 * mdc设置traceid拦截器
 *
 * @author china
 */
@component
public abstract class traceidinterceptor extends handlerinterceptoradapter {
    private static final string unique_id = "trace_id";

    @override
    public boolean prehandle(httpservletrequest request, httpservletresponse response, object handler) {
        mdc.put(unique_id, uuid.randomuuid().tostring());
        return true;
    }

	@override
    public void aftercompletion(httpservletrequest request, httpservletresponse response, object handler, @nullable exception ex) throws exception {
        mdc.clear();
    }
}

3.logback.xml中配置traceid

与之前的相比只是添加了[%x{trace_id}]， [%x{***}]是一个模板，中间属性名是我们使用mdc put进去的。

#之前
<property name="log.pattern" value="%d{yyyy-mm-dd hh:mm:ss.sss} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />
#增加traceid后
<property name="log.pattern" value="%d{yyyy-mm-dd hh:mm:ss.sss} [%thread] %-5level %logger{20} - [%method,%line] - [%x{trace_id}] - %msg%n" />

4.补充异步方法带入上下文的traceid

异步方法会开启一个新线程，我们想要是异步方法和主线程共用同一个traceid，首先先新建一个任务适配器mdctaskdecorator，如图：

public class mdctaskdecorator implements taskdecorator 
    /**
     * 使异步线程池获得主线程的上下文
     * @param runnable
     * @return
     */
    @override
    public runnable decorate(runnable runnable) {
        map<string,string> map = mdc.getcopyofcontextmap();
        return () -> {
            try{
                mdc.setcontextmap(map);
                runnable.run();
            } finally {
                mdc.clear();
            }
        };
    }
}

然后，在线程池配置中增加executor.settaskdecorator(new mdctaskdecorator())的设置

 /**
 * 线程池配置
 *
 * @author china
 **/
@enableasync
@configuration
public class threadpoolconfig {
    private int corepoolsize = 50;
    private int maxpoolsize = 200;
    private int queuecapacity = 1000;
    private int keepaliveseconds = 300;

    @bean(name = "threadpooltaskexecutor")
    public threadpooltaskexecutor threadpooltaskexecutor() {
        threadpooltaskexecutor executor = new threadpooltaskexecutor();
        executor.setmaxpoolsize(maxpoolsize);
        executor.setcorepoolsize(corepoolsize);
        executor.setqueuecapacity(queuecapacity);
        executor.setkeepaliveseconds(keepaliveseconds);
        executor.settaskdecorator(new mdctaskdecorator());
        // 线程池对拒绝任务(无线程可用)的处理策略
        executor.setrejectedexecutionhandler(new threadpoolexecutor.callerrunspolicy());
        return executor;
    }
}

最后，在业务代码上使用@async开启异步方法即可

    @async("threadpooltaskexecutor")
    void testsyncmethod();

5.在接口放回中，增加traceid返回

在笔者项目中，接口返回都使用了一个叫ajaxresult自定义类来包装，所以只需要把这个类的构造器中增加traceid返回即可，相对简单。

   /**
     * 日志跟踪标识
     */
    private static final string trace_id = "trace_id";
    
    /**
     * 初始化一个新创建的 ajaxresult 对象，使其表示一个空消息。
     */
    public ajaxresult() {
        super.put(trace_id, mdc.get(trace_id));
    }

    /**
     * 初始化一个新创建的 ajaxresult 对象
     *
     * @param code 状态码
     * @param msg  返回内容
     */
    public ajaxresult(int code, string msg) {
        super.put(code_tag, code);
        super.put(msg_tag, msg);
        super.put(trace_id, mdc.get(trace_id));
    }

    /**
     * 初始化一个新创建的 ajaxresult 对象
     *
     * @param code 状态码
     * @param msg  返回内容
     * @param data 数据对象
     */
    public ajaxresult(int code, string msg, object data) {
        super.put(code_tag, code);
        super.put(msg_tag, msg);
        super.put(trace_id, mdc.get(trace_id));
        if (stringutils.isnotnull(data)) {
            super.put(data_tag, data);
        }
    }

以上就是springboot+mdc+traceid日志中打印唯一traceid的详细内容，更多关于springboot 打印唯一traceid的资料请关注其它相关文章！