springboot全局异常处理

springboot配置全局异常处理

在springboot项目的基础上，什么也不用改，直接新建一个异常处理类。

import com.caihao.kissodemo.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
@Slf4j
public class DefaultExceptionHandle {

  @ExceptionHandler(value = Exception.class)
  @ResponseBody
  public Result handle(Exception e){
    log.error("系统异常：{}",e.getMessage());
    log.error("系统异常：at {}",e.getStackTrace());
    return new Result(100,"请求失败",e.getMessage());
  }

}

上面代码的Result类是我自己定义的一个用来返回一个统一格式的错误信息。也可以不需要，直接使用Map或者其他类型也可以。

import lombok.Data;

/**
 * @author caihao
 * @date 2019/4/19 15:41
 */
@Data
public class Result {

  public Result() {
  }

  public Result(int code, String msg, Object data) {
    this.code = code;
    this.msg = msg;
    this.data = data;
  }

  private int code;
  private String msg;
  private Object data;

}

这个时候全局异常处理就已经写好了。

测试：在项目能够被访问到的地方手动抛出一个异常。就可以看到控制台会打印如下信息

2019-04-19 16:07:53.362 ERROR 14000 — [nio-8080-exec-3] c.c.k.config.DefaultExceptionHandle : 系统异常：没有权限
2019-04-19 16:07:53.362 ERROR 14000 — [nio-8080-exec-3] c.c.k.config.DefaultExceptionHandle : 系统异常：at com.caihao.kissodemo.config.MySSOSpringInterceptor.preHandle(MySSOSpringInterceptor.java:67)

而页面上也会返回相应信息

{
    "code": 100,
    "msg": "请求失败",
    "data": "没有权限"
}

---

如果也需要处理自定义的异常，则只需修改异常处理类里面的handle()即可

public Result handle(Exception e) {
  if (e instanceof MyException) {
    MyException myException = (MyException) e;
    // 处理自定义异常
    return new Result(myException.getCode(), "出现了自定义异常", myException.getMessage());
  } else {
    log.error("系统异常：{}", e.getMessage());
    log.error("系统异常：at {}", e.getStackTrace());
    return new Result(100, "请求失败", e.getMessage());
  }
}