Spring Boot REST接口开发怎么返回统一响应格式

冬涛小哥_6517

冬涛小哥_6517

2026-11-15

696人浏览

原创

在spring boot中,通过定义一个通用的响应包装类并结合全局异常处理器或拦截器,可以实现rest接口返回统一格式。具体做法是创建一个包含状态码、消息和数据字段的泛型类,并在controller层直接返回该类的实例,同时在配置类中注册全局异常处理逻辑,确保任何未捕获的异常也能转换为相同的json结构。

Spring Boot REST接口开发怎么返回统一响应格式

如何定义统一的响应数据结构

统一响应结构的核心是一个泛型类,它通常包含三个主要字段:表示操作是否成功的布尔值或状态码、描述结果的字符串信息以及实际的业务数据载体。这种设计允许前端根据状态码快速判断请求结果,并通过数据载体解析具体内容。

Spring Boot REST接口开发怎么返回统一响应格式

package com.example.demo.model;

import lombok.Data;

@Data
public class ApiResponse<t> {
    private int code;
    private String message;
    private T data;

    public static <t> ApiResponse<t> success(T data) {
        ApiResponse<t> response = new ApiResponse();
        response.setCode(200);
        response.setMessage("Success");
        response.setData(data);
        return response;
    }

    public static <t> ApiResponse<t> error(int code, String message) {
        ApiResponse<t> response = new ApiResponse();
        response.setCode(code);
        response.setMessage(message);
        response.setData(null);
        return response;
    }
}</t></t></t></t></t></t></t>

上述代码定义了ApiResponse类,使用Lombok的@Data注解自动生成Getter和Setter方法。提供了两个静态工厂方法:success用于成功场景,固定状态码为200;error用于失败场景,允许传入自定义的错误码和消息。在实际Controller中,只需调用这些方法即可返回标准JSON。

如何实现全局异常转换

为了让所有未处理的异常都自动转换为统一格式,需要实现@RestControllerAdvice。这个注解定义的类会拦截所有Controller抛出的异常,并将其封装为ApiResponse对象返回给客户端,避免暴露堆栈跟踪信息。

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

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

下载

Spring Boot REST接口开发怎么返回统一响应格式

package com.example.demo.config;

import com.example.demo.model.ApiResponse;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ApiResponse<string> handleException(Exception e) {
        // 记录日志
        System.err.println("Error: " + e.getMessage());
        return ApiResponse.error(500, "Internal Server Error: " + e.getMessage());
    }

    @ExceptionHandler(IllegalArgumentException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ApiResponse<string> handleBadRequest(IllegalArgumentException e) {
        return ApiResponse.error(400, e.getMessage());
    }
}</string></string>

这段代码展示了GlobalExceptionHandler的实现。它使用了@RestControllerAdvice来声明这是一个全局异常处理器。内部定义了两个处理方法:handleException捕获所有通用异常,返回500错误;handleBadRequest专门处理参数校验失败的异常,返回400错误。每个方法都返回ApiResponse实例,确保了响应格式的一致性。

当业务逻辑抛出特定异常时如何处理

在实际开发中,除了系统级异常,还经常遇到业务级别的异常,例如用户不存在或权限不足。此时可以在GlobalExceptionHandler中添加针对自定义业务异常的处理器,以便返回更精确的业务错误码。

package com.example.demo.exception;

public class UserNotFoundException extends RuntimeException {
    public UserNotFoundException(String message) {
        super(message);
    }
}

// 在 GlobalExceptionHandler 中添加:
@ExceptionHandler(UserNotFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
public ApiResponse<string> handleUserNotFound(UserNotFoundException e) {
    return ApiResponse.error(404, e.getMessage());
}</string>

首先定义了一个继承自RuntimeException的UserNotFoundException。然后在GlobalExceptionHandler中增加对应的@ExceptionHandler方法。当Controller中抛出UserNotFoundException时,Spring会自动匹配到这个处理器,并返回包含404状态码和具体错误信息的统一响应。这种方式使得错误处理更加模块化和清晰。

相关文章

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

12637

6

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

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

2023.07.05

9742

9

java自学难吗
java自学难吗

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

2023.07.31

8272

8

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

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

2023.08.01

1324

3

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

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

2023.08.02

1048

3

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

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

2023.08.02

1576

5

java有什么用
java有什么用

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

2023.08.02

3309

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人学习