SpringBoot 项目全局异常处理

前提

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

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

准备

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

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

SpringBoot 项目全局异常处理_第1张图片

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

简单的全局异常

@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返回打印的结果

响应标准设计

什么是响应标准?

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

前提

首先我们要创建新的包,然后包里面创建类
image.png

设计响应数据

@Data
@Accessors(chain = true)
@NoArgsConstructor
@AllArgsConstructor
public class viewTable {
    private Integer state=1;//状态码 表示1 ok,表示0 error
    private String message;//状态信息
    private List rows; //封装查询结果
    public viewTable(String message){
         this.message=message;
    }
    public viewTable(List 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 rows; //封装查询结果

state--状态 给页面发送 1表示正常 0表示错误
message -- 状态信息 成功的话 ok 错误的 报异常
rows -- 我们显示的数据

下面的是类型封装

public viewTable(String message){
     this.message=message;
}
public viewTable(List list) {
    this.rows=list;
}
public viewTable(Throwable e){
    this.state=0;
    this.message=e.getMessage();
}

第一个 --- 如果返回的结果是字符串
第二个 --- 如果返回的结果是查询的数据
第三个 --- 如果返回的数据是异常

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

全局异常处理(高级)

前言

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

@Slf4j //lombok中的日志处理注解
@RestControllerAdvice //全局异常
public class GolbalException {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public viewTable GolbalRuntimeException(Exception e){
        viewTable 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异常

image.png

客户端显示

SpringBoot 项目全局异常处理_第2张图片

你可能感兴趣的:(SpringBoot 项目全局异常处理)