如何在SpringBoot項目裡進行統一異常處理

Posted on by

前言：

需要瞭解的知識：

@ControllerAdvice的作用

1、處理前

異常代碼：

/**
     * 根據id獲取醫院設置
     *
     * @param id 查看的id編號
     * @return
     */
@ApiOperation(value = "根據id獲取醫院設置")
@GetMapping("/findHospById/{id}")
public Result findHospById(@PathVariable Long id) {
    // 模擬異常(因為除數不能為0)
    int a = 1 / 0;
    HospitalSet hospitalSet = hospitalSetService.getById(id);
    return Result.ok(hospitalSet);
}

Swagger2輸出結果：

2、進行系統異常全局處理

添加全局異常處理類：

代碼：

package com.fafa.yygh.common.exception;

import com.fafa.yygh.common.result.Result;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 全局異常處理
 *
 * @author Sire
 * @version 1.0
 * @date 2022-02-02 21:01
 */
@ControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 系統異常處理
     *
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result error(Exception e) {
        e.printStackTrace();
        return Result.fail();
    }
}

Swagger2結果：

3、進行自定義異常處理

開發時，往往需要我們去定義處理一些異常（這裡還是那上面的那個異常來做測試）

創建自定義異常處理類：

package com.fafa.yygh.common.exception;
import com.fafa.yygh.common.result.ResultCodeEnum;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
/**
 * 自定義全局異常類
 *
 * @author qy
 */
@Data
@ApiModel(value = "自定義全局異常類")
public class YyghException extends RuntimeException {
    @ApiModelProperty(value = "異常狀態碼")
    private Integer code;
    /**
     * 通過狀態碼和錯誤消息創建異常對象
     *
     * @param message
     * @param code
     */
    public YyghException(String message, Integer code) {
        super(message);
        this.code = code;
    }
    /**
     * 接收枚舉類型對象
     *
     * @param resultCodeEnum
     */
    public YyghException(ResultCodeEnum resultCodeEnum) {
        super(resultCodeEnum.getMessage());
        this.code = resultCodeEnum.getCode();
    }
    @Override
    public String toString() {
        return "YyghException{" +
            "code=" + code +
            ", message=" + this.getMessage() +
            '}';
    }
}

將其添加到GlobalExceptionHandler：

/**
     * 自定義異常處理
     *
     * @param e
     * @return
     */
@ExceptionHandler(YyghException.class)
@ResponseBody
public Result divError(YyghException e) {
    return Result.build(e.getCode(), e.getMessage());
}

需要手動 try catch 一下：

效果

swagger和系統異常處理一樣

不過後臺輸出不一樣 ：

到此這篇關於如何在SpringBoot項目裡進行統一異常處理的文章就介紹到這瞭,更多相關SpringBoot異常處理內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：