springBoot2.X配置全局捕獲異常的操作

Posted on by

springBoot2.X配置全局捕獲異常

先來看一段代碼：當傳入的id是0的時候，就會報異常。

@RestController
public class HelloController {
    @GetMapping("/getUser")
    public String getUser(int id) {
        int j = 1 / id;
        return "SUCCESS" + j;
    }
}

訪問時：

我們知道這個頁面要是給用戶看到，用戶可能不知道這是什麼。

方法一：將異常捕獲

@GetMapping("/getUser")
    public String getUser(int id) {
        int j;
        try {
            j = 1 / id;
        } catch (Exception e) {
            return "系統異常";
        }
        return "SUCCESS" + j;
    }

這種方法當然可以，但是當我們有很多方法時，需要在每個方法上都加上。

哎，太雞肋瞭吧。

那麼都沒有全局的攔截處理呢？

當然瞭

方法二：通過@ControllerAdvice註解配置

/**
 * @Author 劉翊揚
 * @Date 2020/9/30 11:39 下午
 * @Version 1.0
 */
@ControllerAdvice(basePackages = "com.yiyang.myfirstspringdemo.controller")
public class GlobalExceptionHandler {
    @ExceptionHandler(RuntimeException.class)
    @ResponseBody
    public Map<String,Object> errorResult()  {
        Map<String, Object> map = new HashMap<>();
        map.put("errorCode", "500");
        map.put("errorMsg", "全局捕獲異常");
        return map;
    }
}
  • @ExceptionHandler 表示攔截異常
  • @ControllerAdvice 是 controller 的一個輔助類，最常用的就是作為全局異常處理的切面類
  • @ControllerAdvice 可以指定掃描范圍

註意：下面還需要在啟動類上加上，否則誒呦效果

package com.yiyang.myfirstspringdemo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication(scanBasePackages = {"com.yiyang.myfirstspringdemo.error", "com.yiyang.myfirstspringdemo.controller"})
public class MyFirstSpringDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyFirstSpringDemoApplication.class, args);
    }
}

在啟動類上，將掃描包范圍controller和全局異常處理類，加上去。

這樣當我們在訪問的時候，出現的異常提示信息就是我們在全局異常處理中設置的返回值。

springboot2.x 全局異常處理的正確方式

在web項目中，異常堆棧信息是非常敏感的。因此，需要一個全局的異常處理，捕獲異常，給客戶端以友好的錯誤信息提示。基於 Spring boot 很容易實現全局異常處理。

相關jar依賴引入

<!-- Spring Boot 啟動父依賴 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.6.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <!-- Spring Boot Web 依賴 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

全局異常控制器

package com.yb.demo.common.handler;
import com.yb.demo.common.enums.CodeEnum;
import com.yb.demo.common.exception.BizException;
import com.yb.demo.pojo.response.Result;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ValidationException;
import java.util.StringJoiner;

/**
 * 全局異常處理
 * <p>
 * 規范：流程跳轉盡量避免使用拋 BizException 來做控制。
 *
 * @author [email protected]
 * @date 2019-09-06 18:02
 */
@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 處理自定義異常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(BizException.class)
    public Result handleBizException(BizException ex) {
        Result result = Result.renderErr(ex.getCode());
        if (StringUtils.isNotBlank(ex.getRemark())) {
            result.withRemark(ex.getRemark());
        }
        return result;
    }

    /**
     * 參數綁定錯誤
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(BindException.class)
    public Result handleBindException(BindException ex) {
        StringJoiner sj = new StringJoiner(";");
        ex.getBindingResult().getFieldErrors().forEach(x -> sj.add(x.getDefaultMessage()));
        return Result.renderErr(CodeEnum.REQUEST_ERR).withRemark(sj.toString());
    }

    /**
     * 參數校驗錯誤
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(ValidationException.class)
    public Result handleValidationException(ValidationException ex) {
        return Result.renderErr(CodeEnum.REQUEST_ERR).withRemark(ex.getCause().getMessage());
    }

    /**
     * 字段校驗不通過異常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        StringJoiner sj = new StringJoiner(";");
        ex.getBindingResult().getFieldErrors().forEach(x -> sj.add(x.getDefaultMessage()));
        return Result.renderErr(CodeEnum.REQUEST_ERR).withRemark(sj.toString());
    }

    /**
     * Controller參數綁定錯誤
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(MissingServletRequestParameterException.class)
    public Result handleMissingServletRequestParameterException(MissingServletRequestParameterException ex) {
        return Result.renderErr(CodeEnum.REQUEST_ERR).withRemark(ex.getMessage());
    }

    /**
     * 處理方法不支持異常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    public Result handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException ex) {
        return Result.renderErr(CodeEnum.METHOD_NOT_ALLOWED);
    }

    /**
     * 其他未知異常
     *
     * @param ex
     * @return
     */
    @ExceptionHandler(value = Exception.class)
    public Result handleException(Exception ex) {
        log.error(ex.getMessage(), ex);
        return Result.renderErr(CodeEnum.SERVER_ERR);
    }
}

個性化異常處理

自定義異常

在實際web開發過程中，往往會遇到在某些場景下需要終止當前流程，直接返回。那麼，通過拋出自定義異常，並在全局異常中捕獲，用以友好的提示客戶端。

/**
 * 業務異常跳轉。
 *
 * @author [email protected]
 * @date 2019-09-09 14:57
 */
@Data
public class BizException extends RuntimeException {
    private static final long serialVersionUID = 1L;
    private CodeEnum code;
    private String remark;

    public BizException(CodeEnum code) {
        super(code.getMessage());
        this.code = code;
    }

    public BizException withRemark(String remark) {
        this.remark = remark;
        return this;
    }
}

使用方式如下：

/**
     * 添加學生
     *
     * @param student
     * @return
     */
    public Student1DO addStudent(Student1DO student) {
        if (StringUtils.isNotBlank(student.getStudName())) {
            // 舉例扔個業務異常，實際使用過程中，應該避免扔異常
            throw new BizException(CodeEnum.REQUEST_ERR).withRemark("studName不能為空");
        }
        student1Mapper.insert(student);
        return student;
    }

返回效果如下：

{
“code”: -400,
“msg”: “請求錯誤(studName不能為空)”,
“data”: {},
“ttl”: 0
}

根據阿裡巴巴規范，流程控制還是不要通過拋異常的方式。在正常開發過程中，應避免使用這種方式。

【強制】異常不要用來做流程控制，條件控制，因為異常的處理效率比條件分支低。

使用 Spring validation 完成數據後端校驗

定義實體類，加上validation相關註解

package com.yb.demo.pojo.model.db1;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import javax.validation.constraints.Min;
import javax.validation.constraints.Size;

/**
 * @author [email protected]
 * @date 2019-08-05 17:58
 */
@Data
@TableName("student")
public class Student1DO {
    private Long id;
    @Size(max = 8, message = "studName長度不能超過8")
    private String studName;
    @Min(value = 12, message = "年齡不能低於12歲")
    private Integer studAge;
    private String studSex;
    @TableField(fill = FieldFill.INSERT)
    private Integer createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Integer updateTime;
}

在Controller 方法上加上 @Validated 註解

@PostMapping("/student/add")
public Result addStudent(@Validated @RequestBody Student1DO student) {
    student = studentService.addStudent(student);
    return Result.renderOk(student);
}

實際效果如下：

{
“code”: -400,
“msg”: “請求錯誤(年齡不能低於12歲)”,
“data”: {},
“ttl”: 0
}

結束語

具體代碼見：https://github.com/daoshenzzg/springboot2.x-example

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：