自定义异常及异常全局处理

---

【Java异常分类】

java中异常均继承自Throwable,其有两个重要的直接子类error与exception

1. Error：

大部分是由虚拟机报出来的错误，是程序无法处理的错误,如 OutOfMemoryError,当JVM需要更多内存空间而得不到满足时,就会报出OutOfMemoryError（内存溢出）

2. Exception

• 非RuntimeException（编译期异常）

  在代码书写时，编译器给你检查提示你要进行try catch或throws处理。如IOException,SQLException等

• RuntimeException（运行时异常）
  编译器不会帮你自动检查，当你运行程序时，虚拟机才会给你爆出错误让你去处理，这个往往是我们编码逻辑或不规范导致的。

---

【案例分析】

接口封装统一返回格式

ResultBean 接口统一返回格式

package com.ssm.common.bean;

import lombok.*;

import java.io.Serializable;

@Data
@NoArgsConstructor
@Builder(toBuilder = true)
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public class ResultBean<T> implements Serializable {

    private static final long serialVersionUID = 8676131899637805509L;

    // 返回编码
    private String code;
    // 返回信息
    private String msg;
    // 签名
    @Builder.Default
    private String sign = "";
    // 返回数据封装
    @Builder.Default
    private T data = (T) "";

}

CodeEnum 返回编码和信息

package com.ssm.common.enums;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;

import java.util.Objects;

@Getter
@AllArgsConstructor(access = AccessLevel.PRIVATE)
public enum CodeEnum {

    OK("200", "成功"),
    VALUE_NULL("300", "值为空"),
    PARAM_NULL("301", "参数为空，处理异常"),
    SIGN_ERROR("400", "签名错误"),
    NO_LOGIN("401", "未登录"),
    SYS_ERROR("500", "系统异常");

    private String code;
    private String msg;

    // 根据code返回msg信息
    public String getMsgByCode(String code) {
        for (CodeEnum entry : CodeEnum.values()) {
            if (Objects.equals(entry.getCode(), code)) {
                return entry.getMsg();
            }
        }

        return "";
    }

}

1、自定义的业务异常类：BusinessException

package com.ssm.common.exception;

import lombok.Getter;

@Getter
public class BusinessException extends RuntimeException {

    private String code;

    public BusinessException(String code, String message) {
        super(message);
        this.code = code;
    }
}

2、在service层中抛出业务性异常：

package com.ssm.service.impl;

import com.ssm.common.enums.CodeEnum;
import com.ssm.common.exception.BusinessException;
import com.ssm.service.StudentService;
import org.springframework.stereotype.Service;

@Service
public class StudentServiceImpl implements StudentService {

    @Override
    public void test() {
        throw new BusinessException(CodeEnum.PARAM_NULL.getCode(), CodeEnum.PARAM_NULL.getMsg());
    }

}

3、在controller层中继续向上抛异常

package com.ssm.controller;

import com.ssm.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/student")
public class StudentController {

    @Autowired
    private StudentService studentService;

    @RequestMapping("/test")
    public void test() {
        studentService.test();
    }

}

4、异常统一拦截

返回的异常，都需要经过统一的处理，同样spring也提供了接口对异常的返回
全局异常处理类：GlobalExceptionHandler

package com.ssm.common.exception;

import com.ssm.common.enums.CodeEnum;
import com.ssm.common.bean.ResultBean;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 全局异常处理
 *
 * @author qp
 * @date 2019/4/12 10:10
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ResultBean jsonErrorHandler(Exception e) {
        ResultBean res = ResultBean.builder().build();

        if (e instanceof BusinessException) {
            res.setCode(((BusinessException) e).getCode());
            res.setMsg(e.getMessage());
        } else {
            res.setCode(CodeEnum.SYS_ERROR.getCode());
            res.setMsg(CodeEnum.SYS_ERROR.getMsg());
        }

        return res;
    }
}

@ControllerAdvice：

是一个@Component，用于定义@ExceptionHandler，@InitBinder和@ModelAttribute方法，适用于所有使用@RequestMapping方法。

---

【测试】

访问： http://127.0.0.1:8080/student/test

结果：

---

【总结】

处理逻辑：

自定义异常类 --> 在service层向上抛出自定义异常类 --> 在controller层把自定义异常类继续向上抛 --> 用自定义的全局异常处理类进行统一拦截捕获并处理

自定义异常的好处：

• 异常信息明确，能够快速定位问题
• 统一代码业务性问题处理规范
• 方便错误数据的封装，后台数据机构的统一（统一异常拦截体现）