Java自定义枚举状态码、全局异常处理

在Java开发中，枚举（Enum）是一种非常有用的特性，可以用来表示一组固定的常量。当我们需要定义一些状态码、错误码等时，使用枚举类型可以使代码更具可读性和可维护性。结合全局异常处理机制，可以有效地提高代码的健壮性。本文将介绍如何自定义枚举状态码，并结合Spring Boot实现全局异常处理。

自定义枚举状态码

首先，我们定义一个枚举类，用于表示不同的状态码和提示信息。下面是一个示例：

public enum ResponseCode {
    SUCCESS(200, "操作成功"),
    BAD_REQUEST(400, "请求参数错误"),
    UNAUTHORIZED(401, "未授权"),
    FORBIDDEN(403, "禁止访问"),
    NOT_FOUND(404, "资源未找到"),
    INTERNAL_SERVER_ERROR(500, "服务器内部错误");

    private final int code;
    private final String message;

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

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

在这个枚举类中，我们定义了多个常见的响应状态，包括状态码和对应的消息。这使得在处理HTTP请求时，我们可以更方便地使用这些状态码。

全局异常处理

接下来，我们将实现一个全局异常处理机制。使用Spring Boot，我们可以通过@ControllerAdvice注解来定义一个全局异常处理器。通过这个处理器，我们可以捕获项目中的异常，并返回统一的响应格式。

下面是一个全局异常处理器的示例：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ResponseEntity<Object> handleGenericException(Exception e) {
        return ResponseEntity
                .status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body(new ApiResponse(ResponseCode.INTERNAL_SERVER_ERROR.getCode(), ResponseCode.INTERNAL_SERVER_ERROR.getMessage(), e.getMessage()));
    }

    @ExceptionHandler(IllegalArgumentException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<Object> handleIllegalArgumentException(IllegalArgumentException e) {
        return ResponseEntity
                .status(HttpStatus.BAD_REQUEST)
                .body(new ApiResponse(ResponseCode.BAD_REQUEST.getCode(), ResponseCode.BAD_REQUEST.getMessage(), e.getMessage()));
    }

    // 可以根据需求定义更多的异常处理方法
}

在这个示例中，我们定义了两个异常处理方法，分别用于处理所有异常和非法参数异常。每个方法都返回一个ResponseEntity，其中包含了状态码、消息和异常细节。

定义统一的响应格式

为了确保API返回的格式统一，我们可以定义一个统一的响应类。下面是一个简单的示例：

public class ApiResponse {
    private int code;
    private String message;
    private String detail;

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

    // getters 和 setters
}

测试使用

在控制器中，我们可以使用自定义的状态码和异常处理。例如：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @GetMapping("/test")
    public String test(@RequestParam(value = "param", required = false) String param) {
        if (param == null) {
            throw new IllegalArgumentException("参数不能为空");
        }
        return "参数值：" + param;
    }
}

通过上面的示例，我们可以看到如何在项目中结合自定义的枚举状态码和全局异常处理机制，创建一个更加健壮和易于维护的项目结构。当发生异常时，用户可以得到清晰的错误信息和状态码，便于快速定位问题。

综上所述，自定义枚举状态码配合全局异常处理是Java开发中提高代码可读性和可维护性的有效手段。在实际应用中，我们可以根据项目需求灵活扩展和完善。