如保做网站赢利,专门做问卷的网站,wordpress模板 简单,网络空间测绘前言
全局的异常处理是Java后端不可或缺的一部分#xff0c;可以提高代码的健壮性和可维护性。 在我们的开发中#xff0c;总是难免会碰到一些未经处理的异常#xff0c;假如没有做全局异常处理#xff0c;那么我们返回给用户的信息应该是不友好的#xff0c;很抽象的可以提高代码的健壮性和可维护性。 在我们的开发中总是难免会碰到一些未经处理的异常假如没有做全局异常处理那么我们返回给用户的信息应该是不友好的很抽象的用户会认为我们的程序是不安全的。 相反如果有了全局异常处理那么我们就可以给用户提供更友好的反馈。 我们甚至可以把全局异常处理写到简历上比如说你可以这样描述:项目采用了 HandlerExceptionResolver(或者 ControllerAdvice 方案)的全局异常处理策略提高了代码的健壮性和可维护性优化了用户体验。 我会结合具体的业务场景给大家一种身临其境的感觉()讲一讲HandlerExceptionResolver 和 ControllerAdvice 具体怎么在项目中使用。 业务场景 技术派整合了Redis比如用户登录的时候会从Redis中获取缓存那假如我们没有启动Redis服务呢 然后我们在本地启动技术派的服务端。 然后点击登录 -一键登录。 然后就会收到这样一条提示信息。 由于我们项目是开源的所以这里就直接把服务端的信息返回出来好让大家第一时间辨别出是哪里出了问题可以及时去调整。 当你看到这样一条错误提示第一时间就能明白哦原来是 Redis 没有启动啊。 在服务器端的控制台面板中(错误堆栈信息中)可以找到对应的错误信恙。 其中 ForumExceptionHandler 就是用来进行全局异常处理的它是HandlerExceptionResolver 接囗的实现类 HandlerExceptionResolver HandlerExceptionResolver 是 Spring 提供的一种异常处理机制它允许我们在应用程序中以统一的方式处理控制器方法引发的异常。 要使用 HandlerExceptionResolver我们需要创建一个实现该接口的类并在其中定义如何处理异常。例如: Slf4j
Order(-100)
public class ForumExceptionHandler implements HandlerExceptionResolver {Overridepublic ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {} Slf4j 是 lombok 提供的一个日志注解。0rder 注解用于指定 Spring 中组件的加载顺序。它接受一个整数值数值越小组件的优先级越高加载顺序越靠前。在 resolveException 方法中我们可以自定义异常处理逻辑根据异常类型返回不同的 ModelAndView。 我们来看一下 resolveException 方法中的具体写法: Override
public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {Status errStatus buildToastMsg(ex);if (restResponse(request, response)) {// 表示返回json数据格式的异常提示信息if (response.isCommitted()) {// 如果返回已经提交过直接退出即可return new ModelAndView();}try {response.reset();// 若是rest接口请求异常时返回json格式的异常数据而不是专门的500页面response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);response.setHeader(Cache-Control, no-cache, must-revalidate);response.getWriter().println(JsonUtil.toStr(ResVo.fail(errStatus)));response.getWriter().flush();response.getWriter().close();return new ModelAndView();} catch (Exception e) {throw new RuntimeException(e);}}String view getErrorPage(errStatus, response);ModelAndView mv new ModelAndView(view);response.setContentType(MediaType.TEXT_HTML_VALUE);mv.getModel().put(global, SpringUtil.getBean(GlobalInitService.class).globalAttr());mv.getModel().put(res, ResVo.fail(errStatus));mv.getModel().put(toast, JsonUtil.toStr(ResVo.fail(errStatus)));return mv;
} 技术派做了两种处理一种是REST接口请求的异常一种是针对普通页请求的异常。 1、如果是 REST 接口请求异常代码会返回一个 JSON 格式的异常提示信息: 首先检查响应是否已经提交如果已经提交则直接返回一个空的 ModelAndView。如果响应未提交将重置响应对象设置响应的内容类型为JSON并添加相关的响应头。使用 response.getwriter()将异常状态对象 errStatus 转换为 JSON 格式并写入响应。完成后返回一个空的 ModelAndView。 ②、如果是普通页面请求异常代码会返回一个包含错误信息的 HTML 页面: 根据异常状态对象 errStatus 和响应对象 response 获取错误页面的视图名称。创建-个 ModelAndView 对象并设置视图名称。设置响应的内容类型为 HTML。向 ModelAndView 中添加全局属性、错误响应对象以及错误信息(以JSON 格式)最后返回这个 ModelAndView 对象用于展示错误页面。 下图是当遇到 404 错误的时候返回的 404 页面。 其中 buildToastMsg 方法用来对异常进行分类使用 instanceof 关键字来判断不同类型的异常添加不同的异常码和提示消息。 private Status buildToastMsg(Exception ex) {
if (ex instanceof ForumException) {return ((ForumException) ex).getStatus();
} else if (ex instanceof AsyncRequestTimeoutException) {return Status.newStatus(StatusEnum.UNEXPECT_ERROR, 超时未登录);
} else if (ex instanceof HttpMediaTypeNotAcceptableException) {return Status.newStatus(StatusEnum.RECORDS_NOT_EXISTS, ExceptionUtils.getStackTrace(ex));
} else if (ex instanceof HttpRequestMethodNotSupportedException || ex instanceof MethodArgumentTypeMismatchException || ex instanceof IOException) {// 请求方法不匹配return Status.newStatus(StatusEnum.ILLEGAL_ARGUMENTS, ExceptionUtils.getStackTrace(ex));
} else if (ex instanceof NestedRuntimeException) {log.error(unexpect NestedRuntimeException error! {}, ReqInfoContext.getReqInfo(), ex);return Status.newStatus(StatusEnum.UNEXPECT_ERROR, ex.getMessage());
} else {log.error(unexpect error! {}, ReqInfoContext.getReqInfo(), ex);return Status.newStatus(StatusEnum.UNEXPECT_ERROR, ExceptionUtils.getStackTrace(ex));
}
} StatusEnum 中定义了异常码的规范举几个例子。 /*** 异常码规范* xxx - xxx - xxx* 业务 - 状态 - code* p* 业务取值* - 100 全局* - 200 文章相关* - 300 评论相关* - 400 用户相关* p* 状态基于http status的含义* - 4xx 调用方使用姿势问题* - 5xx 服务内部问题* p* code: 具体的业务code*/
Getter
public enum StatusEnum {SUCCESS(0, OK),// -------------------------------- 通用// 全局传参异常ILLEGAL_ARGUMENTS(100_400_001, 参数异常),ILLEGAL_ARGUMENTS_MIXED(100_400_002, 参数异常:%s),// 全局权限相关FORBID_ERROR(100_403_001, 无权限),
} getErrorPage 方法用于返回不同的错误页面比如常见的 404 Not Found(请求的资源不存在服务器无法找到请求的资源)、403 Forbidden(服务器理解请求但是拒绝处理它一般是由于权限问题或者访问被拒绝)500 lnternal Server Error(服务器发生了错误无法完成请求)等。 private String getErrorPage(Status status, HttpServletResponse response) {// 根据异常码解析需要返回的错误页面if (StatusEnum.is5xx(status.getCode())) {response.setStatus(500);return error/500;} else if (StatusEnum.is403(status.getCode())) {response.setStatus(403);return error/403;} else {response.setStatus(404);return error/404;}
}
restResponse 方法用来判断是否是 REST 请求比如说 admin 后台请求、api数据请求、上传图片等接口
Ajax 请求等这些请求统一返回 JSON 格式的异常提示信息否则返回普通的页面格式的异常提示信息。 **
* 后台请求、api数据请求、上传图片等接口返回json格式的异常提示信息
* 其他异常返回500的页面
*
* param request
* param response
* return
*/
private boolean restResponse(HttpServletRequest request, HttpServletResponse response) {if (request.getRequestURI().startsWith(/api/admin/) || request.getRequestURI().startsWith(/admin/)) {return true;}if (request.getRequestURI().startsWith(/image/upload)) {return true;}if (response.getContentType() ! null response.getContentType().contains(MediaType.APPLICATION_JSON_VALUE)) {return true;}if (isAjaxRequest(request)) {return true;}// 数据接口请求AntPathMatcher pathMatcher new AntPathMatcher();if (pathMatcher.match(/**/api/**, request.getRequestURI())) {return true;}return false;
} 再来看一下自定义的异常类 ForumException非常简单继承了 RuntimeException。 /*** 业务异常**/
public class ForumException extends RuntimeException {Getterprivate Status status;public ForumException(Status status) {this.status status;}public ForumException(int code, String msg) {this.status Status.newStatus(code, msg);}public ForumException(StatusEnum statusEnum, Object... args) {this.status Status.newStatus(statusEnum, args);}} HandlerExceptionResolver 的工作原理主要基于 Spring MVC 的异常处理流程。当一个请求进入 Spring MVC后它会根据请求信息找到对应的处理器(handler也就是Controller)。在Controller 执行过程中如果抛出了异常Spring MVC 就会启动异常处理流程。 1)异常发生:当 Controller 执行过程中抛出异常Spring MVC 捕获到这个异常后会进入异常处理流程 2)查找异常解析器:Spring MVC 会遍历所有已注册的 HandlerExceptionResolver 实现。比如说我们自定义的
ForumExceptionHandlerSpring MVC 本身也提供了一些默认的实现比如DefaultHandlerExceptionResolver、ExceptionHandlerExceptionResolver. 3)执行异常解析器:对于每个 HandlerExceptionResolver 实现Spring MVC会调用它的 resolveException方法并传入请求、响应、处理器和异常对象。如果解析器能处理这个异常它会返回一个非空的ModelAndView 对象。这个对象封装了异常处理后的视图和模型数据。 4)处理返回结果:当 resolveException 方法返回一个非空的 ModelAndView 对象时Spring MVC 会将这个对象用于生成最终的响应。可能渲染一个错误视图、设置响应状态码等。如果所有的HandlerExceptionResolver 都无法处理这个异常(即都返回了空的 ModelAndView对象)那么 SpringMVC 会将异常重新抛出以便其他异常处理器(如 Servet 容器)进行处理。 通过这个流程HandlerExceptionResolver 能够在 Spring MVC 中统一管理和处理异常。记得在 Spring Boot的启动类中将自定义的 HandlerExceptionResolver 添加到 Spring 配置中。 Slf4j
EnableAsync
EnableScheduling
EnableCaching
ServletComponentScan //与WebFilter(urlPatterns /*, filterName reqRecordFilter, asyncSupported true)注解配套
SpringBootApplication
public class QuickForumApplication implements WebMvcConfigurer, ApplicationRunner {Overridepublic void configureHandlerExceptionResolvers(ListHandlerExceptionResolver resolvers) {resolvers.add(0, new ForumExceptionHandler());}
} ControllerAdvice 除了 HandlerExceptionResolver全局异常还可以采用 ControllerAdvice 注解的方式。它可以将通用的操作和逻辑抽离出来避免在每个控制器中重复相同的操作。 第一步新建一个自定义的异常类 ForumAdviceException。 /*** 业务异常**/
public class ForumAdviceException extends RuntimeException {Getterprivate Status status;public ForumAdviceException(Status status) {this.status status;}public ForumAdviceException(int code, String msg) {this.status Status.newStatus(code, msg);}public ForumAdviceException(StatusEnum statusEnum, Object... args) {this.status Status.newStatus(statusEnum, args);}}
Data
NoArgsConstructor
AllArgsConstructor
public class Status {/*** 业务状态码*/ApiModelProperty(value 状态码, 0表示成功返回其他异常返回, required true, example 0)private int code;/*** 描述信息*/ApiModelProperty(value 正确返回时为ok异常时为描述文案, required true, example ok)private String msg;public static Status newStatus(int code, String msg) {return new Status(code, msg);}public static Status newStatus(StatusEnum status, Object... msgs) {String msg;if (msgs.length 0) {msg String.format(status.getMsg(), msgs);} else {msg status.getMsg();}return newStatus(status.getCode(), msg);}
}第二步新建一个全局异常控制器 GlobalExceptionHandler内容如下所示。 RestControllerAdvice
public class GlobalExceptionHandler {ExceptionHandler(value ForumAdviceException.class)public ResVoString handleForumAdviceException(ForumAdviceException e) {return ResVo.fail(e.getStatus());}
} RestControllerAdvice 是一个特殊的 ControllerAdvice 注解适用于处理 RESTfu API 异常的情况。这意味着它将用于处理来自带有 RestController 注解的控制器抛出的异常。 此类中定义的方法 handleForumAdviceException 使用 ExceptionHandler 注解表示它将处理ForumAdviceException 类型的异常。 第三步加一个测试的控制器方法 testControllerAdvice。 RequestMapping(path testControllerAdvice)
ResponseBody
public String testControllerAdvice() {throw new ForumAdviceException(StatusEnum.ILLEGAL_ARGUMENTS_MIXED, 测试ControllerAdvice异常);
} 第四步如果之前在启动类中注册了 ForumExceptionHandler此时需要干掉。 第五步重启启动服务测试 testControllerAdvice 接口。
接口返回的内容如下所示 两种全局异常处理的优缺点 好我们来对比一下两种全局异常处理 HandlerExceptionResolver 和 ControllerAdvice(或RestControllerAdvice)的优缺点。 1、HandlerExceptionResolver HandlerExceptionResolver 是一个接口用于处理由 Controller 抛出的异常我们可以重写resolveException方法在其中实现该接口来自定义全局异常处理逻辑。然后在Spring Boot 的启动类中通过
extendHandlerExceptionResolvers 将自定义的 HandlerExceptionResolver 添加到解析器中。 优点:可以更加灵活地处理异常因为你可以编写任何处理逻辑。缺点:与其他 Spring MVC 组件的集成不够紧密需要手动添加和配置。 2、ControllerAdvice(或RestControllerAdvice) ControllerAdvice(或 RestControllerAdvice)是用于定义全局异常处理类的注解。在这个类中我们可以使用 ExceptionHandler 注解来处理不同类型的异常。ControllerAdvice 需要与 ExceptionHandler 注解一起使用。 优点:更容易实现和集成只需创建一个带有 ControllerAdvice(或 RestControllerAdvice)注解的类并使用 ExceptionHandler 注解定义异常处理方法。缺点:异常处理逻辑可能不如 HandlerxceptionResolver 那么灵活。 我们可以根据具体的需求和使用场景选择其中之一来实现全局异常处理。另外二者可以共存
ControllerAddvice优先级比HandlerExceptionResolver高也可以用order注解指定优先级。
