使用Spring的拦截器监测每个Controller或方法的执行时长

在Spring中，我们可以使用拦截器来监测每个Controller或方法的执行时长。拦截器是一种AOP（面向切面编程）技术，它可以在方法执行前、执行后或抛出异常时执行一些操作。本文将详细讲解如何使用Spring的拦截器监测每个Controller或方法的执行时长。

1. 创建拦截器

首先，我们需要创建一个拦截器。拦截器需要实现HandlerInterceptor接口，并实现其中的preHandle、postHandle和afterCompletion方法。在preHandle方法中，我们可以记录方法开始执行的时间；在postHandle方法中，我们可以记录方法执行结束的时间；在afterCompletion方法中，我们可以计算方法执行的时间，并将它记录到日志中。

下面是一个示例，演示了如何创建一个拦截器：

public class ExecutionTimeInterceptor implements HandlerInterceptor {

  private static final Logger logger = LoggerFactory.getLogger(ExecutionTimeInterceptor.class);

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    request.setAttribute("startTime", System.currentTimeMillis());
    return true;
  }

  @Override
  public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    long startTime = (long) request.getAttribute("startTime");
    long endTime = System.currentTimeMillis();
    long executionTime = endTime - startTime;
    logger.info("{} executed in {} ms", handler, executionTime);
  }

  @Override
  public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    // Do nothing
  }
}

在上面的代码中，我们创建了一个ExecutionTimeInterceptor拦截器。在preHandle方法中，我们记录了方法开始执行的时间，并将它保存在HttpServletRequest对象中。在postHandle方法中，我们计算了方法执行的时间，并将它记录到日志中。在afterCompletion方法中，我们没有执行任何操作。

2. 注册拦截器

接下来，我们需要将拦截器注册到Spring中。我们可以通过实现WebMvcConfigurer接口，并重写addInterceptors方法来注册拦截器。

下面是一个示例，演示了如何将ExecutionTimeInterceptor拦截器注册到Spring中：

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  @Autowired
  private ExecutionTimeInterceptor executionTimeInterceptor;

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(executionTimeInterceptor);
  }
}

在上面的代码中，我们创建了一个WebMvcConfig类，并实现了WebMvcConfigurer接口。在addInterceptors方法中，我们将ExecutionTimeInterceptor拦截器注册到了InterceptorRegistry中。

3. 示例说明

下面是两个示例，演示了如何使用ExecutionTimeInterceptor拦截器监测每个Controller或方法的执行时长：

3.1 示例一：监测UserController中的方法执行时长

@RestController
@RequestMapping("/users")
public class UserController {

  @Autowired
  private UserService userService;

  @GetMapping("/{id}")
  public User getUserById(@PathVariable Long id) {
    return userService.getUserById(id);
  }

  @PostMapping("/")
  public User addUser(@RequestBody User user) {
    return userService.addUser(user);
  }
}

在上面的代码中，我们创建了一个UserController类，并定义了两个方法：getUserById和addUser。我们可以在WebMvcConfig中将ExecutionTimeInterceptor拦截器注册到Spring中，然后使用浏览器或Postman等工具访问这些方法，观察它们的执行时长是否被记录到了日志中。

3.2 示例二：监测ProductController中的方法执行时长

@RestController
@RequestMapping("/products")
public class ProductController {

  @Autowired
  private ProductService productService;

  @GetMapping("/{id}")
  public Product getProductById(@PathVariable Integer id) {
    return productService.getProductById(id);
  }

  @PostMapping("/")
  public Product addProduct(@RequestBody Product product) {
    return productService.addProduct(product);
  }
}

在上面的代码中，我们创建了一个ProductController类，并定义了两个方法：getProductById和addProduct。我们可以在WebMvcConfig中将ExecutionTimeInterceptor拦截器注册到Spring中，然后使用浏览器或Postman等工具访问这些方法，观察它们的执行时长是否被记录到了日志中。

4. 注意事项

在使用ExecutionTimeInterceptor拦截器监测每个Controller或方法的执行时长时，需要注意以下几点：

• 拦截器只能监测到Controller或方法的执行时长，无法监测到方法内部的执行时长。
• 记录日志时，需要使用Logger对象，避免使用System.out.println等控制台输出方式。
• 在使用拦截器时，需要注意拦截器的执行顺序。如果有多个拦截器，需要按照正确的顺序注册它们。