sviolet.thistle.x.util.trace.DefaultTraceProvider Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015-2019 S.Violet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Project GitHub: https://github.com/shepherdviolet/thistle
 * Email: [email protected]
 */

package sviolet.thistle.x.util.trace;

import sviolet.thistle.util.judge.CheckUtils;

import java.util.HashMap;
import java.util.Map;
import java.util.UUID;

/**
 * 全局追踪默认实现
 *
 * 
 *     1.追踪号和其他追踪信息保存在ThreadLocal中. 

 *     2.如果应用依赖SLF4J, 追踪号还会存入MDC, KEY为{@value Trace#TRACE_ID_KEY}, 可以打印在日志中. 

 * 
 *
 * @author zhuqinchao
 */
public class DefaultTraceProvider implements TraceProvider {

    private static final TraceIdProvider TRACE_ID_PROVIDER;

    static {
        TraceIdProvider traceIdProvider;
        try {
            //尝试用SLF4J存追踪号
            Class.forName("org.slf4j.Logger");
            traceIdProvider = (TraceIdProvider) Class.forName("sviolet.thistle.x.util.trace.Slf4jTraceIdProvider").newInstance();
        } catch (Exception e) {
            traceIdProvider = new LocalTraceIdProvider();
        }
        TRACE_ID_PROVIDER = traceIdProvider;
    }

    private ThreadLocal> traceData = new ThreadLocal<>();

    @Override
    public void start() {
        handoff(null, null);
    }

    @Override
    public void start(String customTraceId) {
        handoff(customTraceId, null);
    }

    @Override
    public void handoff(String traceId, Map data) {
        //generate id if not exists
        if (CheckUtils.isEmpty(traceId)) {
            traceId = UUID.randomUUID().toString().replaceAll("-", "");
        }
        //put id into MDC
        TRACE_ID_PROVIDER.set(traceId);
        //put data into thread local
        traceData.set(data);
    }

    @Override
    public String getTraceId() {
        return TRACE_ID_PROVIDER.get();
    }

    @Override
    public Map getTraceData() {
        Map data = traceData.get();
        if (data == null) {
            data = new HashMap<>();
            traceData.set(data);
        }
        return data;
    }

}