高并发接口调用时,一个接口的日志会被分散打印,为了快速查找一个接口打印的日志,在日志输出时实现唯一的ID检索
实现思路
通过实现拦截器HandlerInterceptor接口
使用UUID生成唯一编号threadId
在控制器controller方法之前,使用MDC(log4j上下问对象)存储唯一编号threadId
在控制器controller方法处理完之后,将MDC对象中的threadId移除
springmvc中使用xml配置拦截器生效
springboot中使用配置类生效
实现拦截器接口
//该注解在springmvc的时候使用
//@Component
@Slf4j
public class LogInterceptor implements HandlerInterceptor {
//线程ID常量
private static final String THREAD_ID = "THREAD_ID";
/**
* controller方法前调用
*/
@Override
public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {
log.debug("preHandle running ...");
//使用UUID生成唯一编号
String threadId = UUID.randomUUID().toString().trim().replaceAll("-", "");
//判断MDC(log4j中的上下文对象) 中是否有该threadId
if (StringUtils.isEmpty(MDC.get(THREAD_ID))) {
//如果没有,添加
MDC.put(THREAD_ID,threadId);
}
//永远返回true
return true;
}
/**
* preHandle方法返回true之后
* 在controller方法处理完之后调用
*/
@Override
public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object, ModelAndView modelAndView) throws Exception {
log.debug("postHandle running ...");
//controller结束之后删除对应的唯一值
MDC.remove(THREAD_ID);
}
/**
* preHandle方法返回true之后
* 在DispatcherServlet进行视图的渲染之后调用
*/
@Override
public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object, Exception e) throws Exception {
log.debug("afterCompletion running ...");
}
}
springmvc中 spring-mvc.xml中配置拦截器
该配置文件就是applicationContext.xml配置文件,项目中可以自定义名称
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<!--配置LogInterceptor bean -->
<bean class="xxx.xxx.config.log.LogInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
springboot中实现WebMvcConfigurer注册配置器
实现WebMvcConfigurer接口,类似于web.xml
/**
* webmvc配置类
* 该注解@Configuration表示为配置类 springmvc中的web.xml
* 该注解@EnableWebMvc 表示启动webmvc配置功能
*/
@Configuration
@EnableWebMvc
public class ApplicationWebMvcConfig implements WebMvcConfigurer {
/**
* 注解LogInterceptor类到IOC容器中
*/
@Bean
public LogInterceptor logInterceptor() {
return new LogInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
//注册日志拦截器
registry.addInterceptor(logInterceptor());
}
}
修改logback.xml文件
springboot中直接引入logback.xml文件即可,官方推荐使用logback-spring.xml的名称
springmvc中需要在web.xml配置logback.xml
这里不再展示logback配置流程
与之前logback不同之处在于CONSOLE_LOG_PATTERN和FILE_LOG_PATTERN多了 [%X{THREAD_ID}],THREAD_ID变量就是拦截器中定义的变量
<?xml version="1.0" encoding="UTF-8"?>
<!-- 从高到地低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别,日志输出时,级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面,会出现高级别文件,依然出现低级别的日志信息,通过filter 过滤只记录本级别的日志-->
<!-- 属性描述 scan:性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" debug="false">
<!-- 定义日志文件 输入位置 tomcat 下的logs路径下 更改对应的项目名称,会创建对应的文件夹-->
<property name="path" value="../logs/demo-springboot-mybatis"/>
<!--控制台打印彩色日志-->
<property name="CONSOLE_LOG_PATTERN"
value="%red(%d{HH:mm:ss})-%green([%X{THREAD_ID}])-%highlight(%-5level[%4line])-%boldMagenta(%logger{10}) : %cyan(%msg%n)"/>
<!-- 日志文件输入时的格式-->
<property name="FILE_LOG_PATTERN"
value="%d{HH:mm:ss}-[%X{THREAD_ID}]-%-5level[%4line] - %logger{10} - %msg%n"/>
<logger name="org.springframework" level="ERROR"/>
<logger name="org.sunyard.itmc" level="INFO"/>
<appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>
${FILE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset>
<!-- 此处设置字符集,防止中文乱码 -->
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${path}/info/info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 最大64MB 超过最大值,会重新建一个文件-->
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<!-- Safely log to the same file from multiple JVMs. Degrades performance! -->
<!--如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。-->
<prudent>false</prudent>
</appender>
<appender name="FILE_WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder>
<pattern>
${FILE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset>
<!-- 此处设置字符集,防止中文乱码 -->
</encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${path}/warn/warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 最大64MB 超过最大值,会重新建一个文件-->
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>WARN</level>
</filter>
<!-- Safely log to the same file from multiple JVMs. Degrades performance! -->
<!--如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。-->
<prudent>false</prudent>
</appender>
<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 文件输出的日志 的格式 -->
<encoder>
<pattern>
${FILE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset>
<!-- 此处设置字符集,防止中文乱码 -->
</encoder>
<!-- 配置日志所生成的目录以及生成文件名的规则 在logs/mylog-2016-10-31.0.log -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${path}/error/error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 最大64MB 超过最大值,会重新建一个文件-->
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERROR</level>
</filter>
<!-- Safely log to the same file from multiple JVMs. Degrades performance! -->
<!--如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。-->
<prudent>false</prudent>
</appender>
<appender name="FILE_DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 文件输出的日志 的格式 -->
<encoder>
<pattern>
${FILE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset>
<!-- 此处设置字符集,防止中文乱码 -->
</encoder>
<!-- 配置日志所生成的目录以及生成文件名的规则 在logs/mylog-2016-10-31.0.log -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${path}/debug/debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
<timeBasedFileNamingAndTriggeringPolicy
class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- 最大64MB 超过最大值,会重新建一个文件-->
<maxFileSize>64 MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
<!-- Safely log to the same file from multiple JVMs. Degrades performance! -->
<!--如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。-->
<prudent>false</prudent>
</appender>
<!--控制台输出的格式设置 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- 控制台输出的日志 的格式 -->
<encoder>
<pattern>
${CONSOLE_LOG_PATTERN}
</pattern>
<charset>UTF-8</charset> <!-- 此处设置字符集 -->
</encoder>
<!-- 只是DEBUG级别以上的日志才显示 -->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>DEBUG</level>
</filter>
</appender>
<!-- root级别 (name = dao 实现SQL打印并写入日志文件,与mybatis-config.xml中的dao.对应) DEBUG -->
<root name="dao" level="DEBUG">
<!-- 控制台输出 -->
<appender-ref ref="STDOUT"/>
<!-- 文件输出 -->
<appender-ref ref="FILE_WARN"/>
<appender-ref ref="FILE_INFO"/>
<appender-ref ref="FILE_ERROR"/>
<appender-ref ref="FILE_DEBUG"/>
</root>
</configuration>
结果演示
16:38:32-[28a12e4fe4e74216ba0e422b9d9ea447]-DEBUG[ 19]-c.s.d.c.PersonController : 查询list
16:38:32-[28a12e4fe4e74216ba0e422b9d9ea447]-INFO [ 20]-c.s.d.c.PersonController : 查询list
16:38:32-[28a12e4fe4e74216ba0e422b9d9ea447]-WARN [ 21]-c.s.d.c.PersonController : 查询list
16:38:32-[28a12e4fe4e74216ba0e422b9d9ea447]-ERROR[ 22]-c.s.d.c.PersonController : 查询list