统一异常处理

# 一、什么是统一异常处理

# 1、制造异常

Teacher.java中屏蔽下面代码

// @TableField(value = "is_deleted")
private Boolean deleted;

1
2

# 2、Swagger中测试逻辑删除功能

查看结果

# 3、什么是统一异常处理

我们想让异常结果也显示为统一的返回结果对象，并且统一处理系统的异常信息，那么需要统一异常处理

# 二、统一异常处理

# 1、创建统一异常处理器

guli-framework-common中创建com.guli.common.handler包，

创建统一异常处理类GlobalExceptionHandler.java：

package com.guli.common.handler;

/**
 * 统一异常处理类
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e){
        e.printStackTrace();
        return R.error();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

# 2、扫描异常处理器

在EduApplication.java上添加注解@ComponentScan

@SpringBootApplication
@ComponentScan(basePackages={"com.guli.edu","com.guli.common"})
public class EduApplication {

1
2
3

# 3、测试

返回统一错误结果

# 三、处理特定异常

# 1、添加枚举

ResultCodeEnum.java中添加

,
BAD_SQL_GRAMMAR(false, 21001, "sql语法错误");

1
2

# 2、添加异常处理方法

GlobalExceptionHandler.java中添加

@ExceptionHandler(BadSqlGrammarException.class)
@ResponseBody
public R error(BadSqlGrammarException e){
    e.printStackTrace();
    return R.codeEnum(ResultCodeEnum.BAD_SQL_GRAMMAR);
}

1
2
3
4
5
6

# 3、测试

# 4、恢复制造的异常

@TableField(value = "is_deleted")
private Boolean deleted;

1
2

# 四、另一个例子

# 1、制造异常

在swagger中测试新增讲师方法，输入非法的json参数，得到

HttpMessageNotReadableException

# 2、添加枚举

ResultCodeEnum.java中添加

,
JSON_PARSE_ERROR(false, 21002, "json解析异常");

1
2

#

# 3、添加异常处理方法

GlobalExceptionHandler.java中添加

@ExceptionHandler(HttpMessageNotReadableException.class)
@ResponseBody
public R error(JsonParseException e){
    e.printStackTrace();
    return R.setResult(ResultCodeEnum.JSON_PARSE_ERROR);
}

1
2
3
4
5
6

# 4、测试

# 五、自定义异常

# 1、创建自定义异常类

common模块中创建com.guli.common.exception包，

创建GuliException.java通用异常类继承 RuntimeException

RuntimeException 对代码没有侵入性

package com.guli.common.exception;

@Data
@ApiModel(value = "全局异常")
public class GuliException extends RuntimeException {

    @ApiModelProperty(value = "状态码")
    private Integer code;

    /**
     * 接受状态码和消息
     * @param code
     * @param message
     */
    public GuliException(Integer code, String message) {
        super(message);
        this.code=code;
    }

    /**
     * 接收枚举类型
     * @param resultCodeEnum
     */
    public GuliException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

# 2、添加枚举

ResultCodeEnum.java中添加

,
PARAM_ERROR(false, 21002,"参数不正确");

1
2

# 3、业务中需要的位置抛出GuliException

讲师controller中分页查询方法中判断参数是否合法

public R pageQuery(......){

    if(page <= 0 || limit <= 0){
        //throw new GuliException(21003, "参数不正确1");
        throw new GuliException(ResultCodeEnum.PARAM_ERROR);
    }
    ......
}

1
2
3
4
5
6
7
8

# 4、添加异常处理方法

GlobalExceptionHandler.java中添加

@ExceptionHandler(GuliException.class)
@ResponseBody
public R error(GuliException e){
    e.printStackTrace();
    return R.error().message(e.getMessage()).code(e.getCode());
}

1
2
3
4
5
6

编辑

上次更新: 2024/06/15, 15:12:25

← 新增和修改统一日志处理→