3、SpringBoot Web开发之统一异常处理

一、springboot的默认异常机制

• 默认情况下，Spring Boot为两种情况提供了不同的响应方式
  （1）当浏览器发送请求头是Accept: text/html；Spring Boot默认会响应一个html文档内容，称作“Whitelabel Error Page”。

  
  
  image.png
  
  

  （2）当使用postman等调试工具发送请求一个不存在的url或服务端处理发生异常时，Spring Boot会返回类似如下的Json格式字符串信息。

{
    "timestamp": "2018-05-12T06:11:45.209+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/index.html"
} 

• Spring Boot 默认提供了程序出错的结果映射路径/error。这个/error请求会在BasicErrorController中处理，其内部是通过判断请求头中的Accept的内容是否为text/html来区分请求是来自客户端浏览器（浏览器通常默认自动发送请求头内容Accept:text/html）还是客户端接口的调用，以此来决定返回页面视图还是 JSON 消息内容。

  
  
  image.png

二、自定义错误页面信息

• 由于springboot默认的错误返回页面很不友好，但是springboot提供了扩展的机制可以自定义错误页面的展现形式。

1、直接在/resources/templates下面创建error.html就可以覆盖默认的Whitelabel Error Page的错误页面。

• 例如使用themleaf模板，并打印出错误信息

    
    


动态error错误页面

2、根据不同的状态码返回不同的视图页面，这里分两种，错误页面可以是静态HTML和使用模板构建，文件的名称应该是确切的状态码。

（1）静态HTML，比如在/templates/error目录下面创建404.html

    
    


    静态404错误页面

（2）如果是动态模板页面，可以带上错误信息，在resources/templates/下面创建error目录，在error目录下面命名404.html即可:

    
    


静态404错误页面

• 总结：自定义动态模板优先级>自定义静态模板>自定义的error.html>springboot默认的模板

3、 通过@ControllerAdvice注解来处理异常

局部异常处理 @Controller + @ExceptionHandler
全局异常处理 @ControllerAdvice + @ExceptionHandler
（1）局部异常处理 @Controller + @ExceptionHandler

• 局部异常主要用到的是@ExceptionHandler注解，此注解注解到类的方法上，当此注解里定义的异常抛出时，此方法会被执行。如果@ExceptionHandler所在的类是@Controller，则此方法只作用在此类。如果@ExceptionHandler所在的类带有@ControllerAdvice注解，则此方法会作用在全局。

@Controller
public class ExeceptionController {
    @RequestMapping("/test")
    @ResponseBody
    public String test() {
        int i = 5 / 0;
        return "test";
    }

    //局部异常处理
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public String exHandler(Exception e) {
        // 判断发生异常的类型是除0异常则做出响应
        if (e instanceof ArithmeticException) {
            return "发生了除0异常";
        }
        // 未知的异常做出响应
        return "发生了未知异常";
    }
}

（2）全局异常处理 @ControllerAdvice + @ExceptionHandler

• 简单的说，进入Controller层的错误才会由@ControllerAdvice处理，拦截器抛出的错误以及访问错误地址的情况@ControllerAdvice处理不了，由SpringBoot默认的异常处理机制处理

三、全局异常的应用

• 上面说了springboot异常原理，在实际开发中，如果是要实现RESTful API，那么默认的JSON错误信息就不是我们想要的，这时候就需要统一一下JSON格式，所以常常自己要封装一下。封装后的数据返回如下：

正确时候
{
    code：200，
    msg：“获取列表成功”，
    data：{ 
        queryList :[]
    }
}
错误时候
{
    code：500，
    msg：“未知异常，请联系管理员”
}

1、请求响应体

public class ResponseResult {
    private Integer code;
    private String msg;
    private T data;
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
    public T getData() {
        return data;
    }
    public void setData(T data) {
        this.data = data;
    }
    public ResponseResult(Integer code, String msg, T data) {
        super();
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public ResponseResult() {
        super();
    }   
}

2、请求响应状态码枚举类

public enum ResultEnum {
    UNKOWN_ERROR(-1,"未知错误"),
    SUCCESS(1,"成功"),
    PARAM_ERROR(0,"参数错误");
     ResultEnum(Integer code,String msg){
        this.code=code;
        this.msg=msg;
    }
    private Integer code;
    private String msg;
    public Integer getCode() {
        return code;
    }
    public String getMsg() {
        return msg;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

3、请求响应工具类

public class ResponseUtils {
    public static ResponseResult success(Object object){
        ResponseResult result=new ResponseResult<>();
        result.setCode(0);
        result.setMsg("成功");
        result.setData(object);
        return result;
    }
    
    public static ResponseResult success(){
        return success(null);
    }
    public static ResponseResult error(Integer code,String msg){
        ResponseResult result=new ResponseResult<>();
        result.setCode(code);
        result.setMsg(msg);
        return result;
    }
}

4、自定义异常类

// 这里要继承runtimeexception是因为spring框架对运行时异常会进行回滚，如果是exception就不会了
public class MyExeception extends RuntimeException {

    private static final long serialVersionUID = 1L;
    private Integer code;

    public MyExeception(ResultEnum execetionEnum) {
        super(execetionEnum.getMsg());
        this.code = execetionEnum.getCode();
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public Integer getCode() {
        return code;
    }
}

5、全局异常监听类

@RestControllerAdvice
public class GlobalExceptionHandler {
    private static Logger logger=org.slf4j.LoggerFactory.getLogger(GlobalExceptionHandler.class);
    @ExceptionHandler(value=Exception.class)
    @ResponseBody
    public ResponseResult handler(Exception e){
        if(e instanceof MyExeception){
            MyExeception myExeception=(MyExeception)e;
            return new ResponseUtils().error(myExeception.getCode(),myExeception.getMessage());
        }
        else{
            logger.info("系统异常");
            return new ResponseUtils().error(ResultEnum.UNKOWN_ERROR.getCode(),ResultEnum.UNKOWN_ERROR.getMsg());
        }
    }

}

6、测试

@RestController
public class ExeceptionController {

    @RequestMapping("/exception/{name}")
    public ResponseResult test(@PathVariable(value = "name") String name){
        if (name.length()<5){
            throw new MyExeception(ResultEnum.PARAM_ERROR);
        }

        return ResponseUtils.success("返回成功");
    }
}

四、优化应用