如何优雅的在SpringBoot项目中处理异常

在程序设计中，异常处理是非常关键和重要的一部分。一个程序异常处理框架的好坏直接影响到整个项目的代码质量以及后期维护成本和难度。试想一下，如果一个项目从头到尾没有考虑过异常处理，当程序出错从哪里寻找出错的根源？但是如果一个项目的异常处理设计过多，又会严重影响到代码质量以及程序的性能。因此，如何高效简洁地设计异常处理是一门艺术。

今天，给同学们推荐一种异常处理的最佳实现方案。

1.环境要求：

JDK 1.8
Springboot 2.3.4.RELEASE

2.创建springboot项目

使用IDEA创建springboot项目，然后引入maven依赖

<parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.3.4.RELEASE</version>
        <relativePath/>
</parent>

<dependencies>
        <!-- Spring Boot Web 依赖 核心 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- Spring Boot Test 依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.76</version>
        </dependency>
</dependencies>

3.代码实现

我们在开发过程中都会统一规定数据的返回格式，因此，先定义数据的返回格式。

import lombok.Data;

import java.util.HashMap;
import java.util.Map;

@Data
public class Result {

    private Integer code; // 返回状态码

    private String message;// 返回信息

    private Map<String, Object> data = new HashMap(); // 返回数据

    /**
     * 构造器私有
     */
    private Result(){}

    /**
     * 返回成功
     */
    public static Result ok(){
        Result r = new Result();
        r.setCode(ResponseEnum.SUCCESS.getCode());
        r.setMessage(ResponseEnum.SUCCESS.getMessage());
        return r;
    }

    /**
     * 返回失败
     */
    public static Result error(){
        Result r = new Result();
        r.setCode(ResponseEnum.ERROR.getCode());
        r.setMessage(ResponseEnum.ERROR.getMessage());
        return r;
    }

    /**
     * 设置特定结果
     */
    public static Result setResult(ResponseEnum responseEnum){
        Result r = new Result();
        r.setCode(responseEnum.getCode());
        r.setMessage(responseEnum.getMessage());
        return r;
    }

    public Result message(String message){
        this.setMessage(message);
        return this;
    }

    public Result code(Integer code){
        this.setCode(code);
        return this;
    }

    public Result data(String key, Object value){
        this.data.put(key, value);
        return this;
    }

    public Result data(Map<String, Object> map){
        this.setData(map);
        return this;
    }
}

创建枚举类型，统一返回结果的返回码和返回消息。枚举中有两个基本属性，code 和 message分别用来表示返回码和返回消息。这样在后续我们抛自定义异常的时候，可以用我们定义好的枚举实例来构造我们想要的返回结果。

public enum ResponseEnum{
    SUCCESS(0, "成功"),
    ERROR(-1, "服务器内部错误"),

    //-1xx 服务器错误
    BAD_SQL_GRAMMAR_ERROR(-101, "sql语法错误"),
    SERVLET_ERROR(-102, "servlet请求异常"), //-2xx 参数校验
    UPLOAD_ERROR(-103, "文件上传错误"),


    //-2xx 参数校验
    MOBILE_NULL_ERROR(-202, "手机号码不能为空"),
    MOBILE_ERROR(-203, "手机号码不正确"),
    PASSWORD_NULL_ERROR(204, "密码不能为空"),
    CODE_NULL_ERROR(205, "验证码不能为空"),
    CODE_ERROR(206, "验证码错误"),
    MOBILE_EXIST_ERROR(207, "手机号已被注册"),
    LOGIN_MOBILE_ERROR(208, "用户不存在"),
    LOGIN_PASSWORD_ERROR(209, "密码错误"),
    LOGIN_LOKED_ERROR(210, "用户被锁定"),
    LOGIN_AUTH_ERROR(-211, "未登录")
    ;

    /** 响应码 */
    private Integer code;

    /** 响应信息描述 */
    private String message;

    ResponseEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }


    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

定义自定义异常，要继承 RuntimeException异常类，表示这个异常是一个运行时异常。一般异常要包含两个信息，异常错误码和异常信息，我们用两个属性表示，errorCode和errorMsg。

构造方法的参数是我们在上面定义的枚举类型ResponseEnum，目的是可以用我们定义的不同枚举实例中的code和message来构造我们自定义的异常。

import com.atguigu.result.ResponseEnum;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
public class BusinessException extends RuntimeException{
    /**
     * 错误码
     */
    protected Integer errorCode;
    /**
     * 错误信息
     */
    protected String errorMsg;

        // 注意这个构造方法，参数是刚刚我们定义的枚举类型
    public BusinessException(ResponseEnum resp){
        this.errorCode = resp.getCode();
        this.errorMsg = resp.getMessage();
    }
}

定义全局异常处理器，用来捕获项目中抛出的自定义异常，然后按照统一的数据格式返回给前端。也就是说，以后在项目中不管是返回失败结果，或者是返回成功结果，我们都统一返回数据的格式。

// 成功案例
{
  "code" : 0,
  "message" : "成功",
  "data" : {
    "name" : "张三",
    "age" : 18
  }
}

//失败案例
{
  "code" : 210,
  "message" : "用户被锁定",
  "data" : {}
}

@RestControllerAdvice // 如果用@ControllerAdvice 则需要在方法上加@ResponseBody注解
public class MyExceptionHandler {

    @ExceptionHandler(BusinessException.class) // 捕获我们自定义的异常进行处理
    public Result businessExceptionHandler(BusinessException e){
        // 返回我们规定好的数据格式
        return Result.error().code(e.getErrorCode()).message(e.getErrorMsg());
    }

    @ExceptionHandler(Exception.class)//其他异常统一处理
    public Result zeroException(Exception e){ 
        return Result.error().message(e.getMessage());
    }
}

写一个controller做下测试

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping
@RestController
public class IndexController {
    @GetMapping("/")
    public String index(){
        // 抛一个我们自定义的异常
        throw new BusinessException(ResponseEnum.LOGIN_LOKED_ERROR);
    }
}

可以看到，返回的错误信息也是以我们规定的格式返回。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping
@RestController
public class IndexController {
    @GetMapping("/")
    public String index(){
      //抛一个非 BusinessException 的异常
      int i = 1 /0; 
    }
}

项目中的异常都由我们定义的全局异常处理器捕获，并以我们规定的格式返回异常信息，这样在开发过程中就可以对异常进行统一处理。