当使用Spring Boot构建应用程序时,可以通过自定义异常处理器来处理应用程序中的统一异常。下面是一个简单的示例,展示了如何在Spring Boot应用程序中实现统一异常处理。
步骤1:创建自定义异常类
首先,需要创建一个自定义的异常类,用于表示应用程序中可能发生的各种异常情况。可以根据实际需要定义不同的异常类。
public class CustomException extends RuntimeException {
private String errorCode;
private String errorMessage;
public CustomException(String errorCode, String errorMessage) {
this.errorCode = errorCode;
this.errorMessage = errorMessage;
}
// getter and setter methods
}
步骤2:创建自定义异常处理器
接下来,需要创建一个自定义的异常处理器,用于捕获并处理应用程序中抛出的异常。可以使用@ControllerAdvice
和@ExceptionHandler
注解来创建全局异常处理器。
@ControllerAdvice
public class CustomExceptionHandler {
@ExceptionHandler(CustomException.class)
public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
ErrorResponse errorResponse = new ErrorResponse(ex.getErrorCode(), ex.getErrorMessage());
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
@ExceptionHandler(Exception.class)
public ResponseEntity<ErrorResponse> handleGenericException(Exception ex) {
ErrorResponse errorResponse = new ErrorResponse("500", "Internal Server Error");
return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
}
在上面的示例中,handleCustomException
方法用于处理自定义异常CustomException
,并返回一个包含错误信息的ErrorResponse
对象。handleGenericException
方法用于处理其他类型的异常,比如未捕获的异常。
步骤3:创建错误响应类
需要创建一个用于封装错误响应信息的类。
public class ErrorResponse {
private String errorCode;
private String errorMessage;
public ErrorResponse(String errorCode, String errorMessage) {
this.errorCode = errorCode;
this.errorMessage = errorMessage;
}
// getter and setter methods
}
步骤4:测试异常处理
现在可以在应用程序中抛出自定义异常,并验证异常处理是否按预期工作。
@RestController
public class ExampleController {
@GetMapping("/example")
public void example() {
throw new CustomException("400", "Bad Request");
}
}
在上面的示例中,当访问/example
路径时,会抛出CustomException
异常,然后由异常处理器捕获并返回错误响应。