Spring Boot 优雅实现统一数据返回格式+统一异常处理+统一日志处理

在现代企业级应用中，我们通常需要处理大量的请求和响应，因此设计良好的统一数据返回格式、异常处理和日志记录机制显得尤为重要。使用 Spring Boot，我们可以优雅地实现这一系列功能。本文将介绍如何在 Spring Boot 项目中实现统一的数据返回格式、异常处理以及日志记录。

一、统一数据返回格式

首先，我们可以设计一个通用的响应类来表示返回的数据结构。

public class ApiResponse<T> {
    private String message; // 消息
    private boolean success; // 是否成功
    private T data; // 返回的数据

    public ApiResponse(String message, boolean success, T data) {
        this.message = message;
        this.success = success;
        this.data = data;
    }

    // Getter 和 Setter 省略
}

在我们的 Controller 中，我们就可以使用这个 ApiResponse 作为返回类型。

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

    @GetMapping("/users")
    public ApiResponse<List<User>> getUsers() {
        List<User> users = userService.getAllUsers();
        return new ApiResponse<>("成功", true, users);
    }
}

二、统一异常处理

为了优雅地处理异常，我们可以使用 @ControllerAdvice 注解来定义一个全局异常处理类。这样可以集中处理所有 Controller 抛出的异常。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ApiResponse<String>> handleException(Exception e) {
        // 记录异常日志
        LoggerFactory.getLogger(this.getClass()).error("系统异常: ", e);

        ApiResponse<String> response = new ApiResponse<>("系统错误", false, null);
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<ApiResponse<String>> handleUserNotFoundException(UserNotFoundException e) {
        ApiResponse<String> response = new ApiResponse<>(e.getMessage(), false, null);
        return new ResponseEntity<>(response, HttpStatus.NOT_FOUND);
    }
}

在上面的代码中，我们定义了两个异常处理方法。一个是通用的异常处理方法，另一个是专门处理用户未找到异常的方法。通过这种方式，我们可以确保返回统一的错误响应格式。

三、统一日志处理

在 Spring Boot 应用中，我们通常使用 SLF4J 和 Logback 进行日志记录。为了统一日志记录，我们可以自定义一个切面来拦截所有的请求并记录日志。

@Aspect
@Component
public class LoggingAspect {

    private final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Before("execution(* com.example.controller..*(..))")
    public void logBefore(JoinPoint joinPoint) {
        logger.info("请求方法: {}  参数: {}", joinPoint.getSignature().getName(), Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(pointcut = "execution(* com.example.controller..*(..))", returning = "result")
    public void logAfterReturning(JoinPoint joinPoint, Object result) {
        logger.info("方法: {} 返回: {}", joinPoint.getSignature().getName(), result);
    }
}

以上代码通过 AOP 切面记录了进入 Controller 方法的请求参数和返回结果。在此基础上，我们还可以添加更多的日志记录功能，比如记录执行时间、异常信息等。

总结

通过上述方式，我们在 Spring Boot 项目中实现了统一的数据返回格式、异常处理和日志记录机制。这种设计不仅提高了代码的可维护性与可读性，也保证了在系统出现异常时，我们能迅速定位问题并返回友好的用户信息。希望本文能够帮助你在项目中更好地实践这些技巧。