《SpringBoot 项目全局异常处理》

本文介绍了如何在Spring Boot项目中实现全局异常处理,以提高性能和灵活性,并提供友好的用户反馈。首先创建一个异常处理类,利用Lombok简化代码,处理运行时异常。接着,设计了一个响应数据类,包含了状态码、状态信息和具体数据,用于统一返回给客户端的数据格式。最后,将全局异常处理与响应数据结构结合,根据不同的异常类型返回不同的错误信息,实现了高级的全局异常处理机制。
摘要由CSDN通过智能技术生成

前提

为什么使用全局异常处理?

因为项目开发过程中遇到各种异常,我们单独处理的话性能较低,也不灵活,用户显示的的是一堆英文的提示,所以我们一下子就处理这种异常,所以我们需要全局异常处理,

准备

首先我们创建一个 异常包,包里面创建一个类

我们的这个异常处理配合Lombok来配合处理

在这里插入图片描述

这个类是我们的全局异常类,

简单的全局异常

	@Slf4j //lombok中的日志处理注解
    @RestControllerAdvice //全局异常
    public class GolbalException {
        @ExceptionHandler(RuntimeException.class)
        @ResponseBody
     public String GolbalRuntimeException(RuntimeException e){
            log.error("RuntimeException.exception {}",e.getMessage());
            return e.getMessage();
        }
    } 
@Slf4J(这个注解是Lombok的日志处理注解)
@RestControllerAdvice(这个注解表示的是当前的类是全局异常处理类)
@ExceptionHandle(这个注解描述controller层处理的异常方法)
@ResponseBody(这个注解描述java对象转换json格式)

思路:

第一步:首先我们创建一个包,包里面创建一个类
第二部:进入类上面定义日志注解和全局异常注解
第三步:类里定义controller层处理的异常处理注解
第四步:异常处理注解里面写处理的异常类型
第五步:类里面创建返回值是String类型的对象
第六步:对象里面写日志如果有异常的话打印
第七步:return返回打印的结果

响应标准设计

什么是响应标准?

我们的数据到客户端里,我们对这些数据进行状态设计,
假如现在响应的数据包含三种 比如:状态,消息,具体数据等…

前提

首先我们要创建新的包,然后包里面创建类
在这里插入图片描述

设计响应数据

@Data
    @Accessors(chain = true)
    @NoArgsConstructor
    @AllArgsConstructor
    public class viewTable<T> {
        private Integer state=1;//状态码 表示1 ok,表示0 error
        private String message;//状态信息
        private List<T> rows; //封装查询结果
        public viewTable(String message){
             this.message=message;
        }
        public viewTable(List<T> list) {
            this.rows=list;
        }
        public viewTable(Throwable e){
            this.state=0;
            this.message=e.getMessage();
        }
    }
我们基于Lombak来实现
    @Data
    @Accessors(chain = true)
    @NoArgsConstructor
    @AllArgsConstructor
@Data–这个注解Lombak的注解 自动生成get和set以及tostring
@Accessors–这个注解的作用getter和setter方法的方法名都是属性名
@NoArgsConstructor–生成无参构造
@AllArgsConstructor–生成有参构造

首先我们指定页面中显示的数据形式

	private Integer state=1;//状态码 表示1 ok,表示0 error
    private String message;//状态信息
    private List<T> rows; //封装查询结果
state–状态 给页面发送 1表示正常 0表示错误
message – 状态信息 成功的话 ok 错误的 报异常
rows – 我们显示的数据

下面的是类型封装

 public viewTable(String message){
         this.message=message;
    }
    public viewTable(List<T> list) {
        this.rows=list;
    }
    public viewTable(Throwable e){
        this.state=0;
        this.message=e.getMessage();
    }
第一个 — 如果返回的结果是字符串
第二个 — 如果返回的结果是查询的数据
第三个 — 如果返回的数据是异常

这样我们给页面显示的数据成功封装好了

全局异常处理(高级)

前言

现在我们响应数据结构和初级异常处理 接下来我们把两个都合起来

 @Slf4j //lombok中的日志处理注解
    @RestControllerAdvice //全局异常
    public class GolbalException<T> {
        @ExceptionHandler(Exception.class)
        @ResponseBody
        public viewTable GolbalRuntimeException(Exception e){
            viewTable<T> v=new viewTable<>();
            v.setState(0);
            if (e instanceof BadSqlGrammarException){
                v.setMessage("数据库异常");
            }else if (e instanceof RuntimeException){
                v.setMessage("服务器异常");
            }
            log.error("RuntimeException.exception {}",e.getMessage());
            return v;
        }
    }

解释

  • 我们把类的类型改成我们的响应结构的类型 就是viewTable
  • 我们new一个刚才设计的响应类
  • 获取里面的状态码设计为0
  • 我们要判断 如果异常时关于SQL的 那么给客户端发送数据库异常
  • 如果异常时关于Runtime的 那么给客户端发送服务器异常
  • 异常是 不是这两个那么客户端发送异常的本身信息
  • 后面return 给响应页面的类

结果

报错的异常

SQL异常

在这里插入图片描述

客户端显示

在这里插入图片描述

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Spring Boot 中,可以通过实现 `@RestControllerAdvice` 注解的类来创建全局异常处理器。 首先,在项目中创建一个异常处理器类,例如 `GlobalExceptionHandler`,并使用 `@RestControllerAdvice` 注解标记该类。然后,在该类中定义方法,使用 `@ExceptionHandler` 注解来捕获特定的异常类型,并返回自定义的响应信息。例如: ```java @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(value = {Exception.class}) public ResponseEntity<String> handleException(Exception e) { return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("服务器内部错误"); } @ExceptionHandler(value = {CustomException.class}) public ResponseEntity<String> handleCustomException(CustomException e) { return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage()); } } ``` 在上面的代码中,`handleException` 方法捕获了所有类型的异常,并返回一个 500 错误码和一个错误信息。`handleCustomException` 方法捕获了 `CustomException` 类型的异常,并返回一个 400 错误码和异常信息。 最后,在项目中的 `application.properties` 文件中添加以下配置,启用全局异常处理器: ```properties spring.mvc.throw-exception-if-no-handler-found=true spring.resources.add-mappings=false ``` 这样,当项目中的任何地方出现异常时,全局异常处理器都会被触发,然后根据异常类型返回自定义的响应信息。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值