Spring Boot REST接口开发怎么定义自定义响应码

冬强姑娘_4883

冬强姑娘_4883

2026-11-16

466人浏览

原创

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

Spring Boot REST接口开发怎么定义自定义响应码

如何创建支持自定义状态码的异常枚举

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

Spring Boot REST接口开发怎么定义自定义响应码

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响应。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

Spring Boot REST接口开发怎么定义自定义响应码

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`,客户端都会收到结构一致且状态码正确的响应。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12717

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9802

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

8332

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1344

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1068

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1596

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3329

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20551

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1435

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习