在项目的开发过程中,对于log打印时,一次request到response的请求,以及到响应到客户端的数据的请求,我们希望都能够串起来,因此,需要有一个唯一id来标识,这里我们通过log4j2中的logId来实现。
Log4j2中包含一个类:ThreadContext(实际上是一个本地线程)
可以自己生成一个唯一id:比如:uuid
logId = uuid;
ThreadContext.put("logId", UUID.randomUUID().toString());
然后在过滤器或者拦截器之前设置:ThreadContext.put("logId", logId);
log4j2.xml中配置如下:
我的是SpringBoot项目,在项目配置中分别增加WebCofig类、和拦截器(Interceptor)、(线程储存工具类)FeignUtil
WebCofig如下:
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import XXXXXXXX.advice.HsInterceptor;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.util.ResourceUtils;
import org.springframework.web.servlet.config.annotation.*;
import java.util.ArrayList;
import java.util.List;
@Configuration
@EnableWebMvc
@ComponentScan
public class WebConfig extends WebMvcConfigurerAdapter implements ApplicationContextAware {
@Bean
public RequestInterceptor headerInterceptor() {
return new RequestInterceptor() {
@Override
public void apply(RequestTemplate requestTemplate) {
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder
.getRequestAttributes();
if(attributes != null) {
HttpServletRequest request = attributes.getRequest();
Enumeration headerNames = request.getHeaderNames();
if (headerNames != null) {
while (headerNames.hasMoreElements()) {
String name = headerNames.nextElement();
String values = request.getHeader(name);
requestTemplate.header(name, values);
}
}
}
String logId = FeignUtil.getLogId();
if(!StringUtils.isEmpty(logId)){
requestTemplate.header("logId",logId);
}
requestTemplate.header("feignUsername", hsSercurityPorperties.getFeginUsername());
requestTemplate.header("feignPassword", hsSercurityPorperties.getFeginPassword());
}
};
}
@Override
public void configureMessageConverters(List> converters) {
super.configureMessageConverters(converters);
// converters.add(0,new StringHttpMessageConverter());
//1.需要定义一个convert转换消息的对象;
FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
//2:添加fastJson的配置信息;
FastJsonConfig fastJsonConfig = new FastJsonConfig();
/**
* TODO 第一个SerializerFeature.PrettyFormat可以省略,毕竟这会造成额外的内存消耗和流量,第二个是用来指定当属性值为null是是否输出:pro:null
* SerializerFeature.SkipTransientField
*/
fastJsonConfig.setSerializerFeatures(SerializerFeature.WriteMapNullValue);
//3处理中文乱码问题
List fastMediaTypes = new ArrayList<>();
fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
//4.在convert中添加配置信息.
fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
HttpMessageConverter> converter = fastJsonHttpMessageConverter;
converters.add(0, converter);
// converters.add(1, new MappingJackson2HttpMessageConverter());
}
private ApplicationContext applicationContext;
public WebConfig(){
super();
}
@Override
public void addViewControllers(ViewControllerRegistry registry) {
}
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
// registry.addResourceHandler("/static/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX+"/static/");
// registry.addResourceHandler("/templates/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX+"/templates/");
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
registry.addResourceHandler("**")
.addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX+"/static/")
.addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX+"/_static/");
// registry.addResourceHandler("/templates/**").addResourceLocations(ResourceUtils.CLASSPATH_URL_PREFIX+"/templates/");
super.addResourceHandlers(registry);
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
// registry.addInterceptor(new JlInterceptor()).addPathPatterns("/**").excludePathPatterns("/adminUser/login");
registry.addInterceptor(getInterceptor()).addPathPatterns("/**").excludePathPatterns("/**.html","/v2/api-docs","/swagger-resources/**","/webjars/**");
super.addInterceptors(registry);
}
@Bean
HsInterceptor getInterceptor(){
return new HsInterceptor();
}
}
Interceptor如下:
package XXXXX;
import com.xxxxx.common.FeignUtil;
import org.apache.logging.log4j.ThreadContext;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.UUID;
public class HsInterceptor implements HandlerInterceptor {
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) {
// TODO Auto-generated method stub
initLog("logId","logId");
}
private void initLog(String logId, String serviceName){
try {
if (StringUtils.isEmpty(logId)) {
logId = String.format("%s-%s",serviceName,UUID.randomUUID().toString().replace("-",""));
} else {
String[] logIds = logId.split("-");
if (logIds != null || logIds.length == 2) {
logId = logIds[0] + "_" + serviceName+"-" + logIds[1];
}
}
FeignUtil.setLogId(logId);
}catch (Exception e){
}
ThreadContext.put("logId",logId );
}
}
FeignUtil如下:
@Data
public class FeignUtil {
private static ThreadLocal logId = new ThreadLocal<>();
private static ThreadLocal method = new ThreadLocal<>();
}
即在pattern中添加{logId}来打印出logId的唯一标识。
PS:我们可以将logId通过response中设置header字段作为一个唯一标识,这样前端和服务端就通过logId完全贯穿起来。
requestTemplate.header("logId",logId);
这样我们排查日志时:grep 'logId'就可以看到完整请求记录了
附测试方法:
public static void main(String[] args) {
ThreadContext.put("logId", UUID.randomUUID().toString());
for (int i=0;i<10;i++){
log.info ("i am Chinese");
}
}
控制台输出日志如下:
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.183 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.184 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.184 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.185 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.185 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.188 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.190 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.190 [INFO] TestController(TestController.java:239) i am Chinese
[LOGID:62e331fc-e0af-40cd-be80-431fd4fddc2c] 2020/04/10 15:22:19.190 [INFO] TestController(TestController.java:239) i am Chinese