springboot 之 自定义异常，实现业务逻辑错误提示

为了解决把系统里的业务提示与代码错误和系统错误提示区分开，需要有统一的异常提示机制，所以用自定义异常来解决此问题

一、首先定义异常类ServiceException，里面重载了三个构造方法，可以适用不同场景的异常提示问题

@Getter
public class ServiceException extends RuntimeException{
    private Integer code;

    /**
     * 使用已有的错误类型
     * @param type 枚举类中的错误类型
     */
    public ServiceException(ErrorType type){
        super(type.getMsg());
        this.code = type.getCode();
    }

    /**
     * 自定义错误类型,枚举中没有的错误类型
     * @param code 自定义的错误码
     * @param msg 自定义的错误提示
     */
    public ServiceException(Integer code, String msg){
        super(msg);
        this.code = code;
    }

    /**
     * 指定错误类型，一般为业务提示
     * @param msg
     */
    public ServiceException(String msg){
        super(msg);
        this.code = ErrorType.BUSINESS_TIPS.getCode();
    }
}

定义错误类型枚举如下：

@Getter
@AllArgsConstructor
public enum  ErrorType {
    //@AllArgsConstructor是lombok中的注解,作用在类上;
    //使用后添加一个构造函数，该构造函数含有所有已声明字段属性参数

    /**
     * 错误类型
     */
    NOT_LOGIN(10001,"用户未登录"),

    INVALID_PARAMS(10002,"参数不正确"),

    RESULT_NOT_EXIST(10003,"记录不存在"),

    BUSINESS_TIPS(11000,"业务提示")
    ;

    /**
     * 错误码
     */
    private int code;

    /**
     * 提示信息
     */
    private String msg;
}

二、添加异常处理类ServiceExceptionHandler

@ControllerAdvice，是Spring3.2提供的新注解,它是一个Controller增强器,可对controller中被 @RequestMapping注解的方法加一些逻辑处理。最常用的就是异常处理

统一异常处理
需要配合@ExceptionHandler使用。
当将异常抛到controller时,可以对异常进行统一处理,规定返回的json格式或是跳转到一个错误页面

@ControllerAdvice
public class ServiceExceptionHandler {

    /**
     * @ExceptionHandler相当于controller的@RequestMapping
     * 如果抛出的的是ServiceException，则调用该方法
     * @param se 业务异常
     * @return
     */
    @ExceptionHandler(ServiceException.class)
    @ResponseBody
    public Response handle(ServiceException se){
        return ResponseUtils.error(se.getCode(),se.getMessage());
    }
}

三、定义响应对象及工具类

@Data
public class Response<T> {

    /**
     * 状态码
     */
    private Integer code;

    /**
     * 请求成功时返回的对象
     */
    private T data;

    /**
     * 提示信息
     */
    private String msg;

}

public class ResponseUtils {
    /**
     * 调用成功
     */
    private static final String SUCCESS = "操作成功！";

    public static Response success(Object obj){
        Response res = new Response();
        res.setCode(200);
        res.setData(obj);
        res.setMsg(SUCCESS);
        return res;
    }

    public static Response success(){
        return success(null);
    }

    public static Response error(Integer code, String msg){
        Response res = new Response();
        res.setCode(code);
        res.setMsg(msg);
        return res;
    }
}

四、使用自定义异常

@SysLogAnnotation("导入模板下载")
    @ApiOperation(value = "导入模板下载",notes = "导入模板下载")
    @GetMapping(value = "downTmp")
    public Response downTmp(String code) {
        if(code == null){
            throw new ServiceException("模板编码不能为空");
        }
        exportService.downTmp(code);
        return ResponseUtils.success() ;
    }