SpringBoot使用统一异常处理详解

2019-11-26 09:02:27

字体：大中小

来源：转载

供稿：网友

场景：针对异常处理，我们原来的做法是一般在最外层捕获异常即可，例如在Controller中

@Controllerpublic class HelloController {   private static final Logger logger = LoggerFactory.getLogger(HelloController.class);   @GetMapping(value = "/hello")  @ResponseBody  public Result hello() {    try {      //TODO 具体的逻辑省略……    } catch (Exception e) {      logger.error("hello接口异常={}", e);      return ResultUtil.success(-1, "system error", null);    }    return ResultUtil.success(0, "success", null);  }}

这样的话也能解决部分问题，但是无法获取到自己指定的异常，引入全局统一异常处理的话将会极大的改善代码，减少冗余代码的产生。

自定义异常类:注意要继承自RuntimeException而不是Exception，继承自Exception的话，当抛出自定义异常时spring事务不会回滚

public class GlobalException extends RuntimeException {   private Integer code; //因为我需要将异常信息也返回给接口中，所以添加code区分   public GlobalException(Integer code,String message) {    super(message);  //把自定义的message传递个异常父类    this.code = code;  }   public Integer getCode() {    return code;  }   public void setCode(Integer code) {    this.code = code;  }}

自定义统一异常处理器:比较关键的两个注解@ControllerAdvice、@ExceptionHandler

@ControllerAdvicepublic class ExceptionHandle {   @ResponseBody  //因为我需要将抛出的异常返回给接口，所以加上此注解  @ExceptionHandler  public Result handle(Exception e) {    if (e instanceof GlobalException) {      GlobalException ge = (GlobalException) e;      return ResultUtil.success1(ge.getCode(), ge.getMessage());    }    return ResultUtil.success1(-1, "system error!");  } }

写个测试类测试下

@GetMapping(value = "/hello1")@ResponseBodypublic Result hello(@RequestParam(value = "age", defaultValue = "50", required = false) Integer age) throws GlobalException {  if (age < 10) {    throw new GlobalException(ConstantEnum.LESS10.getCode(), ConstantEnum.LESS10.getMsg());  } else if (age > 50) {    throw new GlobalException(ConstantEnum.MORE50.getCode(), ConstantEnum.MORE50.getMsg());  } else {    return ResultUtil.success1(0, "success");  }}

把code、message封装在了ConstantEnum枚举里面，方便统一维护

public enum ConstantEnum {   ERROR(-1, "system error!"),  SUCCESS(100, "success"),  LESS10(101, "自定义异常信息-我小于10岁"),  MORE50(5001, "自定义异常信息-我大于50岁");   private Integer code;  private String msg;   public Integer getCode() {    return code;  }   public String getMsg() {    return msg;  }   ConstantEnum(Integer code, String msg) {    this.code = code;    this.msg = msg;  }}