解决Springboot全局异常处理与AOP日志处理中@AfterThrowing失效问题

解决Spring Boot全局异常处理与AOP日志处理中@AfterThrowing失效问题

问题描述

在使用Spring Boot开发项目时，常常会遇到全局异常处理和AOP日志处理的场景。然而，在这两个场景结合使用时，我们会发现@AfterThrowing注解无法捕获到全局异常，导致无法执行对应的日志处理逻辑。

解决方案

为了解决这个问题，我们需要进行如下的处理：

第一步：自定义全局异常处理类

首先，我们需要创建一个自定义的全局异常处理类，用于捕获和处理项目中的异常。我们可以继承Spring Boot提供的ResponseEntityExceptionHandler类，该类是Spring Boot内置的异常处理类，非常方便且强大。

@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Object> handleGlobalException(Exception ex, WebRequest request) {
        // 全局异常处理逻辑
        // 可以进行日志记录、返回自定义的错误信息等
        return super.handleException(ex, request);
    }
}

第二步：使用AOP切面处理日志

接下来，我们可以使用AOP的方式来处理日志。通过自定义的切面类，我们可以在Controller或Service层的方法执行前后，以及抛出异常时进行对应的日志记录等处理。

@Aspect
@Component
public class LoggingAspect {

    @Before("execution(* com.example.demo.controller.*.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        // 方法执行前的逻辑处理
        // 可以记录方法的入参、请求URL等信息
        // 这里只是示例，可以根据实际需求进行定制
        System.out.println("Before method execution");
    }

    @AfterThrowing(pointcut = "execution(* com.example.demo.controller.*.*(..))", throwing = "ex")
    public void logAfterThrowing(JoinPoint joinPoint, Throwable ex) {
        // 方法抛出异常时的处理逻辑
        // 可以记录异常信息、请求参数等
        // 这里只是示例，可以根据实际需求进行定制
        System.out.println("Exception thrown: " + ex.getMessage());
    }
}

示例说明

为了更好地理解上述解决方案，我们将通过两个示例来说明其使用方法和效果。

示例一：全局异常处理

假设我们的项目中有一个名为UserController的Controller类，其中定义了一个用于查询用户信息的方法getUser。

@RestController
public class UserController {

    @GetMapping("/user/{id}")
    public User getUser(@PathVariable Long id) {
        if (id == 1) {
            throw new RuntimeException("User not found");
        }
        // 查询用户逻辑...
        return user;
    }
}

如果我们在GlobalExceptionHandler类中添加日志记录逻辑，如打印错误信息到控制台：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Object> handleGlobalException(Exception ex, WebRequest request) {
        // 记录错误信息到控制台
        System.out.println(ex.getMessage());
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

当我们请求/user/1时，会触发全局异常处理，打印错误信息到控制台，并返回自定义的错误信息给前端。

示例二：AOP日志处理

在上述示例一的基础上，我们针对UserController中的方法添加AOP日志处理的逻辑。

@Aspect
@Component
public class LoggingAspect {

    @Before("execution(* com.example.demo.controller.*.*(..))")
    public void logBefore(JoinPoint joinPoint) {
        // 方法执行前的逻辑处理
        // 记录方法的入参、请求URL等信息
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        String methodName = method.getName();
        System.out.println("Before method execution: " + methodName);
    }

    @AfterThrowing(pointcut = "execution(* com.example.demo.controller.*.*(..))", throwing = "ex")
    public void logAfterThrowing(JoinPoint joinPoint, Throwable ex) {
        // 方法抛出异常时的处理逻辑
        // 记录异常信息、请求参数等
        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        String methodName = method.getName();
        System.out.println("Exception thrown in method: " + methodName);
        System.out.println("Exception message: " + ex.getMessage());
    }
}

当我们请求/user/1时，会触发AOP日志处理，打印方法的名称和异常信息到控制台。

总结

通过自定义全局异常处理类和使用AOP切面处理日志的方式，我们可以很好地解决Spring Boot全局异常处理与AOP日志处理中@AfterThrowing失效的问题。这样可以使我们的代码更加规范、易于维护，并且能够实现统一的异常处理和日志记录。