springboot 自定义异常处理
通过跟踪springboot对异常处理得源码跟踪,根据业务需要,可以细分前端响应的错误页面,也可以统一使用/error页面+错误提示信息进行处理。
根据自己的需求自定义异常处理机制;具体可实施的操作如下:www.acgred.cn
可以通过配置error/HttpStatus(错误状态码)页面实现自定义错误页面【底层实现,详见:BasicErrorController源码】;
可以实现BasicErrorController,自定义普通请求的异常页面响应信息和异步请求的响应信息,统一使用/error页面进行错误响应提示;
- 自定义实现ErrorAttributes接口,覆盖DefaultErrorAttributes实现,或是继承DefaultErrorAttributes类,重写里面的方法【TODO,不推荐】。
1和2的方法可单独使用,也可以结合使用。
自定义异常页面
可以根据不同的错误状态码,在前端细分不同的响应界面给用户进行提示;资源路径必须是:静态资源路径下/error/HttpStats(比如:/error/404等)
- 自定义异常页面
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"></meta>
<title>404友情提示</title>
</head>
<body>
<h1>访问的资源未找到(404)</h1>
</body>
</html>
404.html
500.html等,这里只演示404。
统一异常处理
普通请求,前端使用error页面+自定义错误响应信息;
其他请求(异步),统一自定义错误响应信息,规范处理异步响应的错误判断和处理。
使用springMVC注解ControllerAdvice
/**
*
* @项目名称:wyait-manage
* @类名称:GlobalExceptionHandler
* @类描述:统一异常处理,包括【普通调用和ajax调用】
* </br>ControllerAdvice来做controller内部的全局异常处理,但对于未进入controller前的异常,该处理方法是无法进行捕获处理的,SpringBoot提供了ErrorController的处理类来处理所有的异常(TODO)。
* </br>1.当普通调用时,跳转到自定义的错误页面;2.当ajax调用时,可返回约定的json数据对象,方便页面统一处理。
* @创建人:wyait
* @创建时间:2018年5月22日 上午11:44:55
* @version:
*/
@ControllerAdvice
public class GlobalExceptionHandler {
private static final Logger logger = LoggerFactory
.getLogger(GlobalExceptionHandler.class);
public static final String DEFAULT_ERROR_VIEW = "error";
/**
*
* @描述:针对普通请求和ajax异步请求的异常进行处理
* @创建人:wyait
* @创建时间:2018年5月22日 下午4:48:58
* @param req
* @param e
* @return
* @throws Exception
*/
@ExceptionHandler(value = Exception.class)
@ResponseBody
public ModelAndView errorHandler(HttpServletRequest request,
HttpServletResponse response, Exception e) {
logger.debug(getClass().getName() + ".errorHandler】统一异常处理:request="+request);
ModelAndView mv=new ModelAndView();
logger.info(getClass().getName() + ".errorHandler】统一异常处理:"+e.getMessage());
//1 获取错误状态码
HttpStatus httpStatus=getStatus(request);
logger.info(getClass().getName() + ".errorHandler】统一异常处理!错误状态码httpStatus:"+httpStatus);
//2 返回错误提示
ExceptionEnum ee=getMessage(httpStatus);
//3 将错误信息放入mv中
mv.addObject("type", ee.getType());
mv.addObject("code", ee.getCode());
mv.addObject("msg", ee.getMsg());
if(!ShiroFilterUtils.isAjax(request)){
//不是异步请求
mv.setViewName(DEFAULT_ERROR_VIEW);
logger.debug(getClass().getName() + ".errorHandler】统一异常处理:普通请求。");
}
logger.debug(getClass().getName() + ".errorHandler】统一异常处理响应结果:MV="+mv);
return mv;
}
...
}
运行测试:先走GlobalExceptionHandler(使用注解@ControllerAdvice)类里面的方法,而后又执行了BasicErrorController方法;被springboot自带的BasicErrorController覆盖。acgred.cn
实现springboot的AbstractErrorController
自定义实现AbstractErrorController,添加响应的错误提示信息。
@RequestMapping(produces = "text/html")
public ModelAndView errorHtml(HttpServletRequest request,
HttpServletResponse response) {
ModelAndView mv = new ModelAndView(ERROR_PATH);
/** model对象包含了异常信息 */
Map<String, Object> model = getErrorAttributes(request,
isIncludeStackTrace(request, MediaType.TEXT_HTML));
// 1 获取错误状态码(也可以根据异常对象返回对应的错误信息)
HttpStatus httpStatus = getStatus(request);
// 2 返回错误提示
ExceptionEnum ee = getMessage(httpStatus);
Result<String> result = new Result<String>(
String.valueOf(ee.getType()), ee.getCode(), ee.getMsg());
// 3 将错误信息放入mv中
mv.addObject("result", result);
logger.info("统一异常处理【" + getClass().getName()
+ ".errorHtml】统一异常处理!错误信息mv:" + mv);
return mv;
}
@RequestMapping
@ResponseBody
//设置响应状态码为:200,结合前端约定的规范处理。也可不设置状态码,前端ajax调用使用error函数进行控制处理
@ResponseStatus(value=HttpStatus.OK)
public Result<String> error(HttpServletRequest request, Exception e) {
/** model对象包含了异常信息 */
Map<String, Object> model = getErrorAttributes(request,
isIncludeStackTrace(request, MediaType.TEXT_HTML));
// 1 获取错误状态码(也可以根据异常对象返回对应的错误信息)
HttpStatus httpStatus = getStatus(request);
// 2 返回错误提示
ExceptionEnum ee = getMessage(httpStatus);
Result<String> result = new Result<String>(
String.valueOf(ee.getType()), ee.getCode(), ee.getMsg());
// 3 将错误信息返回
// ResponseEntity
logger.info("统一异常处理【" + getClass().getName()
+ ".error】统一异常处理!错误信息result:" + result);
return result;
}
针对异步请求,统一指定响应状态码:200;也可以不指定,前端在处理异步请求的时候,可以通过ajax的error函数进行控制。
这里是继承的AbstractErrorController类,自定义实现统一异常处理,也可以直接实现ErrorController接口。gaimor.cn
前端ajax异步统一处理:
通过约定,前端ajax异步请求,进行统一的错误处理。
/**
* 针对不同的错误可结合业务自定义处理方式
* @param result
* @returns {Boolean}
*/
function isError(result){
var flag=true;
if(result && result.status){
flag=false;
if(result.status == '-1' || result.status=='-101' || result.status=='400' || result.status=='404' || result.status=='500'){
layer.alert(result.data);
}else if(result.status=='403'){
layer.alert(result.data,function(){
//跳转到未授权界面
window.location.href="/403";
});
}
}
return flag;//返回true
}
使用方式:
...
success:function(data){
//异常过滤处理
if(isError(data)){
alert(data);
}
},
...
error.html页面:
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head th:include="layout :: htmlhead" th:with="title='wyait后台管理'">
<meta charset="UTF-8"></meta>
<title th:text="${result.status}"></title>
</head>
<body>
<h1>出错了</h1>
<p><span th:text="${result.message}"></span>(<span th:text="${result.data}"></span>)</p>
</body>
</html>