团购网站 设计方案,把货卖到国外有哪些平台,百度权重是什么,wordpress安装出现乱码作者简介#xff1a;大家好#xff0c;我是撸代码的羊驼#xff0c;前阿里巴巴架构师#xff0c;现某互联网公司CTO 联系v#xff1a;sulny_ann#xff08;17362204968#xff09;#xff0c;加我进群#xff0c;大家一起学习#xff0c;一起进步#xff0c;一起对抗…作者简介大家好我是撸代码的羊驼前阿里巴巴架构师现某互联网公司CTO 联系vsulny_ann17362204968加我进群大家一起学习一起进步一起对抗互联网寒冬 # 序言 此前我们主要通过在控制层Controller中手动捕捉异常TryCatch和处理错误在SpringBoot 统一异常处理的做法主要有两种一是基于注解ExceptionHandler二是基于接口ErrorController两者都可以让控制器层代码快速“瘦身”让业务逻辑看起来更加清晰明朗 一. 默认错误处理 SpringBoot 默认为我们提供了BasicErrorController 来处理全局错误/异常并在Servlet容器中注册error为全局错误页。所以在浏览器端访问发生错误时我们能及时看到错误/异常信息和HTTP状态等反馈。工作原理如下 ControllerRequestMapping(${server.error.path:${error.path:/error}})public class BasicErrorController extends AbstractErrorController { // 统一异常处理View RequestMapping(produces text/html) public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) { HttpStatus status getStatus(request); MapString, Object model Collections.unmodifiableMap(getErrorAttributes( request, isIncludeStackTrace(request, MediaType.TEXT_HTML))); response.setStatus(status.value()); ModelAndView modelAndView resolveErrorView(request, response, status, model); return (modelAndView null ? new ModelAndView(error, model) : modelAndView); } 例如下面这两个错误对于日常开发而言再熟悉不过了。 404 Not Found 500 服务器错误 二. 统一异常处理 默认的英文空白页显然不能够满足我们复杂多变的需求因此我们可以通过专门的类来收集和管理这些异常信息这样做不仅可以减少控制层的代码量还有利于线上故障排查和紧急短信通知等。 具体步骤 为了让小伙伴少走一些弯路楼主根据官方源码和具体实践提炼这些核心工具类 ErrorInfo 错误信息 ErrorInfoBuilder 错误信息的构建工具 注在CSDN和大牛博客中不乏关于Web应用的统一异常处理的教程但更多的是基础学习使用并不能投入实际项目使用为了让大家少走一些弯路和快速投入生产楼主根据官方源码和项目实践提炼出了核心工具类ErrorInfoBuilder 将构建异常信息的逻辑从异常处理器/控制器中抽离出来让大家通过短短几行代码就能获取丰富的异常信息更专注于业务开发 1. 统一异常处理器(GlobalErrorHandler) ControllerAdvice 限定范围 例如扫描某个控制层的包 ExceptionHandler 指定异常 例如指定处理运行异常。
具体如下
package com.hehe.error;
ControllerAdvicepublic class GlobalErrorHandler {private final static String DEFAULT_ERROR_VIEW error;//错误信息页Autowired private ErrorInfoBuilder errorInfoBuilder;//错误信息的构建工具/** * 根据业务规则,统一处理异常。 */ ExceptionHandler(Exception.class) ResponseBody public Object exceptionHandler(HttpServletRequest request, Throwable error) {//1.若为AJAX请求,则返回异常信息(JSON) if (isAjaxRequest(request)) { return errorInfoBuilder.getErrorInfo(request,error); } //2.其余请求,则返回指定的异常信息页(View). return new ModelAndView(DEFAULT_ERROR_VIEW, errorInfo, errorInfoBuilder.getErrorInfo(request, error)); }private boolean isAjaxRequest(HttpServletRequest request) {return XMLHttpRequest.equals(request.getHeader(X-Requested-With)); }
} 2. 统一异常信息ErrorInfo 虽然官方提供了ErrorAttributes来存储错误信息但其返回的是存储结构是MapString,Object为了更好的服务统一异常这里我们统一采用标准的ErrroInfo来记载错误信息。
package com.hehe.error;
public class ErrorInfo {private String time;//发生时间 private String url;//访问Url private String error;//错误类型 String stackTrace;//错误的堆栈轨迹 private int statusCode;//状态码 private String reasonPhrase;//状态码//Getters And Setters ...
} 3. 统一异常信息的构建工具ErrorInfoBuilder ErrorInfoBuilder 作为核心工具类其意义不言而喻重点API 获取错误/异常 通信状态 堆栈轨迹 注正确使用ErrorInfoBuilder可以让处理器减少80%的代码。总而言之ErrorInfoBuilder是个好东西值得大家细细琢磨
package com.hehe.error;
Order(Ordered.HIGHEST_PRECEDENCE)Componentpublic class ErrorInfoBuilder implements HandlerExceptionResolver, Ordered {/** * 错误KEY */ private final static String ERROR_NAME hehe.error;/** * 错误配置(ErrorConfiguration) */ private ErrorProperties errorProperties;public ErrorProperties getErrorProperties() { return errorProperties; }public void setErrorProperties(ErrorProperties errorProperties) { this.errorProperties errorProperties; }/** * 错误构造器 (Constructor) 传递配置属性server.xx - server.error.xx */ public ErrorInfoBuilder(ServerProperties serverProperties) { this.errorProperties serverProperties.getError(); }/** * 构建错误信息.(ErrorInfo) */ public ErrorInfo getErrorInfo(HttpServletRequest request) {return getErrorInfo(request, getError(request)); }/** * 构建错误信息.(ErrorInfo) */ public ErrorInfo getErrorInfo(HttpServletRequest request, Throwable error) { ErrorInfo errorInfo new ErrorInfo(); errorInfo.setTime(LocalDateTime.now().toString()); errorInfo.setUrl(request.getRequestURL().toString()); errorInfo.setError(error.toString()); errorInfo.setStatusCode(getHttpStatus(request).value()); errorInfo.setReasonPhrase(getHttpStatus(request).getReasonPhrase()); errorInfo.setStackTrace(getStackTraceInfo(error, isIncludeStackTrace(request))); return errorInfo; }/** * 获取错误.(Error/Exception) * * see DefaultErrorAttributes #addErrorDetails */ public Throwable getError(HttpServletRequest request) { //根据HandlerExceptionResolver接口方法来获取错误. Throwable error (Throwable) request.getAttribute(ERROR_NAME); //根据Request对象获取错误. if (error null) { error (Throwable) request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE); } //当获取错误非空,取出RootCause. if (error ! null) { while (error instanceof ServletException error.getCause() ! null) { error error.getCause(); } }//当获取错误为null,此时我们设置错误信息即可. else { String message (String) request.getAttribute(WebUtils.ERROR_MESSAGE_ATTRIBUTE); if (StringUtils.isEmpty(message)) { HttpStatus status getHttpStatus(request); message Unknown Exception But status.value() status.getReasonPhrase(); } error new Exception(message); } return error; }/** * 获取通信状态(HttpStatus) * * see AbstractErrorController #getStatus */ public HttpStatus getHttpStatus(HttpServletRequest request) { Integer statusCode (Integer) request.getAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE); try { return statusCode ! null ? HttpStatus.valueOf(statusCode) : HttpStatus.INTERNAL_SERVER_ERROR; } catch (Exception ex) { return HttpStatus.INTERNAL_SERVER_ERROR; } }/** * 获取堆栈轨迹(StackTrace) * * see DefaultErrorAttributes #addStackTrace */ public String getStackTraceInfo(Throwable error, boolean flag) { if (!flag) { return omitted; } StringWriter stackTrace new StringWriter(); error.printStackTrace(new PrintWriter(stackTrace)); stackTrace.flush(); return stackTrace.toString(); }/** * 判断是否包含堆栈轨迹.(isIncludeStackTrace) * * see BasicErrorController #isIncludeStackTrace */ public boolean isIncludeStackTrace(HttpServletRequest request) {//读取错误配置(server.error.include-stacktraceNEVER) IncludeStacktrace includeStacktrace errorProperties.getIncludeStacktrace();//情况1若IncludeStacktrace为ALWAYS if (includeStacktrace IncludeStacktrace.ALWAYS) { return true; } //情况2若请求参数含有trace if (includeStacktrace IncludeStacktrace.ON_TRACE_PARAM) { String parameter request.getParameter(trace); return parameter ! null !false.equals(parameter.toLowerCase()); } //情况3其它情况 return false; }/** * 保存错误/异常. * * see DispatcherServlet #processHandlerException 进行选举HandlerExceptionResolver */ Override public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Nullable Object handler, Exception ex) { request.setAttribute(ERROR_NAME, ex); return null; }/** * 提供优先级 或用于排序 */ Override public int getOrder() { return Ordered.HIGHEST_PRECEDENCE; }} 注ErrorBuilder之所以使用Order注解和实现HandlerExceptionResolver接口是为了获取错误/异常通常情况下ExceptionHandler并不需要这么做因为在映射方法注入Throwable就可以获得错误/异常这是主要是为了ErrorController根据Request对象快速获取错误/异常。 4. 控制层代码Controller 上述错误/异常处理器、错误信息、错误信息构建工具全部完成我们编写控制层代码来测试相关效果。
package com.hehe;
SpringBootApplicationRestControllerpublic class ErrorHandlerApplication { /** * 随机抛出异常 */ private void randomException() throws Exception { Exception[] exceptions { //异常集合 new NullPointerException(), new ArrayIndexOutOfBoundsException(), new NumberFormatException(), new SQLException()}; //发生概率 double probability 0.75; if (Math.random() probability) { //情况1要么抛出异常 throw exceptions[(int) (Math.random() * exceptions.length)]; } else { //情况2要么继续运行 }}/** * 模拟用户数据访问 */ GetMapping(/) public List index() throws Exception { randomException(); return Arrays.asList(正常用户数据1!, 正常用户数据2! 请按F5刷新!!); }public static void main(String[] args) { SpringApplication.run(ErrorHandlerApplication.class, args); }} 5. 页面代码Thymeleaf 代码完成之后我们需要编写一个异常信息页面。为了方便演示我们在resources目录下创建templates目录并新建文件exception.html。页面代码如下
!DOCTYPE htmlhtml xmlns:thhttp://www.thymeleaf.orghead titleGlobalError/title/headh1统一祖国 振兴中华/h1h2服务异常请稍后再试。/h2div th:object${errorInfo} h3 th:text*{发生时间time}/h3 h3 th:text*{访问地址url}/h3 h3 th:text*{问题类型error}/h3 h3 th:text*{通信状态statusCode,reasonPhrase}/h3 h3 th:text*{堆栈信息stackTrace}/h3/div/body/html 注SpringBoot默认支持很多种模板引擎如Thymeleaf、FreeMarker并提供了相应的自动配置做到开箱即用。默认的页面加载路径是 src/main/resources/templates 如果放到其它目录需在配置文件指定。举例spring.thymeleaf.prefixclasspath:/views/ 6. 引入依赖POM文件 以前操作之前不要忘了在pom.xml 引入相关依赖
?xml version1.0 encodingUTF-8?project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd modelVersion4.0.0/modelVersion !--基本信息 -- groupIdcom.hehe/groupId artifactIdspringboot-error-handler/artifactId version0.0.1-SNAPSHOT/version packagingjar/packaging namespring-boot-error-handler/name descriptionSpringBoot 统一异常处理/description!--继承信息 -- parent groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-parent/artifactId version2.0.0.M4/version relativePath/ /parent!--依赖管理 -- dependencies dependency !--添加Web依赖 -- groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency dependency !--添加Thymeleaf依赖 -- groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-thymeleaf/artifactId /dependency dependency!--添加Test依赖 -- groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-test/artifactId scopetest/scope /dependency /dependencies!--指定远程仓库含插件-- repositories repository idspring-snapshots/id urlhttp://repo.spring.io/snapshot/url snapshots enabledtrue/enabled /snapshots /repository repository idspring-milestones/id urlhttp://repo.spring.io/milestone/url /repository /repositories pluginRepositories pluginRepository idspring-snapshots/id urlhttp://repo.spring.io/snapshot/url /pluginRepository pluginRepository idspring-milestones/id urlhttp://repo.spring.io/milestone/url /pluginRepository /pluginRepositories!--构建插件 -- build plugins plugin groupIdorg.springframework.boot/groupId artifactIdspring-boot-maven-plugin/artifactId /plugin /plugins /build/project 7. 开始测试 上述步骤完成之后打开启动类GlobalExceptionApplication启动项目然后进行测试。本案例-项目结构图如下 三. 使用ExceptionHandler的不足之处 关于实现Web应用统一异常处理的两种方法比较 特性ExceptionHandlerErrorController获取异常通过方法参数注入通过ErrorInfoBuilder获取返回类型若请求的类型为Ajax则返回JSON否则返回页面.若请求的媒介类型为HTML 则返回页面 否则返回JSON.缺点无法处理404类异常很强大可处理全部错误/异常 1. 使用ExceptionHandler 为什么无法处理404错误/异常 答因为SpringMVC优先处理Try Catch掉了资源映射不存在的404类错误/异常虽然在响应信息注入了404的HttpStatus通信信息但木有了异常肯定不会进入ExceptionHandler 的处理逻辑。 2. 使用ExceptionHandler 抛出异常 是否可取 答由上图可知ExceptionHanlder的最大不足之处是无法直接捕获404背后的异常网上流传通过取消资源目录映射来解决无404问题是不可取的属于越俎代庖的做法。
spring.mvc.throw-exception-if-no-handler-foundtruespring.resources.add-mappingsfalse 3. 为什么推荐ErrorController 替代 ExceptionHandler ? 使用ErrorController可以处理 全部错误/异常 。 使用ErrorControllerErrorInfoBuilder 在单个方法里面可以针对不同的Exception来添加详细的错误信息具体做法拓展ErrorInfoBuilder的getErrorInfo方法来添加错误信息例如ex instanceof NullPointerException Set xxx。 注意实际上目前SpringBoot官方就是通过ErrorController来做的统一错误/异常处理但遗憾的是关于这方面的官方文档并没有给出详细示例仅仅是一笔带过大概官方认为ExceptionHandler 够用而网上也甚少人具体提及ErrorController和ErrorAttribute 背后一整套的实现逻辑也正是如此促使楼主决心写下这篇文章希望给大家带来帮助少走一些弯路 四. 使用ErrorController替代ExceptionHandler 4. 如何快速使用 ErrorController 回答经过楼主的精心设计ErrorInfoBuilder 可以无缝对接ErrorController 即上述两种错误/异常处理均共用此工具类你只需要做的是将本案例的ErrorInfo和ErrorInfoBuilder 拷贝进项目简单编写ErrorController 跳转页面和返回JSON即可。具体如下 RequestMapping(produces MediaType.TEXT_HTML_VALUE) 说明produces属性作为匹配规则表示Request请求的Accept头部需含有text/html。
用途text/html 主要用于响应普通的页面请求与AJAX请求作为区分。
package com.hehe.error;
ControllerRequestMapping(${server.error.path:/error})public class GlobalErrorController implements ErrorController {
Autowired private ErrorInfoBuilder errorInfoBuilder;//错误信息的构建工具.private final static String DEFAULT_ERROR_VIEW error;//错误信息页/** * 情况1若预期返回类型为text/html,则返回错误信息页(View). */ RequestMapping(produces MediaType.TEXT_HTML_VALUE) public ModelAndView errorHtml(HttpServletRequest request) { return new ModelAndView(DEFAULT_ERROR_VIEW, errorInfo, errorInfoBuilder.getErrorInfo(request)); }/** * 情况2其它预期类型 则返回详细的错误信息(JSON). */ RequestMapping ResponseBody public ErrorInfo error(HttpServletRequest request) { return errorInfoBuilder.getErrorInfo(request); }Override public String getErrorPath() {//获取映射路径 return errorInfoBuilder.getErrorProperties().getPath(); }} 注是不是非常简单相信这个工具类可以改变你对ErrorController复杂难用的看法。如果后续想拓展不同种类的错误/异常信息只需修改ErrorInfoBuilder#getError方法即可无需修改ErrorController的代码十分方便。
