SpringBoot异常捕获与信息提示基础讲解

在前后端分离的项目中，为了方便前后端的沟通，避免浪费无效的寻找错误bug的时间，在后端进行开发时需要进行异常捕获，将捕获的异常清晰的展示出来，方便异常的处理，同时，在面向c端或b端的项目时，需要有清晰的信息提示来方便用户体验，这些功能都可以统一实现。

本章主要讲解异常捕获与信息提示的基础讲解

需要准别的工作如下

完成基本springboot框架的搭建

完成与MySQL数据库的连接

完成了上诉工作后，我们首先创建一个包common在springboot的项目下，该包代表通用包，凡是通用的类都已放在该包下面，在完成包的创建后，我们创建枚举类ExceptionEnum，将各个类型的异常或者提示展示出来，代码如下

package com.example.mallsystem.common;

/**
 * 枚举类展示各个异常的信息和对用户的提示信息
 */
public enum ExceptionEnum {
    SUCCESS("运行成功",200),
    USER_NAME_ERROR("用户名错误",300),
    USER_KEYWORD_ERROR("密码错误",400),
    MYSQL_ERROR_ONE("数据重复",500),
    MYSQL_ERROR("未知错误",600),
    NULL_POINTER("空指针引用异常",700),
    CLASS_Cast("类型强制转换异常",800),
    LEGAL_ARGUMENT("传递非法参数异常",900),
    INDEX_OUT("下标越界异常",10000);
    ;
    private String msg;

    ExceptionEnum(String msg, int code) {
        this.msg = msg;
        this.code = code;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public Integer getCode() {
        return code;
    }

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

    private Integer code;
}

msg为错误提示信息，code为错误码，两样可以自己定义，也可以在网上查找通用的定义规则

在枚举类创建完成后，我们完成返回体的创建，返回体是我们项目的统一返回格式，将其中的code和msg替换为枚举中已经定义好的数据就可以了，代码如下

package com.example.mallsystem.common;

import lombok.Data;

/**
 * 通用返回体
 * @param <T>
 */
@Data
public class ReturnBody<T> {
    private String msg;
    private Integer code;
    private T data;

    /**
     * 成功返回方法
     */
    public static <T>ReturnBody<T> Success(T data,ExceptionEnum exceptionEnum){
        ReturnBody<T> result = new ReturnBody<>();
        result.msg = exceptionEnum.getMsg();
        result.code = exceptionEnum.getCode();
        result.data = data;

        return result;
    }

    /**
     * 失败返回方法
     */
    public static <T>ReturnBody<T> Error(CustomException ex){
        ReturnBody<T> result = new ReturnBody<>();
        result.msg = ex.getMsg();
        result.code = ex.getCode();
        return result;
    }
}

在完成了返回体的设置后，我们开始创建CustoException信息提示类，代码如下

package com.example.mallsystem.common;

import lombok.Data;

@Data
public class CustomException extends RuntimeException {
    private Integer code;
    private String msg;
    public CustomException(ExceptionEnum exceptionEnum){
        this.code = exceptionEnum.getCode();
        this.msg = exceptionEnum.getMsg();
//        super(String.valueOf(exceptionEnum));
    }

    public CustomException() {

    }
}

CustoException类主要处理信息提示，如密码错误，账号错误等，由于信息提示没有报错，所以我们CustoException类继承RuntimeException类程序运行时异常，我们在进行异常捕捉时可以捕捉CustoException类来进行信息提示

最后完成异常捕捉GlobalExceptionHandler类的创建，代码如下

package com.example.mallsystem.common;

import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
import org.springframework.web.bind.annotation.*;

import java.sql.SQLIntegrityConstraintViolationException;

/**
 * 全局异常处理器
 */
@Component
@RestControllerAdvice(annotations = {RestController.class, Service.class})
@ResponseBody
public class GlobalExceptionHandler {
    @ExceptionHandler({SQLIntegrityConstraintViolationException.class})
    public ReturnBody<String> Hadler(SQLIntegrityConstraintViolationException ex){
        if (ex.getMessage().contains("Duplicate entry")){
//            String[] arr = ex.getMessage().split(" ");
//            String msg = arr[2] + "已存在";
            return ReturnBody.Error(new CustomException(ExceptionEnum.MYSQL_ERROR_ONE));
        }
        return ReturnBody.Error(new CustomException(ExceptionEnum.MYSQL_ERROR));
    }

    @ExceptionHandler({CustomException.class})
    public ReturnBody<String> Hadler2(CustomException ex){
        return ReturnBody.Error(ex);
    }

    @ExceptionHandler({java.lang.NullPointerException.class})
    public ReturnBody<String> Hadler3(java.lang.NullPointerException ex){
        return ReturnBody.Error(new CustomException(ExceptionEnum.NULL_POINTER));
    }

    @ExceptionHandler({ClassCastException.class})
    public ReturnBody<String> Hadler4(ClassCastException ex){
        return ReturnBody.Error(new CustomException(ExceptionEnum.CLASS_Cast));
    }

    @ExceptionHandler({IllegalArgumentException.class})
    public ReturnBody<String> Hadler5(IllegalArgumentException ex){
        return ReturnBody.Error(new CustomException(ExceptionEnum.LEGAL_ARGUMENT));
    }

    @ExceptionHandler({IndexOutOfBoundsException.class})
    public ReturnBody<String> Hadler6(IndexOutOfBoundsException ex){
        return ReturnBody.Error(new CustomException(ExceptionEnum.INDEX_OUT));
    }
}

看起来非常复杂，但其实我们耐心观察其实发现异常捕捉也是有很多重复代码组成的，我们先来对其中的注解进行讲解

@Component 该注解将整个类为了一个整体放入springboot的框架中，交给springboot框架进行管理

@RestControllerAdvice 该注解作为一个异常处理的核心注解，与@ExceptionHandler注解一起使用作为全局异常处理器里的异常，通过annotations里面的类代表对有这些注解的类的监视，凡是这些类有异常都会被我们捕捉到

@ResponseBody 该注解将返回的信息转换为json格式

@ExceptionHandler 该注解指代异常

可以看到，我们的全局异常捕捉处理器也是又一个个异常堆积形成的，通过对每一类的处理楚河在一起形成了我们的全局异常处理器，唯一的一个例外是我们CustomException.class，这个类是我们的信息提示类，所以该类的异常处理是以我们业务层中的代码为准，例如登录代码如下

@Override
    public ReturnBody<User> userLand(User user) {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("user_name",user.getUserName());
        User ver = userLandDao.selectOne(wrapper);

        if (ver == null){
            throw new CustomException(ExceptionEnum.USER_NAME_ERROR);
        }

        if (!ver.getUserKeyword().equals(user.getUserKeyword())){
            throw new CustomException(ExceptionEnum.USER_KEYWORD_ERROR);
        }
        System.out.println(ReturnBody.Success(ver,ExceptionEnum.SUCCESS));

        return ReturnBody.Success(ver,ExceptionEnum.SUCCESS);
    }

可以看到我们的用户登录模块的代码，里面的用户名错误和用户密码错误的异常处理都是在业务层实现的，也就是我们的信息提示