Spring Boot应用中实现统一的响应格式与异常管理-51CTO.COM

在构建Spring Boot应用时，为了提升用户体验和维护性，实施统一的响应格式和全局异常管理是非常必要的。本文将详细阐述如何通过自定义类和注解来实现这一目标，并提供相应的示例代码。

1. 定义统一响应格式

首先，我们需要定义一个通用的响应类来封装所有HTTP响应。这个类将包含状态码、消息以及响应数据。

public class ApiResponse<T> {
    private int code;
    private String message;
    private T data;

    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // Getter和Setter省略

    // 提供静态方法生成成功和失败的响应
    public static <T> ApiResponse<T> success(T data) {
        return new ApiResponse<>(200, "操作成功", data);
    }

    public static <T> ApiResponse<T> failure(String message) {
        return new ApiResponse<>(500, message, null);
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.

2. 实现全局异常处理

接下来，我们将创建一个全局异常处理器来捕获并处理应用中的所有异常。通过使用@ControllerAdvice注解，我们可以捕获到所有控制器抛出的异常。

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    public ResponseEntity<ApiResponse<String>> handleException(Exception e) {
        // 在这里可以记录日志、发送警报等操作
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(ApiResponse.failure(e.getMessage()));
    }

    // 可以针对特定异常进行更详细的处理
    @ExceptionHandler(value = ResourceNotFoundException.class)
    public ResponseEntity<ApiResponse<String>> handleResourceNotFoundException(ResourceNotFoundException e) {
        return ResponseEntity.notFound().body(ApiResponse.failure(e.getMessage()));
    }
}

// 自定义异常类示例
public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.

3. 控制器示例

现在，在控制器中，我们可以直接返回ApiResponse对象，而不必担心响应格式的问题。同时，当发生异常时，全局异常处理器会自动捕获并处理这些异常。

@RestController
@RequestMapping("/api/data")
public class DataController {

    @GetMapping("/{id}")
    public ResponseEntity<ApiResponse<String>> getDataById(@PathVariable String id) {
        // 假设这里根据id查找数据，可能抛出ResourceNotFoundException
        if ("invalid".equals(id)) {
            throw new ResourceNotFoundException("未找到对应的数据");
        }
        return ResponseEntity.ok(ApiResponse.success("找到了数据: " + id));
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

4. 测试

现在，启动Spring Boot应用并尝试访问/api/data/valid和/api/data/invalid两个端点，观察响应的不同。对于有效的ID，你应该会看到一个成功的响应；而对于无效的ID，你应该会看到一个包含错误信息的响应。

通过实施统一的响应格式和全局异常管理，我们不仅能提升用户体验，还能使应用的错误处理更加集中和一致。这种方式有助于降低代码的冗余度，并提高应用的可维护性。