Java实现的微服务异常处理与错误码管理组件

统一的错误码管理为了方便异常的处理和错误信息的统一管理，我们可以定义一个枚举类型ErrorCode，其中包含了系统可能遇到的错误码和对应的错误信息。每个错误码都可以有一个唯一的整数值和错误描述，例如：

public enum ErrorCode {
SUCCESS(0, "success"),
INVALID_PARAMETER(1001, "invalid parameter"),
DATABASE_ERROR(2001, "database error"),
...

private int code;
private String message;

ErrorCode(int code, String message) {
this.code = code;
this.message = message;
}

public int getCode() {
return code;
}

public String getMessage() {
return message;
}
}

登录后复制

统一的异常处理在微服务中，我们可以使用全局异常处理器统一处理所有的业务异常，并返回统一的错误响应。可以通过@ControllerAdvice注解来定义全局异常处理器。例如：

@ControllerAdvice
public class GlobalExceptionHandler {

@ExceptionHandler(ServiceException.class)
@ResponseBody
public ResponseEntity handleServiceException(ServiceException ex) {
ErrorCode errorCode = ex.getErrorCode();
ErrorResponse errorResponse = new ErrorResponse(errorCode.getCode(), errorCode.getMessage());
return new ResponseEntity(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}

@ExceptionHandler(Exception.class)
@ResponseBody
public ResponseEntity handleException(Exception ex) {
ErrorResponse errorResponse = new ErrorResponse(ErrorCode.INTERNAL_ERROR.getCode(), ex.getMessage());
return new ResponseEntity(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
}
}

登录后复制

定义异常处理方法组件可以提供一个ExceptionHandler类，其中包含了一系列的静态方法，用于抛出指定错误码的异常。例如：

public class ExceptionHandler {

public static void throwInvalidParameterException() {
throw new ServiceException(ErrorCode.INVALID_PARAMETER);
}

public static void throwDatabaseErrorException() {
throw new ServiceException(ErrorCode.DATABASE_ERROR);
}

...
}

登录后复制

获取错误码和错误信息组件可以提供一个ErrorCodeManager类，其中包含了一系列的静态方法，用于根据错误码获取错误信息。例如：

public class ErrorCodeManager {

public static String getMessage(int code) {
for (ErrorCode errorCode : ErrorCode.values()) {
if (errorCode.getCode() == code) {
return errorCode.getMessage();
}
}
return "unknown error";
}
}

登录后复制

定义异常类

public class InvalidParameterException extends ServiceException {

public InvalidParameterException() {
super(ErrorCode.INVALID_PARAMETER);
}
}

登录后复制

在注册接口中使用异常处理

@RestController
public class UserController {

@PostMapping("/register")
public ResponseEntity register(@RequestBody UserRegisterRequest request) throws InvalidParameterException {
if (StringUtils.isBlank(request.getUsername())) {
ExceptionHandler.throwInvalidParameterException();
}
// 注册逻辑...
return new ResponseEntity("success", HttpStatus.OK);
}
}

登录后复制

全局异常处理

@ControllerAdvice
public class GlobalExceptionHandler {

@ExceptionHandler(InvalidParameterException.class)
@ResponseBody
public ResponseEntity handleInvalidParameterException(InvalidParameterException ex) {
ErrorResponse errorResponse = new ErrorResponse(ex.getErrorCode().getCode(), ex.getErrorCode().getMessage());
return new ResponseEntity(errorResponse, HttpStatus.BAD_REQUEST);
}
}

登录后复制