Spring方法拦截器MethodInterceptor和AOP统一处理log

对每个接口的请求记录log的方法有很多种，比如用filter、mvc interceptor、method interceptor等。如果需要记录请求消息的payload，前两种不适用。下面介绍第三种的实现方法。

第一步：引入包依赖

[java]  view plain  copy

1. <span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);"></span><pre name="code" class="java">      <!-- For AOP -->        
2.         <dependency>  
3.             <groupId>org.aspectj</groupId>  
4.             <artifactId>aspectjweaver</artifactId>  
5.             <version>1.8.6</version>  
6.         </dependency>  
7.         <!-- databind会自动引用core和annotations，所以不用声明另外两个 -->  
8.         <dependency>  
9.             <groupId>com.fasterxml.jackson.core</groupId>  
10.             <artifactId>jackson-databind</artifactId>  
11.             <version>2.5.3</version>  
12.         </dependency>  

[java]  view plain  copy

1. <span style="font-family: Arial, Helvetica, sans-serif; background-color: rgb(255, 255, 255);">（其他log、spring包依赖：略）</span>  

第二步：继承org.aopalliance.intercept.MethodInterceptor，实现invoke方法：

[java]  view plain  copy

1. /** 
2.  * 方法拦截器，拦截Controller中的方法，记录log 
3.  * 
4.  */  
5. public class ControllerMethodInterceptor implements MethodInterceptor {  
6.     private final Logger logger = LoggerFactory.getLogger(this.getClass());  
7.       
8.     private final static ObjectMapper jsonMapper = new ObjectMapper();  
9.   
10.     @Override  
11.     public Object invoke(MethodInvocation invocation) throws Throwable {  
12.         logger.info("Before: interceptor name: {}", invocation.getMethod().getName());  
13.           
14.         logger.info("Arguments: {}", jsonMapper.writeValueAsString(invocation.getArguments()));  
15.           
16.         Object result = invocation.proceed();  
17.           
18.         logger.info("After: result: {}", jsonMapper.writeValueAsString(result));  
19.           
20.         return result;  
21.     }  
22.   
23. }  

第三步：配置拦截

[java]  view plain  copy

1. <bean id="controllerMethodInterceptor" class="com.xjj.web.interceptor.ControllerMethodInterceptor"/>  
2.   
3. <!-- 方法拦截器（拦截Controller包中的所有被RequestMapping注解的方法） MethodInterceptor -->  
4. <aop:config proxy-target-class="true">  
5.     <aop:pointcut id="controllerMethodPointcut" expression="execution(* com.xjj.web.controller..*(..)) and  
6.         @annotation(org.springframework.web.bind.annotation.RequestMapping)"/>  
7.     <aop:advisor advice-ref="controllerMethodInterceptor" pointcut-ref="controllerMethodPointcut" />  
8. </aop:config>  

这样，所有com.xjj.web.controller包中的被RequestMapping注解的方法都会被ControllerMethodInterceptor拦截。在ControllerMethodInterceptor中，可以记录被拦截的方法中的参数、返回值等。

具体的全部代码请参考：https://github.com/xujijun/MyJavaStudio

（原创文章，转载请注明转自Clement-Xu的博客）