添加requestId、processId分别为请求id和进程id
添加拦截器拦截每次请求并把请求id和进程id存入mdc在logback.xml中调用并在控制台打印
MDC是 log4j 和 logback 支持的一种方便在多线程条件下记录追踪日志的功能
统一日志格式这里希望在打印日志时,每行数据都有一个请求ID,这样就很方面追踪日志,slf4j有个MDC的类,是ThreadLocal的实现,保存在这里的变量会绑定到某个请求线程,于是在该请求的线程里的日志代码都可以使用设入的变量,在项目里定义一个拦截器,是要拦截所有请求并在MDC中设入变量
requestId:每次请求时拦截请求用uuid作为请求id的唯一标识,保存在mdc中,在logback.xml中,用%X{requestId}在控制台去展示。
processId:用RuntimeMXBean来获取进程id,保存在mdc中在logback.xml中,用%X{processid}在控制台去展示。
话不多说上代码
package com.zhongan.app.hygeia.server.logback;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.lang.management.ManagementFactory;
import java.lang.management.RuntimeMXBean;
import java.util.UUID;
/**
* 在日志上下文增加参数,在日志中可以打印该参数,如RequestId,则日志配置:%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{RequestId}] [%thread] %-5level %logger{36} - %msg%n
* 则 RequestId 会打印在中括号里,%X{参数名} 是格式
*
* 该bean自动被注册,默认的mapping是/*,参考文档
* https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/htmlsingle/#howto-add-a-servlet-filter-or-listener-as-spring-bean (说明了只要是Filter/Servlet/*Listener的bean自动配置)
* https://docs.spring.io/spring-boot/docs/2.2.1.RELEASE/reference/htmlsingle/#boot-features-embedded-container-servlets-filters-listeners-beans (说明了Filters默认map to /*)
*
* 如果需要复杂点的配置,例如多个Filter的顺序、mapping路径的指定,可以在@Configuration类里使用@Bean来产生所需的bean,产生的过程即可指定顺序和mapping路径
*
*/
@Component
public class MDCFilter implements Filter {
private static final String REQUEST_ID_HEADER = "requestId";
private static final String REQUEST_ID = "requestId";
private static final String ProcessId_ID = "processId";
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest httpRequest = (HttpServletRequest) request;
HttpServletResponse httpResponse = (HttpServletResponse) response;
String requestId = httpRequest.getHeader(REQUEST_ID_HEADER);
if (requestId == null) {
requestId = UUID.randomUUID().toString();
}
MDC.put(REQUEST_ID, requestId);
httpResponse.setHeader(REQUEST_ID_HEADER, requestId);
int processId = getProcessID();
MDC.put(ProcessId_ID, String.valueOf(processId));
try {
chain.doFilter(request, response);
} finally {
MDC.clear();
}
}
@Override
public void destroy() {
}
public static final int getProcessID() {
RuntimeMXBean runtimeMXBean = ManagementFactory.getRuntimeMXBean();
return Integer.valueOf(runtimeMXBean.getName().split("@")[0])
.intValue();
}
}