Springboot 3封装统一返回结果+全局异常处理

最新推荐文章于 2024-07-19 23:53:29 发布
最新推荐文章于 2024-07-19 23:53:29 发布
阅读量1.2k 收藏 16
点赞数 27
分类专栏： 合集 - Java学习笔记 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zzm_0525/article/details/140369103
版权

文章目录

前言

统一结果封装可以带来以下几个好处：

  • 提高一致性：所有API接口返回的数据格式一致，方便前端处理和展示
  • 易于调试：统一的响应格式便于日志记录和错误追踪
  • 增强安全性：可以在统一封装过程中对响应数据进行过滤和处理，避免敏感信息泄露
  • 便于扩展：统一的响应格式有助于在项目扩展时保持代码的可维护性
{
    "code": "code value",
    "status": true or false,
    "message": "message value",
    "data": {}
}

这种返回格式主要包含四部分：

  1. code：状态码，由后端统一定义各种返回结果的状态码
  2. status：状态信息，用于标识请求是否成功
  3. message：返回信息，向客户端传递处理结果的描述
  4. data：实际数据，包含业务处理的具体结果

我们返回的信息至少包括code、message、data三部分，其中code是我们后端和前端约定好的状态码，message为返回信息，data为返回的实际数据，没有返回数据则为null。除了这三部分外，你还可以定义一些其他字段，比如状态信息status，请求时间timestamp

一、统一结果集处理器

1. 自定义常用结果枚举类

  • 在utils包下新建enums包，其中新建HttpCodeEnum文件，在这里我们需要定义一个状态码的枚举类，不同的状态码对应不同的描述信息，如下：
/**
 * <p>
 * 常用结果枚举类
 * </p>
 *
 * @author Patrick
 * @since 2024-07-02
 */
@Getter
public enum HttpCodeEnum {

    //==================== 登录相关枚举 ======================
    /**
     * 登陆超时
     */
    RC100(100, "登陆超时!"),

    /**
     * 用户未登录
     */
    RC101(101, "用户未登录,请先进行登录!"),

    /**
     * 账户被禁用，请联系管理员解决
     */
    RC102(102, "账户被禁用,请联系管理员解决!"),

    /**
     * 用户信息加载失败
     */
    RC103(103, "用户信息加载失败!"),

    /**
     * 用户身份信息获取失败
     */
    RC104(104, "用户身份信息获取失败!"),

    /**
     * 用户名不能为空
     */
    RC105(105, "用户名不能为空!"),

    /**
     * 密码不能为空
     */
    RC106(106, "密码不能为空!"),

    /**
     * 用户名或密码错误
     */
    RC107(107, "用户名或密码错误!"),

    /**
     * 用户登录成功
     */
    RC108(108, "用户登录成功!"),

    /**
     * 用户注销成功
     */
    RC109(109, "用户注销成功!"),

    //==================== 注册相关枚举 ======================

    /**
     * 验证码错误
     */
    RC300(300, "验证码错误!"),

    /**
     * 验证码过期
     */
    RC301(301, "验证码已过期!"),

    /**
     * 用户名已存在
     */
    RC302(302, "用户名已存在!"),

    //======================= 其他枚举 ==============================

    /**
     * 参数格式不合法
     */
    RC400(400, "参数格式不合法,请检查后重试!"),
    
    /**
     * 没有权限
     */
    RC403(403, "您没有操作权限!"),

    /**
     * 页面不存在
     */
    RC404(404, "未找到您请求的资源!"),

    /**
     * 请求方式错误
     */
    RC405(405, "请求方式错误,请检查后重试!"),

    /**
     * 操作成功
     */
    SUCCESS(200, "操作成功!"),

    /**
     * 操作失败
     */
    ERROR(500, "操作失败!"),

    /**
     * 未知异常
     */
    RC600(600, "服务器繁忙或服务器错误,请稍后再试!");

    // 响应状态码
    private final Integer code;

    // 响应返回信息
    private final String message;

    HttpCodeEnum(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

}

该枚举类为我们和前端约定好的返回状态码和描述信息，可根据自己的需求修改状态码和返回信息

2. 自定义统一返回格式

  • 在utils包下新建JsonResult文件，在这里我们定义一个统一返回结果的处理类：
/**
 * <p>
 * 统一结果集处理类
 * </p>
 *
 * @author Patrick
 * @since 2024-07-02
 */
@Data
public class JsonResult {

    @Schema(description = "状态码")
    private Integer code;

    @Schema(description = "状态信息")
    private Boolean status;

    @Schema(description = "返回信息")
    private String message;

    @Schema(description = "数据")
    private Map<String, Object> data = new HashMap<>();

    /**
     * 请求成功
     *
     * @return success
     */
    public static JsonResult success() {
        JsonResult result = new JsonResult();
        result.setStatus(true);
        result.setCode(HttpCodeEnum.SUCCESS.getCode());
        result.setMessage(HttpCodeEnum.SUCCESS.getMessage());
        return result;
    }

    /**
     * 请求失败
     *
     * @return error
     */
    public static JsonResult error() {
        JsonResult result = new JsonResult();
        result.setStatus(false);
        result.setCode(HttpCodeEnum.ERROR.getCode());
        result.setMessage(HttpCodeEnum.ERROR.getMessage());
        result.data(null);
        return result;
    }

    /**
     * 设置 状态码 和 信息 （一）
     *
     * @param code 状态码
     * @param message 信息
     * @return JsonResult
     */
    public JsonResult codeAndMessage(Integer code, String message) {
        this.setCode(code);
        this.setMessage(message);
        return this;
    }

    /**
     * 设置 状态码 和 信息 （二）
     *
     * @param httpCodeEnum 枚举信息
     * @return JsonResult
     */
    public JsonResult codeAndMessage(HttpCodeEnum httpCodeEnum) {
        this.setCode(httpCodeEnum.getCode());
        this.setMessage(httpCodeEnum.getMessage());
        return this;
    }

    /**
     * 设置 数据 （一）
     *
     * @param key key
     * @param value value  ==> Object
     * @return JsonResult
     */
    public JsonResult data(String key, Object value) {
        this.data.put(key, value);
        return this;
    }

    /**
     * 设置 数据 （二）
     *
     * @param data Map 集合
     * @return JsonResult
     */
    public JsonResult data(Map<String, Object> data) {
        this.setData(data);
        return this;
    }

}

@Data注解为Lombok工具类库中的注解，提供类的get、set、equals、hashCode、canEqual、toString方法，使用时需配置Lombok，如不配置请手动生成相关方法。

  • 定义了统一返回类后，controller层返回数据时统一使用JsonResult.success()方法封装
@RestController
@Tag(name = "测试")
@RequestMapping("/test")
public class UserController {

    @GetMapping("test1")
    public JsonResult data() {
        HashMap<String, String> map = new HashMap<>();
        map.put("username", "admin");
        map.put("password", "123456");
        return JsonResult.success().data("list", map);
    }

}
  • 例如在以上代码中，我们的需求是查询测试用户信息，我们调用这个test1接口就返回了以下的结果：
{
    "code": 200,
    "status": true,
    "message": "操作成功!",
    "data": {
        "list": {
            "password": "123456",
            "username": "admin"
        }
    }
}

二、自定义异常的基本步骤

1. 解析异常的使用

1. 异常分类

  • java异常体系结构图
运行时异常: RuntimeException及其直接间接子类
编译时异常: 非RuntimeException及其直接间接子类
Exception异常
Throwable
Error

2. 为什么处理异常

  • 处理异常，可以让程序在发生异常时不中断，提高代码的健壮性、容错性

3. 什么时候用异常

  1. 系统自动抛出异常
  2. 程序员手动抛出异常

4. 如何处理异常（两种方法）

  1. try - catch 直接解决异常
  2. throws 向上抛异常

2. 自定义业务异常处理

  • 很多时候我们在处理业务逻辑的时候需要抛出一些异常，例如查询某个用户信息，如果用户根本不存在，则需要抛出异常

手动抛出异常的步骤：

  1. 自定义异常类，extends继承Excepion（编译时异常）或者RunTimeException（运行时异常）
  2. 自定义构造方法，无参、带参都可，传入异常信息
  3. 上抛throws异常
/**
 * 业务异常处理类
 */
@Getter
public class BusinessException extends RuntimeException {

    /**
     * 状态码
     */
    private final Integer code;

    /**
     * 报错信息
     */
    private final String message;

    /**
     * 全参构造方法
     *
     * @param code    状态码
     * @param message 报错信息
     */
    public BusinessException(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    /**
     * 构造方法
     *
     * @param message 报错信息
     */
    public BusinessException(String message) {
        this(HttpCodeEnum.ERROR.getCode(), message);
    }

    /**
     * 构造方法
     * @param httpCodeEnum http枚举类
     */
    public BusinessException(HttpCodeEnum httpCodeEnum) {
        this(httpCodeEnum.getCode(), httpCodeEnum.getMessage());
    }

}

3. 自定义全局异常处理

  • 创建GlobalException类，添加@RestControllerAdvice注解
  • 创建一个方法，方法上添加@ExceptionHandler注解，指定异常类型，分别处理不同的异常

@RestControllerAdvice：是一个 Spring Boot 中用于全局异常处理的注解。它结合了@ControllerAdvice 和@ResponseBody 两个注解的功能，可以用于处理所有控制器中抛出的未处理异常，并返回自定义的响应数据
@ExceptionHandler：是异常处理器，两个结合表示当出现异常的时候执行某个通知
Exception.class：是 Java 中的一个类对象，它表示了 java.lang.Exception 类。Exception 是所有异常类的父类，它包含了一些通用的方法和属性，例如异常信息、异常堆栈跟踪等

/**
 * 全局异常信息处理类
 */
@Slf4j
@RestControllerAdvice
public class GlobalException {

    /**
     * 处理业务异常
     *
     * @param e BusinessException
     * @return businessException
     */
    @ExceptionHandler(value = BusinessException.class)
    public JsonResult businessException(BusinessException e) {
        log.error("业务异常 => code: {}, 原因是: {}", e.getCode(), e.getMessage());
        return JsonResult.error().codeAndMessage(e.getCode(), e.getMessage());
    }

    /**
     * 处理未知(600)异常
     *
     * @param e otherException
     * @return globalException
     */
    @ExceptionHandler(value = Exception.class)
    public JsonResult globalException(Exception e) {
        log.error("未知(600)异常 => 原因是: {}", e.getMessage());
        return JsonResult.error().codeAndMessage(HttpCodeEnum.RC600);
    }

}

需要注意的是一个异常只会被捕获一次，比如空指针异常，只会被第二个方法捕获，处理之后不会再被最后一个方法捕获。当上面两个方法都没有捕获到指定异常时，最后一个方法指定了@ExceptionHandler(value = Exception.class)就可以捕获到所有的异常，相当于if elseif else语句

分别测试自定义异常、空指针异常以及其他异常：

  1. 自定义异常
  • 接口：
@RestController
@RequestMapping("/test")
public class TestController {

    /**
     * 测试业务异常
     */
    @PostMapping("/test")
    public void test() {
        int i = 0;
        throw new BusinessException(HttpCodeEnum.RC403);
    }

}
  • 返回json：
{
    "code": 403,
    "status": false,
    "message": "您没有操作权限!",
    "data": null
}
  • 控制台日志：

在这里插入图片描述

  1. 空指针异常：
  • 接口：
    /**
     * 测试空指针异常
     */
    @PostMapping("/test1")
    public void test1(int id, String name) {
        boolean equals = name.equals("id");
        System.out.println("id: " + id + ", name: " + name);
    }
  • 返回json：
{
    "code": 400,
    "status": false,
    "message": "参数格式不合法,请检查后重试!",
    "data": null
}
  • 控制台日志：

在这里插入图片描述

  1. 其他异常：
  • 接口：
    /**
     * 测试其他异常
     */
    @PostMapping("/test2")
    public void test2() {
        int i = 1 / 0;
    }
  • 返回json：
{
    "code": 600,
    "status": false,
    "message": "服务器繁忙或服务器错误,请稍后再试!",
    "data": null
}
  • 控制台日志：

在这里插入图片描述

4. 处理404与405异常

1. 处理404异常

首先，我们在application.yml配置文件增加以下配置项：

spring:
  #  关闭默认的静态资源路径映射
  web:
    resources:
      add-mappings: false
  • 现在当我们请求一个不存在的接口是，控制台会报noHandlerFound警告，然后被全局异常处理捕获到，并统一返回
  • 控制台日志：

在这里插入图片描述

  • 返回json：
{
    "code": 600,
    "status": false,
    "message": "服务器繁忙或服务器错误,请稍后再试!",
    "data": null
}
  • 当发生404错误时，我们可以在全局异常处理中单独对NoHandlerFoundException异常进行处理
    /**
     * 处理页面不存在(404)异常
     *
     * @param e HttpServletRequest
     * @return noHandlerFoundException
     */
    @ExceptionHandler(value = NoHandlerFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public JsonResult noHandlerFoundException(HttpServletRequest e) {
        log.error("请求地址错误(404)异常 => 请求方式: {}, 请求地址: {}", e.getMethod(), e.getServletPath());
        return JsonResult.error().codeAndMessage(HttpCodeEnum.RC404);
    }

在上面中，我们使用@ExceptionHandler(value = NoHandlerFoundException.class)单独捕获处理404异常，统一返回格式中code也设置为404。你也可以使用@ResponseStatus(HttpStatus.NOT_FOUND)注解指定http状态码为404

  • 现在当我们再次发生404异常时，返回json如下：
{
    "code": 404,
    "status": false,
    "message": "未找到您请求的资源!",
    "data": null
}
  • 控制台日志：

在这里插入图片描述

2. 处理405异常

  • 405错误对应的异常为HttpRequestMethodNotSupportedException
    /**
     * 处理请求方式错误(405)异常
     *
     * @param e HttpServletRequest
     * @return httpRequestMethodNotSupportedException
     */
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    public JsonResult httpRequestMethodNotSupportedException(HttpServletRequest e) {
        log.error("请求方式错误(405)异常 => 请求方式: {}, 请求地址: {}", e.getMethod(), e.getServletPath());
        return JsonResult.error().codeAndMessage(HttpCodeEnum.RC405);
    }
  • 返回json：
{
    "code": 405,
    "status": false,
    "message": "请求方式错误,请检查后重试!",
    "data": null
}
  • 控制台日志：

在这里插入图片描述

桃吱咬咬_
关注
专栏目录
Spring Boot进阶(45): Spring Boot 开发必备技能：如何优雅地返回统一结果包装！
**My Coding Family**
06-15 1740
Spring Boot 如何返回统一结果包装？一文教会你。
SpringBoot处理全局异常详解（全面详细+Gitee源码）
黄团团的个人博客
07-04 2141
我们对常见的七种异常情况统一进行处理，这次的主角就是@RestControllerAdvice这个注解，这个一个组合注解由@ControllerAdvice和@ResponseBody组成，@RestControllerAdvice会帮助我们把信息转成json格式返回。在全局异常处理类只需要在类上标注@RestControllerAdvice，并在处理相应异常的方法上使用@ExceptionHandler注解，写明处理哪个异常即可。注：异常的拦截有顺序，子类异常会优先匹配子类异常处理器。
Spring Boot统一封装返回样式
qq_44150902的博客
08-09 1040
springboot统一返回样式
【SpringBoot3】统一数据响应，全局异常处理以及通用响应处理
不积跬步无以至千里，不积小流无以成江海。一个喜欢学习分享的程序员
02-27 2986
在Spring Boot中设计一个优秀的异常处理机制，可以确保应用程序在遇到错误时提供清晰、一致的响应，同时提高系统的健壮性和可维护性。1）定义自定义异常类；2）创建全局异常处理器；3）定义统一的异常响应格式；4）异常分层；5）日志记录；7）提供友好的用户错误信息；8）处理全局异常
【SpringBoot3】SpringBoot中实现全局统一异常处理
wufaqidong1的博客
01-19 3014
2、@ControllerAdvice 只能捕获进入 Controller 层的异常，比如404,401等错误无法捕获。@ControllerAdvice 表示这是一个控制器增强类，当控制器发生异常且符合类中定义的拦截异常类，将会被拦截。3、ErrorController，该方式几乎可以处理所有的异常，包括未进入控制器的错误，比如404,401等错误。1、@ControllerAdvice 定义多个拦截方法，拦截不同的异常类，并且可以获取抛出的异常信息。当然，我们可以不返回页面，只返回异常信息。
Springboot优雅实现对接口返回统一封装
Spirit_NKlaus的专栏
12-20 1936
前端在调用后端接口时往往不同的接口返回的数据是不一样的，但是通常我们会与前端约定一个固定的返回格式，通过固定的格式告诉他们什么时候接口是返回成功，什么时候返回失败，返回成功后他们如何拿到接口返回的数据去渲染前端页面。所以我们需要定义一个统一的标准返回格式的。我们发现delete的方法返回的json格式没有格式化，我们只需要稍加改造一下delete方法就能正常返回格式化的数据。对于一些不想返回固定包装的方法可以在方法上加上@IgnoreAutoResponse注解即可返回原始的格式。
【SpringBoot3】全局异常处理
最新发布
2201_75743716的博客
07-19 1352
/控制器增强 @ControllerAdvice public class GlobalExceptionHandler {errors.put("tips","被除数不能为0");}*/ }//控制器增强 @ControllerAdvice public class GlobalExceptionHandler {errors.put("tips","被除数不能为0");}*/ }
万字解析！springboot优雅的统一返回格式 + 全局异常处理
wdj_yyds的博客
08-24 812
RC400(400, "请求失败，参数错误，请检查后重试。"),RC404(404, "未找到您请求的资源。"),RC405(405, "请求方式错误，请检查后重试。"),RC500(500, "操作失败，服务器繁忙或服务器错误，请稍后再试。");// 自定义状态码// 自定义描述return msg;该枚举类为我们和前端约定好的返回状态码和描述信息，可根据自己的需求修改状态码和描述@Data//状态码//提示信息//数据//接口请求时间return r;
SpringBoot中处理校验逻辑的两种方式：Hibernate Validator+全局异常处理
qq_64948664的博客
01-31 1234
实际开发中把两者结合在一起用，就可以弥补彼此的短板了，简单校验用 Hibernate Validator，复杂一点的逻辑校验，比如说需要数据库查询用全局异常处理来实现。
怎么处理SpringBoot统一接口返回和全局异常？
wdj_yyds的博客
12-12 622
现在大多数公司项目框架，基本都是属于前后端分离模式，这种模式会涉及到一个前后端对接问题，无论是对前端或者是后台服务，维护一套完善且规范的接口是非常有必要的，这样不仅能够提高对接效率，也可以让我的代码看起来更加简洁优雅。 修改前后最大的区别是我们不用在每个接口单独捕获异常，也不用在每个接口都要组装一遍返回参数，可以参考下面这张对比图： 一、SpringBoot不使用统一返回格式 默认情况下，SpringBoot会有如下三种返回情况。 1.1 字符串 @GetMapping("/getUse
包装SpringBoot Controller返回值
01-08
包装SpringBoot Controller返回值示例代码。 建议用idea导入。
使用spring boot3实现异常的统一返回
2301_78646673的博客
12-28 1218
由于这个异常是在程序运行中出现的，属于RunException异常，我们自定义的异常不能够捕获到。在这个前后端分离的时代，一个 统一的数据格式非常重要。本次我们实现用spring boot实现一下返回给前端数据的统一格式，不再出现服务器500的错误。@RestControllerAdvice注解是@ControllerAdvice和@ResponseBody注解的结合，标识返回的数据是json类型。至此，我们就实现了全部的工作。可以返回了统一的数据，但是这个异常是我们自定义的。所以不能处理程序中的错误。
【规范】SpringBoot接口返回结果及异常统一处理，这样封装才优雅
欢迎来到我的博客
09-15 801
本文通过多个SpringBoot实际项目进行归纳整理，从统一接口返回结果和配置全局异常处理两个方面出发，介绍如何优雅的封装规范后端接口输出，详细刨析@RestControllerAdvice和@ExceptionHandler注解及使用方式，增加后端服务健壮性和与前端对接规范性，希望由此化繁为简，能够帮到博友分毫。作者：JavaDog程序狗链接：https://juejin.cn/post/7278692297012051980来源：稀土掘金。
SpringBoot统一结果返回，统一异常处理，大牛都这么玩
攻城狮不是猫
04-30 2228
当实现统一结果返回时，需要创建一个通用的响应对象，定义成功和失败的返回情况，并确保在接口中使用这个通用返回对象。@Setter@Getter/*** 接口响应状态码*//*** 接口响应信息*//*** 接口响应的数据*/统一结果返回的关键之一是规定一套通用的状态码。这有助于客户端更容易地理解和处理 API 的响应，同时也为开发者提供了一致的标准。200 OK：表示成功处理请求。：表示成功创建资源。：表示成功处理请求，但没有返回任何内容。：客户端请求错误。：未授权访问。
springboot3统一返回结果
weixin_51431465的博客
06-17 164
【代码】springboot3统一返回结果。
自定义异常（个人笔记）
学习笔记
08-19 2311
首先封装一个异常的枚举类型 记得导入Lombok依赖 package com.lp.common.base.result; import lombok.Getter; import lombok.ToString; @Getter @ToString public enum ResultCodeEnum { SUCCESS(true, 20000,"成功"), UNKNOWN_REASON(false, 20001, "未知错误"), BAD_SQL_GRAMMAR(fals
SpringBoot(三)----统一异常处理
qq_34139393的博客
04-11 440
Springboot的全局异常处理主要用到两个注解@ControllerAdvice和@ExceptionHandler，使用@ControllerAdvice注解的类是当前springboot程序中所有类的统一异常处理类，在该类中，使用@ExceptionHandler注解的方法来统一处理异常信息，该类对所有注解了@RequestMapping的控制器均有效。 新建一个springboot程序配置文件如下，采用thymeleaf用于页面跳转 spring.thymeleaf.cache=false
SpringBoot封装返回结果
yangsf_的博客
08-03 1188
便于接口管理
SpringBoot统一封装返回结果和异常情况
04-20
SpringBoot提供了一种简单、快速的方式来封装返回结果和异常情况，即使用@RestControllerAdvice和@ExceptionHandler注解。@RestControllerAdvice用于全局统一处理Controller中的异常，而@ExceptionHandler用于具体...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值