SpringBoot结果封装和异常拦截的实现示例

 更新时间:2023年08月17日 08:57:37   作者:小虎哥的技术博客  
SpringBoot 项目中,我们通常需要将结果数据封装成特定的格式,以方便客户端进行处理,本文主要介绍了SpringBoot 优雅的结果封装和异常拦截,感兴趣的可以了解一下

在 SpringBoot 项目中,我们通常需要将结果数据封装成特定的格式,以方便客户端进行处理。我们可以将封装结果的代码封装成一个工具类或统一的响应类型,以简化代码的编写工作,并且方便统一管理。下面介绍一个简单的例子,说明如何对 SpringBoot 返回结果进行封装。

1. 定义 CommonResult 类

我们可以定义一个名为 CommonResult<T> 的类,用于封装接口的响应结果。它包含三个字段,分别对应了状态码 code、响应消息 msg 和响应数据 data,其中数据类型为泛型 T。code 字段是 int 类型的。

public class CommonResult<T> {
    private int code;  // 响应状态码
    private String msg;  // 响应消息
    private T data;  // 响应数据
    // 构造器
    public CommonResult() {}
    public CommonResult(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    // 省略 Getter 和 Setter 方法
}

2. 定义响应码 ResponseCode

为了方便管理和调用响应状态码,我们可以定义一个名为 ResponseCode 的类,用来统一管理响应状态码。

public enum ResponseCode {
    SUCCESS(200, "操作成功"),
    FAIL(500, "操作失败");
    // 状态码和状态信息
    private final int code;
    private final String message;
    // 构造器
    private ResponseCode(int code, String message) {
        this.code = code;
        this.message = message;
    }
    // Getter 方法
    public int getCode() {
        return code;
    }
    public String getMessage() {
        return message;
    }
}

在这里我们只定义了两种响应状态码,分别是成功和失败,对应的状态码分别为 200 和 500。在实际项目中,我们可以根据实际业务场景定义更多的响应状态码。

3. 自定义异常 BizException

我们还可以定义一个自定义异常类 BizException,用于处理自定义异常场景,并在 GlobalExceptionHandler 中进行拦截与处理。

public class BizException extends RuntimeException {
    private int code;
    public BizException(ResponseCode responseCode) {
        super(responseCode.getMessage());
        this.code = responseCode.getCode();
    }
    // Getter 方法
    public int getCode() {
        return code;
    }
}

Biz是英文Business的缩写,表示业务中发生的异常。

在该类中,我们定义了响应状态码对应的异常,并在构造方法中传入对应的 ResponseCode 来初始化异常的 code 字段。

4. 统一处理异常情况

在实际项目中,我们需要对异常情况进行处理,以保证系统的稳定性和可控性。因此,我们可以在对外暴露的 API 接口中添加异常处理机制,以统一处理系统抛出的异常情况,并防止系统挂掉。
在 SpringBoot 中,我们可以通过使用 @RestControllerAdvice 和 @ExceptionHandler 注解来进行异常处理。具体实现方式如下:

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public CommonResult<String> handleException(Exception e) {
        log.error("系统异常:{}", e.getMessage());
        return new CommonResult<>(ResponseCode.FAIL.getCode(), "系统错误,请联系管理员", null);
    }
    @ExceptionHandler(BizException.class)
    public CommonResult<String> handleBizException(BizException e) {
        log.error("业务异常:{}", e.getMessage());
        return new CommonResult<>(e.getCode(), e.getMessage(), null);
    }
}

在上面的例子中,我们使用了 @RestControllerAdvice 注解来定义一个全局的异常处理类,使用 @ExceptionHandler(Exception.class) 和 @ExceptionHandler(BizException.class) 注解来分别处理全局异常和自定义的业务异常。

当系统发生异常时,会被 handleException 方法所捕获,输出异常日志,并返回一个业务失败的结果。而当业务异常发生时,会被 handleBizException 方法所捕获,返回该业务异常对应的状态码、响应消息和响应数据。

5. 使用结果封装类和模拟异常拦截

@RestController
@RequestMapping("/api")
public class UserController {
    // 省略注入代码
    @GetMapping("/users/{id}")
    public CommonResult<User> getUserById(@PathVariable("id") Long id) {
        User user = userService.getUserById(id);
        if (null != user) {
            return new CommonResult<>(ResponseCode.SUCCESS.getCode(), ResponseCode.SUCCESS.getMessage(), user);
        } else {
            throw new BizException(ResponseCode.FAIL);
        }
    }
}

使用CommonResult<User>来返回数据给前端
throw new BizException(ResponseCode.FAIL);抛出异常后会在异常拦截器那里拦截统一进行处理

6. 总结

在本篇教程中,我们介绍了如何使用 SpringBoot 来封装返回结果。我们定义了 CommonResult 类、ResponseCode 类和 BizException 自定义业务异常类,用于封装响应结果、统一管理响应状态码和处理自定义业务异常。我们也介绍了如何使用 @RestControllerAdvice 和 @ExceptionHandler 注解来统一处理异常情况,避免因为异常情况导致系统不稳定。在实际项目中,我们可以根据实际情况对以上代码进行修改和调整,以适应不同的业务场景。

到此这篇关于SpringBoot结果封装和异常拦截的实现示例的文章就介绍到这了,更多相关SpringBoot 结果封装和异常拦截内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring解决循环依赖问题及三级缓存的作用

    Spring解决循环依赖问题及三级缓存的作用

    这篇文章主要介绍了Spring解决循环依赖问题及三级缓存的作用,所谓的三级缓存只是三个可以当作是全局变量的Map,Spring的源码中大量使用了这种先将数据放入容器中等使用结束再销毁的代码风格
    2022-07-07
  • Java数据结构之有向图的拓扑排序详解

    Java数据结构之有向图的拓扑排序详解

    这篇文章主要为大家详细介绍了Java数据结构中有向图的拓扑排序,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以了解一下
    2022-11-11
  • Springboot Vue可配置调度任务实现示例详解

    Springboot Vue可配置调度任务实现示例详解

    这篇文章主要为大家介绍了Springboot Vue可配置调度任务实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-01-01
  • RocketMQ中消费者概念和消费流程详解

    RocketMQ中消费者概念和消费流程详解

    这篇文章主要介绍了RocketMQ中消费者概念和消费流程详解,RocketMQ是一款高性能、高可靠性的分布式消息中间件,消费者是RocketMQ中的重要组成部分,消费者负责从消息队列中获取消息并进行处理,需要的朋友可以参考下
    2023-10-10
  • idea中lombok启用的方法示例

    idea中lombok启用的方法示例

    这篇文章主要介绍了idea中lombok启用的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Spring Boot maven框架搭建教程图解

    Spring Boot maven框架搭建教程图解

    这篇文章主要介绍了Spring Boot maven框架搭建教程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • 简易版SpringBoot自定义模拟实现

    简易版SpringBoot自定义模拟实现

    SpringBoot作为目前最流行的框架之一,极大地提高了开发效率和降低了学习成本,使得开发人员能够更专注于业务逻辑的实现,而无需过多关注底层框架的配置和集成,本文模拟实现简易版SpringBoot
    2024-01-01
  • MyBatis-Plus使用sl4j日志打印SQL的代码详解

    MyBatis-Plus使用sl4j日志打印SQL的代码详解

    以下是关于使用 Spring Boot 起始器替换 slf4j-api 和 logback 依赖的详细步骤和注意事项,包括 MyBatis-Plus 的默认日志级别信息,需要的朋友可以参考下
    2024-10-10
  • Java多线程下载的实现方法

    Java多线程下载的实现方法

    复习多线程的时候,练习了下,顺便记录一下:
    2013-03-03
  • mybatis-plus内置雪花算法主键重复问题解决

    mybatis-plus内置雪花算法主键重复问题解决

    本文主要介绍了mybatis-plus内置雪花算法主键重复问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-09-09

最新评论