企业分布式微服务云SpringCloud SpringBoot mybatis （五）Spring Boot中Web应用的统一异常处理

咱们在作Web应用的时候，请求处理过程当中发生错误是很是常见的状况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常以后，会转到该请求中处理，而且该请求有一个全局的错误页面用来展现异常内容。

选择一个以前实现过的Web应用（Chapter3-1-2）为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：

@RequestMapping("/hello") public String hello() throws Exception { throw new Exception("发生错误"); } 此时，能够看到相似下面的报错页面，该页面就是Spring Boot提供的默认error映射页面。

alt=默认的错误页面alt=默认的错误页面

统一异常处理

虽然，Spring Boot中实现了默认的error映射，可是在实际应用中，上面你的错误页面对用户来讲并不够友好，咱们一般须要去实现咱们本身的异常提示。

下面咱们以以前的Web应用例子为基础（Chapter3-1-2），进行统一异常处理的改造。

建立全局异常处理类：经过使用@ControllerAdvice定义统一的异常处理类，而不是在每一个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中 @ControllerAdvice class GlobalExceptionHandler {

public static final String DEFAULT_ERROR_VIEW = "error";

@ExceptionHandler(value = Exception.class)
public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
    ModelAndView mav = new ModelAndView();
    mav.addObject("exception", e);
    mav.addObject("url", req.getRequestURL());
    mav.setViewName(DEFAULT_ERROR_VIEW);
    return mav;
}
复制代码

}

实现error.html页面展现：在templates目录下建立error.html，将请求的URL和Exception对象的message输出。

Error Handler

启动该应用，访问：http://localhost:8080/hello，能够看到以下错误提示页面。

alt=自定义的错误页面alt=自定义的错误页面

经过实现上述内容以后，咱们只须要在Controller中抛出Exception，固然咱们可能会有多种不一样的Exception。而后在@ControllerAdvice类中，根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中，经过@ControllerAdvice统必定义不一样Exception映射到不一样错误处理页面。而当咱们要实现RESTful API时，返回的错误是JSON格式的数据，而不是HTML页面，这时候咱们也能轻松支持。

本质上，只需在@ExceptionHandler以后加入@ResponseBody，就能让处理函数return的内容转换为JSON格式。

下面以一个具体示例来实现返回JSON格式的异常处理。

建立统一的JSON返回对象，code：消息类型，message：消息内容，url：请求的url，data：请求返回的数据 public class ErrorInfo {

public static final Integer OK = 0;
public static final Integer ERROR = 100;

private Integer code;
private String message;
private String url;
private T data;

// 省略getter和setter
复制代码

}

建立一个自定义异常，用来实验捕获该异常，并返回json public class MyException extends Exception {

public MyException(String message) {
    super(message);
}
复制代码

}

Controller中增长json映射，抛出MyException异常 @Controller public class HelloController {

@RequestMapping("/json")
public String json() throws MyException {
    throw new MyException("发生错误2");
}
复制代码

}

为MyException异常建立对应的处理 @ControllerAdvice public class GlobalExceptionHandler {

@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
    ErrorInfo<String> r = new ErrorInfo<>();
    r.setMessage(e.getMessage());
    r.setCode(ErrorInfo.ERROR);
    r.setData("Some Data");
    r.setUrl(req.getRequestURL().toString());
    return r;
}
复制代码

}

启动应用，访问：http://localhost:8080/json，能够获得以下返回内容： { code: 100， data: "Some Data"， message: "发生错误2"， url: "http://localhost:8080/json" }

至此，已完成在Spring Boot中建立统一的异常处理，实际实现仍是依靠Spring MVC的注解，更多更深刻的使用可参考Spring MVC的文档。

源码来源：http://minglisoft.cn/honghu/technology.html