摘要：介紹中包含的可以被同一線程中執(zhí)行的代碼所訪問內(nèi)容。當(dāng)前線程的子線程會(huì)繼承其父線程中的的內(nèi)容。記錄日志時(shí)，只需要從中獲取所需的信息即可。作用使用來記錄日志，可以規(guī)范多開發(fā)下日志格式。

介紹：
MDC 中包含的可以被同一線程中執(zhí)行的代碼所訪問內(nèi)容。當(dāng)前線程的子線程會(huì)繼承其父線程中的 MDC 的內(nèi)容。記錄日志時(shí)，只需要從 MDC 中獲取所需的信息即可。
作用：
使用MDC來記錄日志，可以規(guī)范多開發(fā)下日志格式。

一：新建線程處理類 ThreadContext

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

/**
 * 線程上下文
 *
 * @date 2017年3月1日
 * @since 1.0.0
 */
public class ThreadContext {
    /**
     * 線程上下文變量的持有者
     */
    private final static ThreadLocal> CTX_HOLDER = new ThreadLocal>();

    static {
        CTX_HOLDER.set(new HashMap());
    }

 
    /**
     * traceID
     */
    private final static String TRACE_ID_KEY = "traceId";

    /**
     * 會(huì)話ID
     */
    private final static String SESSION_KEY = "token";

    /**
     * 操作用戶ID
     */
    private final static String VISITOR_ID_KEY = "userId";
    /**
     * 操作用戶名
     */
    private final static String VISITOR_NAME_KEY = "userName";

    /**
     * 客戶端IP
     */
    private static final String CLIENT_IP_KEY = "clientIp";

    /**
     * 添加內(nèi)容到線程上下文中
     *
     * @param key
     * @param value
     */
    public final static void putContext(String key, Object value) {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return;
        }
        ctx.put(key, value);
    }

    /**
     * 從線程上下文中獲取內(nèi)容
     *
     * @param key
     */
    @SuppressWarnings("unchecked")
    public final static  T getContext(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return null;
        }
        return (T) ctx.get(key);
    }

    /**
     * 獲取線程上下文
     */
    public final static Map getContext() {
        Map ctx = CTX_HOLDER.get();
        if (ctx == null) {
            return null;
        }
        return ctx;
    }

    /**
     * 刪除上下文中的key
     *
     * @param key
     */
    public final static void remove(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx != null) {
            ctx.remove(key);
        }
    }

    /**
     * 上下文中是否包含此key
     *
     * @param key
     * @return
     */
    public final static boolean contains(String key) {
        Map ctx = CTX_HOLDER.get();
        if (ctx != null) {
            return ctx.containsKey(key);
        }
        return false;
    }

    /**
     * 清空線程上下文
     */
    public final static void clean() {
        CTX_HOLDER.remove();
    }

    /**
     * 初始化線程上下文
     */
    public final static void init() {
        CTX_HOLDER.set(new HashMap());
    }


    /**
     * 設(shè)置traceID數(shù)據(jù)
     */
    public final static void putTraceId(String traceId) {
        putContext(TRACE_ID_KEY, traceId);
    }

    /**
     * 獲取traceID數(shù)據(jù)
     */
    public final static String getTraceId() {
        return getContext(TRACE_ID_KEY);
    }

    /**
     * 設(shè)置會(huì)話的用戶ID
     */
    public final static void putUserId(Integer userId) {
        putContext(VISITOR_ID_KEY, userId);
    }

    /**
     * 設(shè)置會(huì)話的用戶ID
     */
    public final static int getUserId() {
        Integer val = getContext(VISITOR_ID_KEY);
        return val == null ? 0 : val;
    }

    /**
     * 設(shè)置會(huì)話的用戶名
     */
    public final static void putUserName(String userName) {
        putContext(VISITOR_NAME_KEY, userName);
    }

    /**
     * 獲取會(huì)話的用戶名稱
     */
    public final static String getUserName() {
        return Optional.ofNullable(getContext(VISITOR_NAME_KEY))
                .map(name -> String.valueOf(name))
                .orElse("");
    }

    /**
     * 取出IP
     *
     * @return
     */
    public static final String getClientIp() {
        return getContext(CLIENT_IP_KEY);
    }

    /**
     * 設(shè)置IP
     *
     * @param ip
     */
    public static final void putClientIp(String ip) {
        putContext(CLIENT_IP_KEY, ip);
    }

    /**
     * 設(shè)置會(huì)話ID
     *
     * @param token
     */
    public static void putSessionId(String token) {
        putContext(SESSION_KEY, token);
    }

    /**
     * 獲取會(huì)話ID
     *
     * @param token
     */
    public static String getSessionId(String token) {
        return getContext(SESSION_KEY);
    }

    /**
     * 清空會(huì)話數(shù)據(jù)
     */
    public final static void removeSessionId() {
        remove(SESSION_KEY);
    }
}

二：添加工具類TraceUtil

import java.util.UUID;
import org.slf4j.MDC;
import ThreadContext;

/**
 * trace工具
 *
 * @date 2017年3月10日
 * @since 1.0.0
 */
public class TraceUtil {

    public static void traceStart() {
        ThreadContext.init();
        String traceId = generateTraceId();
        MDC.put("traceId", traceId);
        ThreadContext.putTraceId(traceId);
    }

    public static void traceEnd() {
        MDC.clear();
        ThreadContext.clean();
    }

    /**
     * 生成跟蹤ID
     *
     * @return
     */
    private static String generateTraceId() {
        return UUID.randomUUID().toString();
    }
}

三：添加ContextFilter，對(duì)于每個(gè)請(qǐng)求隨機(jī)生成RequestID并放入MDC

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.web.filter.OncePerRequestFilter;

import com.pingan.manpan.common.util.TraceUtil;
import com.pingan.manpan.user.dto.ThreadContext;
import com.pingan.manpan.web.common.surpport.IpUtils;

/**
 * 上下文Filter
 *
 * @date 2017/3/10
 * @since 1.0.0
 */
//@Order 標(biāo)記組件的加載順序
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ContextFilter extends OncePerRequestFilter {

    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
                                    FilterChain filterChain) throws ServletException, IOException {
        try {
            ThreadContext.putClientIp(IpUtils.getClientIp(request));
            TraceUtil.traceStart();

            filterChain.doFilter(request, response);
        } finally {
            TraceUtil.traceEnd();
        }
    }
}

四：在webConfiguriation注冊(cè)filter

    /**
     * 請(qǐng)求上下文,應(yīng)該在最外層
     *
     * @return
     */
    @Bean
    public FilterRegistrationBean requestContextRepositoryFilterRegistrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new ContextFilter());
        filterRegistrationBean.addUrlPatterns("/*");
        return filterRegistrationBean;
    }

五：修改log4j日志配置文件，設(shè)置日志traceId

    

    
    
    

    
    

    
        
            ${FILE_LOG_PATTERN}
        
        ${LOG_FILE}${LOG_FILE_SUFFIX}
        
            ${LOG_FILE}.%d{yyyy-MM-dd}${LOG_FILE_SUFFIX}
        
    

    
        127.0.0.1
        local6
        514
        ${FILE_LOG_PATTERN}