利用注解式切面单独打印接口调用日志

背景： 我们可能希望对项目中的接口性能进行监控，例如：接口调用时间，开始时间，结束时间，传入的参数等等，通常的做法是在接口代码开始处记录startTime，结尾处记录endTime，然后计算startTime和endTime之差，这种做法无法把这部分日志单独拆分成文件，而且冗余代码会比较多。可以考虑使用spring切面和环绕通知来打印这部分日志，并使用log4j2将这部分日志单独拆分出来。
ps:拆分的出来的日志可以考虑使用shell脚本和awk命令来进行日志分析，将一些关键的数据存库，然后使用echarts来分析来展示图表，就可以成为一个小型的接口监控系统，使用linux的crontab来定时执行脚本，每天刷新数据。

技术点：spring 注解式切面和环绕通知

使用的项目：工作流、规则引擎

具体实现（以规则引擎为例）：
1.在rpc-impl层新增PerformenceMonitor类（名字可以随便起）

1. package com.yixin.ndss.common.aop;
   
2. 
   
3. import java.text.SimpleDateFormat;
   
4. import java.util.Date;
   
5. import org.apache.logging.log4j.Level;
   
6. import org.apache.logging.log4j.LogManager;
   
7. import org.apache.logging.log4j.Logger;
   
8. import org.aspectj.lang.ProceedingJoinPoint;
   
9. import org.aspectj.lang.annotation.Around;
   
10. import org.aspectj.lang.annotation.Aspect;
    
11. import org.aspectj.lang.annotation.Pointcut;
    
12. import org.springframework.stereotype.Component;
    
13. import com.yixin.common.utils.JsonObjectUtils;
    
14. 
    
15. /**
    
16. * 监控方法的执行时间
    
17. * 
    
18. * <p>
    
19. * 
    
20. * Package : com.yixin.common.system.ioc
    
21. * 
    
22. * @author YixinCapital -- shaoml
    
23. *                   2016年10月20日 下午6:55:45
    
24. *
    
25. */
    
26. @Aspect  
    
27. @Component
    
28. public class PerformenceMonitor {
    
29.         
    
30.         private static final Logger LOGGER = LogManager.getLogger(PerformenceMonitor.class);
    
31.         
    
32.         /**
    
33.          * 切点监控com.yixin.wfpt.api.process.impl包的所有public方法  
    
34.          *  
    
35.          * @author YixinCapital -- shaoml
    
36.          *               2017年4月26日 上午9:55:31
    
37.          */
    
38.     @Pointcut("execution(* com.yixin.ndss.application.api.impl..*(..))")    
    
39.     private void pointCutMethod() {
    
40.             
    
41.     }    
    
42.   
    
43.     /**
    
44.      * 声明环绕通知
    
45.      * 
    
46.      * @param pjp 代理对象
    
47.      * @return Object 方法调用出参
    
48.      * @throws Throwable 
    
49.      * @author YixinCapital -- shaoml
    
50.      *               2017年4月26日 上午9:55:16
    
51.      */
    
52.     @Around("pointCutMethod()")    
    
53.     public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    
54.             
    
55.             SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    
56.             
    
57.         // 执行方法开始时间
    
58.             long begin = System.currentTimeMillis();
    
59.         String beginStr = sdf.format(new Date(begin));
    
60.         
    
61.         Object obj = pjp.proceed();
    
62.         
    
63.         // 入参拦截
    
64.         Object[] args = pjp.getArgs();
    
65.         
    
66.         // 执行方法结束时间
    
67.         long end = System.currentTimeMillis();
    
68.         String endStr = sdf.format(new Date(end));
    
69.         
    
70.         LOGGER.log(Level.forName("CAP", 460),
    
71.                         "======调用" + pjp.getTarget().getClass().getSimpleName()
    
72.                         + "类中方法: " + pjp.getSignature().getName()
    
73.                         + "(), 开始时间: " + beginStr + ", 结束时间: " + endStr + ", 总耗时: " + (end - begin) + "ms,"
    
74.                         + "入参=【" + JsonObjectUtils.objectToJson(args) + "】, 出参=【" + JsonObjectUtils.objectToJson(obj) + "】");
    
75.         
    
76.         return obj;    
    
77.     }
    
78.     
    
79. }

复制代码

2.spring-context xml文件中新增aspectJ自动代理和aop的引用

1.   

复制代码

 

3.配置异步日志：
在log4j2.xml文件中进行如下配置：
 
 

2.png (30.13 KB, 下载次数: 0)

下载附件

2017-7-25 16:25 上传

 


4.本地启动项目，postman调用哪个接口测试：