Java web项目创建笔记13 之《使用拦截器实现日志ID跟踪》

最新推荐文章于 2024-08-25 14:24:47 发布

csj50

最新推荐文章于 2024-08-25 14:24:47 发布

阅读量427

点赞数 1

分类专栏： JAVA WEB创建笔记

本文链接：https://blog.csdn.net/csj50/article/details/93196746

版权

JAVA WEB创建笔记专栏收录该内容

79 篇文章 4 订阅

订阅专栏

一、springmvc的拦截器
拦截器需要实现HandlerInterceptor接口，里面有三个方法
1、preHandle是调用Controller之前被调用，当返回false后，会跳过之后的拦截器，并且不会执行所有拦截器的postHandle，并调用返回true的拦截器的afterCompletion方法。
2、postHandle是调用Controller之后被调用，但是在渲染View页面之前。
3、afterCompletion是调用完Controller接口，渲染View页面最后调用。返回true的拦截器都会调用该拦截器的afterCompletion方法，顺序相反。

二、添加拦截器类
1、建立包com.study.base.interceptor
2、新增MdcSessionInterceptor.java

package com.study.base.interceptor;

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

import org.slf4j.MDC;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.study.base.common.Constants;
import com.study.base.util.SessionUtil;

public class MdcSessionInterceptor implements HandlerInterceptor {

	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {
		MDC.put(Constants.SESSION_ID, SessionUtil.getSessionId());
		return true;
	}

	@Override
	public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			ModelAndView modelAndView) throws Exception {
		// TODO Auto-generated method stub

	}

	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
			throws Exception {
		MDC.remove(Constants.SESSION_ID);
	}

}

3、spring-mvc.xml注册拦截器类

<!-- 注册拦截器 -->
<mvc:interceptors>
	<mvc:interceptor>
		<mvc:mapping path="/**" />
		<bean class="com.study.base.interceptor.MdcSessionInterceptor" />
	</mvc:interceptor>
</mvc:interceptors>

4、建立包com.study.base.common
5、新增Constants.java

package com.study.base.common;

public class Constants {
	
	/** sessionid常量 **/
	public static String SESSION_ID = "sessionId";

	/** 日志逻辑ID **/
	public static String LOG_ID = "logId";

	/** 日志逻辑ID **/
	public static String BIZ_ID = "bizId";
	
	/**
     * 处理成功
     */
    public static final String SUCCESS = "000000";

    /**
     * 处理异常
     */
    public static final String FAILURE = "999999";
    
    public static final String E000001 = "000001";
    public static final String E000002 = "000002";
    
}

三、访问测试链接
http://127.0.0.1:8080/webapp2/mvc/hello
http://127.0.0.1:8080/webapp2/mvc/testError
http://127.0.0.1:8080/webapp2/mvc/testError2

webapp2-web.log日志：

2019-06-21 15:52:28.515 [] [1561103548506-9004] [] [] INFO  [http-nio-8080-exec-5] com.study.web.resources.TestController [18]:hello in...
2019-06-21 15:52:28.519 [] [1561103548506-9004] [] [] INFO  [http-nio-8080-exec-5] com.study.web.resources.TestController [19]:hello out...
2019-06-21 15:52:37.694 [] [1561103557694-6219] [] [] INFO  [http-nio-8080-exec-8] com.study.web.resources.TestController [25]:testError in...
2019-06-21 15:52:37.695 [] [1561103557694-6219] [] [] INFO  [http-nio-8080-exec-8] com.study.web.resources.TestController [26]:testError out...
2019-06-21 15:52:42.984 [] [1561103562984-2312] [] [] INFO  [http-nio-8080-exec-9] com.study.web.resources.TestController [32]:testError2 in...
2019-06-21 15:52:42.984 [] [1561103562984-2312] [] [] INFO  [http-nio-8080-exec-9] com.study.web.resources.TestController [33]:testError2 out...

webapp2-exception.log日志：

2019-06-21 15:52:37.731 [] [1561103557694-6219] [] [] ERROR [http-nio-8080-exec-8] com.study.base.exception.ExceptionResolver [25]:[业务异常]<1234567890> 报错信息1	null
2019-06-21 15:52:37.738 [] [1561103557694-6219] [] [] ERROR [http-nio-8080-exec-8] com.study.base.exception.ExceptionResolver [26]:errorCode:1234567890  errorMsg:[报错信息1]
2019-06-21 15:52:43.017 [] [1561103562984-2312] [] [] ERROR [http-nio-8080-exec-9] com.study.base.exception.ExceptionResolver [33]:其他异常:  报错信息2
com.study.base.exception.SysException:  报错信息2
	at com.study.web.resources.TestController.testError2(TestController.java:34)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:133)
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:97)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:849)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:760)
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:967)
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:901)
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)
	at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:861)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:622)
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:729)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:292)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:207)
	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:240)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:207)
	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:197)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:240)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:207)
	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:212)
	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:94)
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:504)
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:141)
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:79)
	at org.apache.catalina.valves.AbstractAccessLogValve.invoke(AbstractAccessLogValve.java:620)
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:88)
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:502)
	at org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1132)
	at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:684)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1539)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.run(NioEndpoint.java:1495)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	at java.lang.Thread.run(Thread.java:748)

日志中打印了session id。

四、参考资料
https://blog.csdn.net/qq_25673113/article/details/79153547
https://www.liangzl.com/get-article-detail-6942.html

注：最新代码上传至https://github.com/csj50/webapp2.git