(更新:我的问题似乎与 this one 相同,但没有有效的答案。)
我正在尝试登录 Spring Boot ErrorController
,但它的日志没有 MDC 值。
@Controller
@RequestMapping("/error")
@RequiredArgsConstructor
@Slf4j
public class MyErrorController implements ErrorController {
private final ErrorAttributes errorAttributes;
@Override
public String getErrorPath() {
return null;
}
@RequestMapping
@ResponseBody
public Map<String, String> error(final HttpServletRequest request) {
final ServletWebRequest webRequest = new ServletWebRequest(request);
final Throwable th = errorAttributes.getError(webRequest);
if (th != null) {
// **Logged without "requestId" value**
log.error("MyErrorController", th);
}
return Map.of("result", "error");
}
}
// http://logback.qos.ch/manual/mdc.html#autoMDC
public class MDCFilter extends OncePerRequestFilter {
@Override
protected void doFilterInternal(final HttpServletRequest request, final HttpServletResponse response,
final FilterChain filterChain)
throws ServletException, IOException {
final String requestId = UUID.randomUUID().toString();
MDC.put("requestId", requestId);
try {
filterChain.doFilter(request, response);
} finally {
MDC.remove("requestId");
}
}
}
@Configuration
public class MyConfig {
@Bean
public FilterRegistrationBean<MDCFilter> mdcFilter() {
final FilterRegistrationBean<MDCFilter> bean = new FilterRegistrationBean<>();
bean.setFilter(new MDCFilter());
bean.addUrlPatterns("/*");
bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
return bean;
}
}
logback-spring.xml
:
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- encoders are assigned the type
ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] requestId:%X{requestId} %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
</root>
</configuration>
结果(requestId
值未出现):
18:15:13.705 [http-nio-8080-exec-1] requestId: ERROR c.e.l.MyErrorController - MyErrorController
java.lang.RuntimeException: Error occured.
...
我认为我需要在 DispatcherServlet
之前调整 MDCFilter
,但我不知道该怎么做。
最佳答案
删除 ServletRequestListener#requestDestroyed()
上的 MDC 数据而不是过滤器
。
在 Tomcat 上 StandardHostValve在执行 ErrorController
后触发 RequestDestroyEvent
。
// Look for (and render if found) an application level error page
if (response.isErrorReportRequired()) {
// If an error has occurred that prevents further I/O, don't waste time
// producing an error report that will never be read
AtomicBoolean result = new AtomicBoolean(false);
response.getCoyoteResponse().action(ActionCode.IS_IO_ALLOWED, result);
if (result.get()) {
if (t != null) {
throwable(request, response, t); // *ErrorController is executed*
} else {
status(request, response);
}
}
}
if (!request.isAsync() && !asyncAtStart) {
context.fireRequestDestroyEvent(request.getRequest()); // *RequestDestroyEvent is fired*
}
因此,实现以下内容:
public class MDCClearListener implements ServletRequestListener {
@Override
public void requestDestroyed(final ServletRequestEvent sre) {
MDC.remove("requestId");
}
}
@Bean
public ServletListenerRegistrationBean<MDCClearListener> mdcClearListener() {
final ServletListenerRegistrationBean<MDCClearListener> bean = new ServletListenerRegistrationBean<>();
bean.setListener(new MDCClearListener());
bean.setOrder(Ordered.HIGHEST_PRECEDENCE);
return bean;
}
(具体代码位于 solution
branch 上。)
关于相关问题的回答
This answer不适合我。因为:
第一种方式不使用ErrorController
,而是使用@ExceptionHandler
,因此无法捕获Spring Security Filter
抛出的异常。
(尝试 answer/exceptionhandler-with-springsecurity
branch 代码。)
第二种方式将 UUID 放在拦截器上,因此记录 MyController
和 MyErrorController
之间的不同 requestId。这不是“请求”ID。
(尝试 answer/interceptor
branch 代码。)
关于spring-boot - 使用 Logback MDC 进行 Spring Boot ErrorController 日志记录,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/66865224/