devbox
2023面试高手
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Spring-Boot+AOP+统计单次请求方法的执行次数和耗时情况_runtimemxbean.getname()耗时长

作者：2023面试高手 | 2024-04-06 13:49:51

赞

踩

runtimemxbean.getname()耗时长

参考文章：Spring-Boot+AOP+统计单次请求方法的执行次数和耗时情况

SpringBoot（审计） 统计接口调用次数及成功率

ControllerInterceptor 

  1. package com.fiend.ou.cdp.monitorcollect.aspect;
  2.  
  3. import org.aspectj.lang.JoinPoint;
  4. import org.aspectj.lang.ProceedingJoinPoint;
  5. import org.aspectj.lang.annotation.*;
  6. import org.slf4j.Logger;
  7. import org.slf4j.LoggerFactory;
  8. import org.springframework.stereotype.Component;
  9.  
  10. import java.util.HashMap;
  11. import java.util.Map;
  12.  
  13. /**
  14.  * @author langpf
  15.  */
  16. @Aspect
  17. @Component
  18. public class WebQueryAespect {
  19.     private final Logger log = LoggerFactory.getLogger(getClass());
  20.  
  21.     //ThreadLocal 维护变量 避免同步
  22.     //ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。
  23.     ThreadLocal<Long> startTime = new ThreadLocal<>();// 开始时间
  24.  
  25.     /**
  26.      * map1存放方法被调用的次数O
  27.      */
  28.     ThreadLocal<Map<String, Long>> methodCalledNumMap = new ThreadLocal<>();
  29.  
  30.     /**
  31.      * map2存放方法总耗时
  32.      */
  33.     ThreadLocal<Map<String, Long>> methodCalledTimeMap = new ThreadLocal<>();
  34.  
  35.     /**
  36.      * 定义一个切入点. 解释下：
  37.      * <p>
  38.      * ~ 第一个 * 代表任意修饰符及任意返回值. ~ 第二个 * 定义在web包或者子包 ~ 第三个 * 任意方法 ~ .. 匹配任意数量的参数.
  39.      */
  40.     static final String pCutStr = "execution(public * com.fiend.*..*(..))";
  41.  
  42.     @Pointcut(value = pCutStr)
  43.     public void logPointcut() {
  44.     }
  45.  
  46.     /**
  47.      * Aop：环绕通知 切整个包下面的所有涉及到调用的方法的信息
  48.      * @param joinPoint jp
  49.      * @return o
  50.      * @throws Throwable t
  51.      */
  52.     @Around("logPointcut()")
  53.     public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
  54.         //初始化 一次
  55.         if (methodCalledNumMap.get() == null) {
  56.             methodCalledNumMap.set(new HashMap<>());
  57.         }
  58.  
  59.         if (methodCalledTimeMap.get() == null) {
  60.             methodCalledTimeMap.set(new HashMap<>());
  61.         }
  62.  
  63.         long start = System.currentTimeMillis();
  64.         try {
  65.             Object result = joinPoint.proceed();
  66.             if (result == null) {
  67.                 //如果切到了 没有返回类型的void方法，这里直接返回
  68.                 return null;
  69.             }
  70.             long end = System.currentTimeMillis();
  71.  
  72.             log.info("===================");
  73.             String targetClassName = joinPoint.getSignature().getDeclaringTypeName();
  74.             String methodName      = joinPoint.getSignature().getName();
  75.  
  76.             Object[] args = joinPoint.getArgs();// 参数
  77.             int argsSize = args.length;
  78.             String argsTypes = "";
  79.             String typeStr = joinPoint.getSignature().getDeclaringType().toString().split(" ")[0];
  80.             String returnType = joinPoint.getSignature().toString().split(" ")[0];
  81.             log.info("类/接口:" + targetClassName + "(" + typeStr + ")");
  82.             log.info("方法:" + methodName);
  83.             log.info("参数个数:" + argsSize);
  84.             log.info("返回类型:" + returnType);
  85.             if (argsSize > 0) {
  86.                 // 拿到参数的类型
  87.                 for (Object object : args) {
  88.                     argsTypes += object.getClass().getTypeName().toString() + " ";
  89.                 }
  90.                 log.info("参数类型：" + argsTypes);
  91.             }
  92.  
  93.             Long total = end - start;
  94.             log.info("耗时: " + total + " ms!");
  95.  
  96.             if (methodCalledNumMap.get().containsKey(methodName)) {
  97.                 Long count = methodCalledNumMap.get().get(methodName);
  98.                 methodCalledNumMap.get().remove(methodName);//先移除，在增加
  99.                 methodCalledNumMap.get().put(methodName, count + 1);
  100.  
  101.                 count = methodCalledTimeMap.get().get(methodName);
  102.                 methodCalledTimeMap.get().remove(methodName);
  103.                 methodCalledTimeMap.get().put(methodName, count + total);
  104.             } else {
  105.                 methodCalledNumMap.get().put(methodName, 1L);
  106.                 methodCalledTimeMap.get().put(methodName, total);
  107.             }
  108.  
  109.             return result;
  110.         } catch (Throwable e) {
  111.             long end = System.currentTimeMillis();
  112.             log.info("====around " + joinPoint + "\tUse time : " + (end - start) + " ms with exception : "
  113.                     + e.getMessage());
  114.             throw e;
  115.         }
  116.  
  117.     }
  118.  
  119.     //对Controller下面的方法执行前进行切入，初始化开始时间
  120.     @Before(value = "execution(public * com.fiend.*.controller.*.*(..))")
  121.     public void beforeMethod(JoinPoint jp) {
  122.         startTime.set(System.currentTimeMillis());
  123.     }
  124.  
  125.     //对Controller下面的方法执行后进行切入，统计方法执行的次数和耗时情况
  126.     //注意，这里的执行方法统计的数据不止包含Controller下面的方法，也包括环绕切入的所有方法的统计信息
  127.     @AfterReturning(value = "execution(* com.fiend.*.controller.*.*(..))")
  128.     public void afterMethod(JoinPoint jp) {
  129.         long end = System.currentTimeMillis();
  130.         long total = end - startTime.get();
  131.         String methodName = jp.getSignature().getName();
  132.         log.info("连接点方法为：" + methodName + ",执行总耗时为：" + total + "ms");
  133.  
  134.         //重新new一个map
  135.         Map<String, Long> map = new HashMap<>();
  136.  
  137.         //从map2中将最后的 连接点方法给移除了，替换成最终的，避免连接点方法多次进行叠加计算
  138.         //由于map2受ThreadLocal的保护，这里不支持remove，因此，需要单开一个map进行数据交接
  139.         for (Map.Entry<String, Long> entry : methodCalledTimeMap.get().entrySet()) {
  140.             if (entry.getKey().equals(methodName)) {
  141.                 map.put(methodName, total);
  142.  
  143.             } else {
  144.                 map.put(entry.getKey(), entry.getValue());
  145.             }
  146.         }
  147.  
  148.         for (Map.Entry<String, Long> entry : methodCalledNumMap.get().entrySet()) {
  149.             for (Map.Entry<String, Long> entry2 : map.entrySet()) {
  150.                 if (entry.getKey().equals(entry2.getKey())) {
  151.                     System.err.println(entry.getKey() + ",被调用次数：" + entry.getValue() + ",综合耗时：" + entry2.getValue() + "ms");
  152.                 }
  153.             }
  154.  
  155.         }
  156.     }
  157. }

2. 统计接口调用次数及成功率

介绍：
　　很多时候会需要提供一些统计记录的，比如某个服务一个月的被调用量、接口的调用次数、成功调用次数等等。
优点：
　　使用AOP+Hendler对业务逻辑代码无侵入，完全解耦。通过spring boot自带的健康检查接口（/health）方便、安全。
注意：
　　数据没有被持久化，只保存在内存中，重启后数据将被重置。可按需自己实现 
代码：
　　AOP:在AOP中调用Handler

2.1 ControllerAdvice

  1. @Component
  2. @Aspect
  3. public class ControllerAdvice {
  4.   private static ILogger log = LoggerFactory.getLogger(ControllerAdvice.class);
  5.  
  6.   @Around("execution(public * *..*controller.*.*(..))")
  7.   public Object handle(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
  8.     Object result;
  9.     try {
  10.       Function<ProceedingJoinPoint, AbstractControllerHandler> build = AbstractControllerHandler.getBuild();
  11.       if (null == build) {
  12.         AbstractControllerHandler.registerBuildFunction(DefaultControllerHandler::new);
  13.       }
  14.       build = AbstractControllerHandler.getBuild();
  15.       AbstractControllerHandler controllerHandler = build.apply(proceedingJoinPoint);
  16.       if (null == controllerHandler) {
  17.         log.warn(String.format("The method(%s) do not be handle by controller handler.", proceedingJoinPoint.getSignature().getName()));
  18.         result = proceedingJoinPoint.proceed();
  19.       } else {
  20.         result = controllerHandler.handle();
  21.       }
  22.     } catch (Throwable throwable) {
  23.       RuntimeHealthIndicator.failedRequestCount++;
  24.       log.error(new Exception(throwable), "Unknown exception- -!");
  25.  
  26.       throw throwable;
  27.     }
  28.  
  29.     return result;
  30.   }
  31. }

2.2 Handler:执行记录的逻辑

2.2.1 抽象类：AbstractControllerHandler 

  1. public abstract class AbstractControllerHandler {
  2.   private static ILogger log = LoggerFactory.getLogger(AbstractControllerHandler.class);
  3.  
  4.   private static Function<ProceedingJoinPoint, AbstractControllerHandler> build;
  5.  
  6.   public static Function<ProceedingJoinPoint, AbstractControllerHandler> getBuild() {
  7.     return build;
  8.   }
  9.  
  10.   public static void registerBuildFunction(Function<ProceedingJoinPoint, AbstractControllerHandler> build) {
  11.     Assert.isNotNull(build, "build");
  12.  
  13.     AbstractControllerHandler.build = build;
  14.   }
  15.  
  16.   protected ProceedingJoinPoint proceedingJoinPoint;
  17.   protected HttpServletRequest httpServletRequest;
  18.   protected String methodName;
  19.   protected String uri;
  20.   protected String requestBody;
  21.   protected String ip;
  22.   protected Method method;
  23.   protected boolean inDataMasking;
  24.   protected boolean outDataMasking;
  25.  
  26.  
  27.   public AbstractControllerHandler(ProceedingJoinPoint proceedingJoinPoint) {
  28.     Assert.isNotNull(proceedingJoinPoint, "proceedingJoinPoint");
  29.  
  30.     this.proceedingJoinPoint = proceedingJoinPoint;
  31.     Signature signature = this.proceedingJoinPoint.getSignature();
  32.     this.httpServletRequest = this.getHttpServletRequest(this.proceedingJoinPoint.getArgs());
  33.     this.methodName = signature.getName();
  34.     this.uri = null == this.httpServletRequest ? null : this.httpServletRequest.getRequestURI();
  35.     this.requestBody = this.formatParameters(this.proceedingJoinPoint.getArgs());
  36.     this.ip = null == this.httpServletRequest ? "" : CommonHelper.getIp(this.httpServletRequest);
  37.     this.inDataMasking = false;
  38.     this.outDataMasking = false;
  39.     if (signature instanceof MethodSignature) {
  40.       MethodSignature methodSignature = (MethodSignature) signature;
  41.       try {
  42.         this.method = proceedingJoinPoint.getTarget().getClass().getMethod(this.methodName, methodSignature.getParameterTypes());
  43.         if (null != this.method) {
  44.           LogDataMasking dataMasking = this.method.getDeclaredAnnotation(LogDataMasking.class);
  45.           if (null != dataMasking) {
  46.             this.inDataMasking = dataMasking.in();
  47.             this.outDataMasking = dataMasking.out();
  48.           }
  49.         }
  50.       } catch (NoSuchMethodException e) {
  51.         e.printStackTrace();
  52.       }
  53.     }
  54.   }
  55.  
  56.   public abstract Object handle() throws Throwable;
  57.  
  58.   protected void logIn() {
  59.     String requestBody = this.requestBody;
  60.     if (this.inDataMasking) {
  61.       requestBody = "Data Masking";
  62.     }
  63.     log.info(String.format("Start-[%s][%s][%s][body: %s]", this.ip, this.uri, this.methodName, requestBody));
  64.   }
  65.  
  66.   protected void logOut(long elapsedMilliseconds, boolean success, String responseBody) {
  67.     if (success) {
  68.       if (this.outDataMasking) {
  69.         responseBody = "Data Masking";
  70.       }
  71.       log.info(
  72.           String.format(
  73.               "Success(%s)-[%s][%s][%s][response body: %s]",
  74.               elapsedMilliseconds,
  75.               this.ip,
  76.               this.uri,
  77.               this.methodName,
  78.               responseBody));
  79.     } else {
  80.       log.warn(
  81.           String.format(
  82.               "Failed(%s)-[%s][%s][%s][request body: %s][response body: %s]",
  83.               elapsedMilliseconds,
  84.               this.ip,
  85.               this.uri,
  86.               this.methodName,
  87.               this.requestBody,
  88.               responseBody));
  89.     }
  90.   }
  91.  
  92.   protected HttpServletRequest getHttpServletRequest(Object[] parameters) {
  93.     try {
  94.       if (null != parameters) {
  95.         for (Object parameter : parameters) {
  96.           if (parameter instanceof HttpServletRequest) {
  97.             return (HttpServletRequest) parameter;
  98.           }
  99.         }
  100.       }
  101.  
  102.       return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
  103.     } catch (Exception e) {
  104.       log.error(e);
  105.  
  106.       return null;
  107.     }
  108.   }
  109.  
  110.   protected String formatParameters(Object[] parameters) {
  111.     if (null == parameters) {
  112.       return null;
  113.     } else {
  114.       StringBuilder stringBuilder = new StringBuilder();
  115.       for (int i = 0; i < parameters.length; i++) {
  116.         Object parameter = parameters[i];
  117.         if (parameter instanceof HttpServletRequest || parameter instanceof HttpServletResponse) {
  118.           continue;
  119.         }
  120.  
  121.         stringBuilder.append(String.format("[%s]: %s.", i, JSON.toJSONString(parameter)));
  122.       }
  123.  
  124.       return stringBuilder.toString();
  125.     }
  126.   }

2.2.2 实现类：

  1. public class DefaultControllerHandler extends AbstractControllerHandler {
  2.   private static ILogger log = LoggerFactory.getLogger(DefaultControllerHandler.class);
  3.   private static int currentMonth = Calendar.getInstance().get(Calendar.MONTH) + 1;
  4.  
  5.   public DefaultControllerHandler(ProceedingJoinPoint proceedingJoinPoint) {
  6.     super(proceedingJoinPoint);
  7.   }
  8.  
  9.   @Override
  10.   public Object handle() throws Throwable {
  11.     long timestamp = System.currentTimeMillis();
  12.     this.logIn();
  13.  
  14.     ResponseDto responseDto;
  15.     boolean success = false;
  16.     try {
  17.       Object result = proceedingJoinPoint.proceed();
  18.       if (result instanceof ResponseDto) {
  19.         responseDto = (ResponseDto) result;
  20.       } else {
  21.         responseDto = ResponseDto.success(result);
  22.       }
  23.       success = true;
  24.       RuntimeHealthIndicator.successRequestCount++;
  25.     } catch (BusinessException e) {
  26. //      RuntimeHealthIndicator.failedRequestCount++;
  27.       if (this.isDebugLogLevel()) {
  28.         log.error(e);
  29.       }
  30.  
  31.       responseDto = new ResponseDto<>(e.getCode(), e.getMessage(), null);
  32.     } catch (Exception e) {
  33.       RuntimeHealthIndicator.failedRequestCount++;
  34.  
  35.       if (this.isDebugLogLevel()) {
  36.         log.error(e);
  37.       }
  38.  
  39.       responseDto = ResponseDto.failed(ExceptionDefinitions.ServerError, e.getMessage(), null);
  40.     } finally {
  41.       Calendar cale = Calendar.getInstance();
  42.       if (currentMonth != (cale.get(Calendar.MONTH) + 1)) {
  43.         String recodeKey = String.format("%d年%d月",
  44.             cale.get(Calendar.YEAR), cale.get(Calendar.MONTH) + 1);
  45.         String recodeValue = "successCount:" + RuntimeHealthIndicator.successRequestCount +
  46.             " failedCount:" + RuntimeHealthIndicator.failedRequestCount;
  47.         RuntimeHealthIndicator.historyRequestRecode.put(recodeKey, recodeValue);
  48.         RuntimeHealthIndicator.successRequestCount = 0;
  49.         RuntimeHealthIndicator.failedRequestCount = 0;
  50.         currentMonth = cale.get(Calendar.MONTH);
  51.       }
  52.     }
  53.  
  54.     long duration = System.currentTimeMillis() - timestamp;
  55.     RuntimeHealthIndicator.markRestApiInvoked(this.methodName, (int) duration);
  56.     this.logOut(duration, success, JSON.toJSONString(responseDto));
  57.  
  58.     return responseDto;
  59.   }
  60.  
  61.   public boolean isDebugLogLevel() {
  62.     return log.isEnabled(LogLevel.DEBUG);
  63.   }
  64. }

2.3 Health接口

  1. @Component
  2. public class RuntimeHealthIndicator extends AbstractHealthIndicator {
  3.   private static ILogger log = LoggerFactory.getLogger(ApplicationInstanceManager.class);
  4.   private static Map<String, RestApiInvokeStatus> restApiInvokeStatuses = new HashMap<>();
  5.   public static long failedRequestCount = 0;
  6.   public static long successRequestCount = 0;
  7.  
  8.   public static Map<String, Object> historyRequestRecode;
  9.   private Map<String, Object> details;
  10.  
  11.   public RuntimeHealthIndicator() {
  12.     this.details = new HashMap<>();
  13.     RuntimeHealthIndicator.historyRequestRecode = new HashMap<>();
  14.  
  15.     this.details.put("startTime", new Date(ManagementFactory.getRuntimeMXBean().getStartTime()));
  16.     this.details.put("path", RuntimeHealthIndicator.class.getClassLoader().getResource("").getPath());
  17.     this.details.put("osName", System.getProperty("os.name"));
  18.     this.details.put("osVersion", System.getProperty("os.version"));
  19.     this.details.put("javaVersion", System.getProperty("java.version"));
  20.     try {
  21.       this.details.put("ip", ZGHelper.getIpV4());
  22.     } catch (SocketException e) {
  23.       log.error(e, "Failed to get Ipv4.");
  24.     }
  25.   }
  26.  
  27.   @Override
  28.   protected void doHealthCheck(Health.Builder builder) throws Exception {
  29.  
  30.     ThreadGroup threadGroup = Thread.currentThread().getThreadGroup();
  31.     while (null != threadGroup.getParent()) {
  32.       threadGroup = threadGroup.getParent();
  33.     }
  34.     this.details.put("threadCount", threadGroup.activeCount());
  35.     OperatingSystemMXBean operatingSystemMXBean = (OperatingSystemMXBean) ManagementFactory.getOperatingSystemMXBean();
  36.     this.details.put("cpuUsageRate", operatingSystemMXBean.getSystemCpuLoad());
  37.     this.details.put(
  38.         "memoryUsageRate",
  39.         (float) (operatingSystemMXBean.getTotalPhysicalMemorySize() - operatingSystemMXBean.getFreePhysicalMemorySize()) / (float) operatingSystemMXBean.getTotalPhysicalMemorySize());
  40.     this.details.put("failedRequestCount", RuntimeHealthIndicator.failedRequestCount);
  41.     this.details.put("successRequestCount", RuntimeHealthIndicator.successRequestCount);
  42.     this.details.put("restApiInvokeStatuses", RuntimeHealthIndicator.restApiInvokeStatuses);
  43.     this.details.put("historyRequestRecode",RuntimeHealthIndicator.historyRequestRecode);
  44.  
  45.     for (Map.Entry<String, Object> detail : this.details.entrySet()) {
  46.       builder.withDetail(detail.getKey(), detail.getValue());
  47.     }
  48.     builder.up();
  49.   }
  50.  
  51.   public static void markRestApiInvoked(String name, int duration) {
  52.     if (StringUtils.isBlank(name)) {
  53.       return;
  54.     }
  55.  
  56.     if (!RuntimeHealthIndicator.restApiInvokeStatuses.containsKey(name)) {
  57.       RuntimeHealthIndicator.restApiInvokeStatuses.put(name, new RestApiInvokeStatus(name));
  58.     }
  59.  
  60.     RestApiInvokeStatus restApiInvokeStatus = RuntimeHealthIndicator.restApiInvokeStatuses.get(name);
  61.     restApiInvokeStatus.setDuration(duration);
  62.   }
  63. }

2.4 工具类

  1. public class RestApiInvokeStatus {
  2.   private String name;
  3.   private Date startDate;
  4.   private Date latestDate;
  5.   private long times;
  6.   private float averageDuration;
  7.   private int minDuration;
  8.   private int maxDuration;
  9.   private int[] durations;
  10.  
  11.   public String getName() {
  12.     return name;
  13.   }
  14.  
  15.   public Date getStartDate() {
  16.     return startDate;
  17.   }
  18.  
  19.   public Date getLatestDate() {
  20.     return latestDate;
  21.   }
  22.  
  23.   public long getTimes() {
  24.     return times;
  25.   }
  26.  
  27.   public int getMinDuration() {
  28.     return minDuration;
  29.   }
  30.  
  31.  
  32.   public int getMaxDuration() {
  33.     return maxDuration;
  34.   }
  35.  
  36.   public RestApiInvokeStatus(String name) {
  37.     Assert.isNotBlank(name, "name");
  38.  
  39.     this.name = name;
  40.     this.durations = new int[1000];
  41.     this.minDuration = Integer.MAX_VALUE;
  42.     this.maxDuration = Integer.MIN_VALUE;
  43.     Date now = new Date();
  44.     this.startDate = now;
  45.     this.latestDate = now;
  46.  
  47.   }
  48.  
  49.   public void setDuration(int duration) {
  50.     this.durations[(int) (this.times % this.durations.length)] = duration;
  51.     this.maxDuration = this.maxDuration > duration ? this.maxDuration : duration;
  52.     this.minDuration = this.minDuration < duration ? this.minDuration : duration;
  53.     this.latestDate = new Date();
  54.     this.times++;
  55.   }
  56.  
  57.   public float getAverageDuration() {
  58.     long length = this.times < this.durations.length ? this.times : this.durations.length;
  59.  
  60.     int count = 0;
  61.     for (int i = 0; i < length; i++) {
  62.       count += this.durations[i];
  63.     }
  64.     this.averageDuration = (float) count / (float) length;
  65.  
  66.     return this.averageDuration;
  67.   }
  68. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/2023面试高手/article/detail/372317
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号