springBoot - 使用Aop统计方法时间

子笙—望舒

已于 2024-05-08 17:12:42 修改

阅读量69

点赞数

分类专栏： springBoot整合文章标签： spring boot 后端 java

于 2024-05-08 17:12:10 首次发布

原文链接：https://codeease.top/blog/pages/755785/#_3-4-%E8%87%AA%E5%AE%9A%E4%B9%89%E4%B8%80%E4%B8%AA%E6%B3%A8%E8%A7%A3

版权

springBoot整合专栏收录该内容

3 篇文章 0 订阅

订阅专栏

一、前言

想知道整个系统前端和后端所有方法的执行时间。是的你没有听错，是每个方法。这个需求一提出来就被整蒙了，给每个方法计算执行时间，这不是平白给系统压力吗？

二、思路

既然提了，先给思路吧。其实很简单，每个方法执行前记录一个时间戳，执行结束后记录一个时间戳，相减就是执行时间。但是去每个方法里改是不现实的，那么多代码，如果去侵入那工作量也太大了，而且如果有一天项目经理又不要这个功能了呢？

一听到这个需求，就应该想到AOP，用了那么久的Spring，IOC、AOP背的滚瓜烂熟，现在就是应用的时候了。

三、使用AOP记录时间

AOP的概念就不在这里提了，面向切面，无侵入开发，正适合这个需求。而且20行代码可以解决问题。

3.1 引入Aop依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

3.2 配置切点

首先配置一个切入点，我这里要让切面在TestController这个类中的所有方法上生效


import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

@Slf4j
@Component
@Aspect
@Order(10)
public class LogAspect {

    //配置切入点，即执行的位置
    @Pointcut("execution(* com.example.springbootstatistictime.demos.web.TestController.*(..))")
    public void pointCut() {
    }

    //使用环绕通知，在方法的执行前后分别记录一个时间相减
    @Around("pointCut()")
    public Object doLog(ProceedingJoinPoint proceedingJoinPoint) {
        long startTime = System.currentTimeMillis();
        Object object = null;
        try {
            object = proceedingJoinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        } finally {
            long endTime = System.currentTimeMillis();
            log.info(proceedingJoinPoint.getSignature().toShortString() + "方法执行了：" + (endTime - startTime) + "ms");
        }
        return object;
    }
}

3.3 编写测试方法

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testApi")
public class TestController {

    @GetMapping("/test1")
    public String testAop(){
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return "testAop";
    }
}

3.4 结果

启动springBoot,使用postman调用（http://127.0.0.1:8080/testApi/test1）得到结果

四、自定义注解 + Aop 记录时间

现在已经可以满足项目经理的需求了，如果以后新的代码没有在切入点的范围内，就又不生效了，因此在以上代码的基础上做出改变，定义一个注解，要记录时直接写个注解。