1. 程式人生 > >Spring方法攔截器MethodInterceptor和AOP統一處理log

Spring方法攔截器MethodInterceptor和AOP統一處理log

對每個介面的請求記錄log的方法有很多種,比如用filter、mvc interceptor、method interceptor等。如果需要記錄請求訊息的payload,前兩種不適用。下面介紹第三種的實現方法。

第一步:引入包依賴

  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>  


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

第二步:繼承org.aopalliance.intercept.MethodInterceptor,實現invoke方法:

  1. /** 
  2.  * 方法攔截器,攔截Controller中的方法,記錄log 
  3.  * 
  4.  */
  5. publicclass ControllerMethodInterceptor implements MethodInterceptor {  
  6.     privatefinal Logger logger = LoggerFactory.getLogger(this.getClass());  
  7.     privatefinalstatic ObjectMapper jsonMapper = new ObjectMapper();  
  8.     @Override
  9.     public Object invoke(MethodInvocation invocation) throws Throwable {  
  10.         logger.info("Before: interceptor name: {}", invocation.getMethod().getName());  
  11.         logger.info("Arguments: {}", jsonMapper.writeValueAsString(invocation.getArguments()));  
  12.         Object result = invocation.proceed();  
  13.         logger.info("After: result: {}", jsonMapper.writeValueAsString(result));  
  14.         return result;  
  15.     }  
  16. }  

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

這樣,所有com.xjj.web.controller包中的被RequestMapping註解的方法都會被ControllerMethodInterceptor攔截。在ControllerMethodInterceptor中,可以記錄被攔截的方法中的引數、返回值等。

具體的全部程式碼請參考:https://github.com/xujijun/MyJavaStudio

(原創文章,轉載請註明轉自Clement-Xu的部落格)