使用Spring Boot添加接口耗时统计

本文将介绍在Spring Boot应用中添加接口耗时统计的方法，并提供相应的代码示例。

一、基本知识

在Web应用中，接口耗时是一个非常重要的指标。对于服务端接口而言，响应时间越短，用户就能越快地获得结果，从而提高了用户体验。 Spring Boot作为一个流行的Java Web应用框架，为我们提供了一些工具来方便地记录接口的响应时间。

二、添加接口耗时统计

为了添加接口耗时统计，我们需要做以下几个步骤：

添加@Aspect注解的切面类
使用@Around注解，记录接口开始和结束时间，计算接口耗时

首先，添加一个名为TimeAspect的切面类，用于记录接口耗时。

@Aspect
@Component
public class TimeAspect {

  @Around("execution(* com.example.demo.controller.*.*(..))") // 切面拦截规则，这里拦截所有controller中的方法
  public Object around(ProceedingJoinPoint point) throws Throwable {
    long beginTime = System.currentTimeMillis();
    Object result = point.proceed(); // 调用目标方法
    long endTime = System.currentTimeMillis();
    long time = endTime - beginTime;

    HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
        .getRequest();
    String uri = request.getRequestURI();
    String method = request.getMethod();

    System.out.println(String.format("[接口耗时统计] URI: %s;n方法: %s;n耗时: %dms.", uri, method, time));
    return result;
  }
}

我们在这个切面中使用了@Around注解，代表着需要切入目标方法进行耗时计算。同时，我们使用了System.currentTimeMillis()方法记录接口的开始和结束时间，并输出了接口的URI、方法和耗时。通过这个方式，我们就能快速地统计接口的响应时间。

三、在Spring Boot应用中使用切面类

为了在Spring Boot应用中使用这个切面类，我们需要在主类中添加@EnableAspectJAutoProxy注解。

@SpringBootApplication
@EnableAspectJAutoProxy // 必须加上这个注解才能使用切面类
public class DemoApplication {

  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }

}

这样，在Spring Boot应用启动的时候，Spring框架就会对所有的切面类进行扫描，从而识别并使用TimeAspect类。

四、测试接口

为了测试这段代码，我们可以添加一个简单的Controller类，用于输出一段字符串。

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

  @GetMapping("/hello")
  public String hello() throws Exception {
    Thread.sleep(1000);
    return "world";
  }
}

当我们访问http://localhost:8080/test/hello这个接口时，控制台会输出如下信息：

[接口耗时统计] URI: /test/hello;
方法: GET;
耗时: 1001ms.

这表示这个接口的耗时为1.001秒，成功地统计了接口的响应时间。

五、总结

本文介绍了在Spring Boot应用中添加接口耗时统计的方法。通过使用切面类，我们可以方便地记录接口的开始和结束时间，计算出接口的耗时，并进行统计。