自定义全局异常

1.自定义响应结果码 接口

public interface ResultCode {
    //操作是否成功,true为成功，false操作失败
    boolean success();
    //操作代码
    int code();
    //提示信息
    String message();

}

2.自定义异常类

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * 自定义异常类
 */
@Data //lombok提供，getter,setter方法,toString
@AllArgsConstructor //lombok提供，有参构造
public class CustomException extends RuntimeException{
    private ResultCode resultCode;
}

3.自定义异常捕获类

包括捕获自定义异常类，也包括不可预知异常。

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 定义异常捕获类
 * 使用 @ControllerAdvice和@ExceptionHandler注解来捕获指定类型的异常
 */
@ControllerAdvice
public class ExceptionCatch {

    //捕获ExceptionCatch异常
    @ExceptionHandler(CustomException.class) //CustomException是自定义异常类
    @ResponseBody
    public ResponseResult customException(CustomException e){
        ResultCode resultCode = e.getResultCode();
        return new ResponseResult(resultCode);
    }

    //不可预知异常
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseResult exception(Exception e){
        return new ResponseResult(CommonCode.SERVER_ERROR);//对于不知异常抛出99999异常
    }

}

4.自定义异常枚举类CommonCode

自定义异常码和描述，实现ResultCode接口。

import lombok.ToString;


@ToString
public enum CommonCode implements ResultCode{

    SUCCESS(true,10000,"操作成功！"),
    FAIL(false,11111,"操作失败！"),
    UNAUTHENTICATED(false,10001,"此操作需要登陆系统！"),
    UNAUTHORISE(false,10002,"权限不足，无权操作！"),
    VALIDATA(false,10003,"非法参数！"),
    SERVER_ERROR(false,99999,"抱歉，系统繁忙，请稍后重试！");

//    private static ImmutableMap<Integer, CommonCode> codes ;
    //操作是否成功
    boolean success;
    //操作代码
    int code;
    //提示信息
    String message;
    private CommonCode(boolean success,int code, String message){
        this.success = success;
        this.code = code;
        this.message = message;
    }

    @Override
    public boolean success() {
        return success;
    }
    @Override
    public int code() {
        return code;
    }

    @Override
    public String message() {
        return message;
    }


}

测试

在业务方法中添加。

throw new CustomException(CmsCode.CMS_ADDPAGE_EXISTSNAME);//使用自定义异常

测试未知异常：

在业务方法中添加下面除0错进行测试。

int i = 1/0;

注意：

2.自定义异常类

1.ExceptionHandler(CustomException.class)中的异常类要和下面方法入参一致，否则会报错。

2.控制台报错，SpringBoot引导类中@SpringBootApplication注解没有扫到异常捕获类CatchException所在的包。

解决：在引导类上加注解@ComponentScan(basePackages = {"com.lxw.exception"})

3.控制台不报错，但是页面也不显示错误信息，排除前端问题；异常捕获类的方法上没有加ResponseBody注解。

原因：页面不需要跳转，要传json；并且注意不是@RequestBody注解