Java API接口错误码怎么处理

在Java API接口中，错误码是用来表示接口调用过程中可能出现的各种错误情况的一种机制。处理错误码通常涉及以下几个步骤：

1. 定义错误码：

   • 在API文档中明确列出所有可能的错误码及其含义。
   • 可以使用枚举（enum）来定义错误码，这样代码更清晰且易于维护。

   public enum ErrorCode {
       SUCCESS(0, "操作成功"),
       INVALID_REQUEST(400, "无效的请求"),
       UNAUTHORIZED(401, "未授权"),
       FORBIDDEN(403, "禁止访问"),
       NOT_FOUND(404, "资源未找到"),
       INTERNAL_SERVER_ERROR(500, "服务器内部错误");
   
       private final int code;
       private final String message;
   
       ErrorCode(int code, String message) {
           this.code = code;
           this.message = message;
       }
   
       public int getCode() {
           return code;
       }
   
       public String getMessage() {
           return message;
       }
   }
   

2. 抛出异常：

   • 当接口遇到错误时，抛出自定义异常，并在异常中包含错误码和错误信息。

   public class ApiException extends RuntimeException {
       private final ErrorCode errorCode;
   
       public ApiException(ErrorCode errorCode) {
           super(errorCode.getMessage());
           this.errorCode = errorCode;
       }
   
       public ApiException(ErrorCode errorCode, String message) {
           super(message);
           this.errorCode = errorCode;
       }
   
       public ErrorCode getErrorCode() {
           return errorCode;
       }
   }
   

3. 处理异常：

   • 在控制器层（Controller）或服务层（Service）中捕获异常，并根据错误码返回相应的HTTP状态码和错误信息。

   @RestControllerAdvice
   public class GlobalExceptionHandler {
   
       @ExceptionHandler(ApiException.class)
       public ResponseEntity<ErrorResponse> handleApiException(ApiException e) {
           ErrorResponse errorResponse = new ErrorResponse(e.getErrorCode().getCode(), e.getMessage());
           return new ResponseEntity<>(errorResponse, HttpStatus.valueOf(e.getErrorCode().getCode()));
       }
   
       @ExceptionHandler(Exception.class)
       public ResponseEntity<ErrorResponse> handleGenericException(Exception e) {
           ErrorResponse errorResponse = new ErrorResponse(ErrorCode.INTERNAL_SERVER_ERROR.getCode(), "服务器内部错误");
           return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
       }
   }
   

4. 定义错误响应类：

   • 创建一个错误响应类，用于封装错误码和错误信息。

   public class ErrorResponse {
       private int code;
       private String message;
   
       public ErrorResponse(int code, String message) {
           this.code = code;
           this.message = message;
       }
   
       // Getters and setters
   }
   

5. 在业务逻辑中使用：

   • 在业务逻辑中，当遇到错误情况时，抛出相应的ApiException。

   public class UserService {
       public User getUserById(Long id) {
           User user = userRepository.findById(id);
           if (user == null) {
               throw new ApiException(ErrorCode.NOT_FOUND);
           }
           return user;
       }
   }
   

通过以上步骤，你可以有效地处理Java API接口中的错误码，提供清晰的错误信息和适当的HTTP状态码，从而提高API的可用性和可维护性。