在spring boot中定义自定义响应码,最直接的方式是创建一个实现`httpstatusresponse`接口的枚举类,并在`@restcontrolleradvice`中统一处理该类型异常以返回特定状态码。具体做法是定义一个包含http状态码和错误信息的枚举,当业务逻辑抛出对应异常时,全局异常处理器捕获它并构建`responseentity`,从而让接口返回如403、422等非标准或自定义的业务状态码。

如何创建支持自定义状态码的异常枚举
要实现自定义响应码,首先需要定义一个枚举类来映射业务状态与HTTP状态码。这个枚举需要实现Spring提供的`org.springframework.http.HttpStatusResponse`接口,该接口要求提供`getStatusCode()`方法。通过这种方式,可以将业务逻辑中的错误(如权限不足、参数校验失败)直接映射到标准的HTTP协议状态码上,例如使用403 Forbidden表示禁止访问,或使用422 Unprocessable Entity表示语义错误的请求。

public enum BusinessStatus implements HttpStatusResponse {
SUCCESS(200, "操作成功"),
FORBIDDEN(403, "权限不足"),
BAD_REQUEST(400, "参数错误"),
UNPROCESSABLE(422, "数据格式错误");
private final int code;
private final String message;
BusinessStatus(int code, String message) {
this.code = code;
this.message = message;
}
@Override
public HttpStatus getStatusCode() {
return HttpStatus.resolve(code);
}
public int getCode() {
return code;
}
public String getMessage() {
return message;
}
}
上述代码定义了四个常见的业务状态。`SUCCESS`对应200,`FORBIDDEN`对应403。在实际开发中,可以根据项目需求扩展更多状态。关键在于`getStatusCode()`方法的实现,它必须返回一个有效的`HttpStatus`对象,否则Spring无法正确设置响应头。
如何在控制器中抛出并使用这些状态码
定义好枚举后,需要在业务层或控制器中抛出携带这些状态的异常。通常的做法是定义一个通用的业务异常类,构造函数接收`BusinessStatus`枚举。当遇到特定条件时,实例化该异常并抛出。这样,全局异常处理器就能捕获到这个异常,并根据其中包含的状态码生成相应的HTTP响应。

public class BusinessException extends RuntimeException {
private final BusinessStatus status;
public BusinessException(BusinessStatus status) {
super(status.getMessage());
this.status = status;
}
public BusinessStatus getStatus() {
return status;
}
}
@RestController
@RequestMapping("/api")
public class UserController {
@GetMapping("/check")
public String checkPermission() {
// 模拟权限检查失败
throw new BusinessException(BusinessStatus.FORBIDDEN);
}
}
在`UserController`的`checkPermission`方法中,直接抛出了`BusinessException`,并传入了`BusinessStatus.FORBIDDEN`。这意味着当客户端调用此接口时,期望得到的是一个403状态码。接下来需要配置全局异常处理器来实际执行这一转换。
基于全局异常处理器如何统一返回JSON结构
最后一步是编写一个`@RestControllerAdvice`类,用于拦截所有由`BusinessException`引发的异常。在这个处理器中,可以统一封装返回的JSON结构,确保前端能解析到状态码、消息和数据。对于实现了`HttpStatusResponse`的异常,可以直接利用其获取状态码,并构建标准的响应体。
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(BusinessException.class)
public ResponseEntity<apiresponse> handleBusinessException(BusinessException ex) {
BusinessStatus status = ex.getStatus();
ApiResponse response = new ApiResponse(
status.getCode(),
status.getMessage(),
null
);
return ResponseEntity.status(status.getStatusCode()).body(response);
}
}
public class ApiResponse {
private int code;
private String message;
private Object data;
public ApiResponse(int code, String message, Object data) {
this.code = code;
this.message = message;
this.data = data;
}
// getters and setters
}</apiresponse>
这段代码展示了如何处理异常。`handleBusinessException`方法捕获`BusinessException`,提取其中的`BusinessStatus`,然后构建一个`ApiResponse`对象。最后,使用`ResponseEntity`将状态码设置为枚举中定义的HTTP状态(如403),并将JSON体返回。这样,无论业务逻辑多么复杂,只要抛出`BusinessException`,客户端都会收到结构一致且状态码正确的响应。











