热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

springboot事务抛出异常_SpringBoot(四)异常处理

一、参数校验错误1.注解校验注解校验的常见形式是,在JavaBean类中添加javax.validation校验注解,在控制器方法参数前添加Valida

一、参数校验错误

1. 注解校验注解校验的常见形式是,在JavaBean类中添加javax.validation校验注解,在控制器方法参数前添加@Validated注解,当Spring MVC将请求参数解析为控制器方法参数时会触发校验:

@Datapublic class User { @NotEmpty private String name; @Email private String email;}@Controller@RequestMapping("/user")public class UserController { @PostMapping public String create(@Validated User user) { // other code return "success-page"; }}

当参数校验失败时,默认会抛出BindingException异常。可以选择全局处理该异常,但更简单灵活的方法是使用绑定结果上下文BindingResult。在具有@Validated注解的参数后定义BindingResult参数,Spring MVC便会将校验结果保存在该参数中,而不是抛出异常。随后,可以在控制器方法中获取校验结果并处理它:

@PostMappingpublic String create(@Validated User user, BindingResult br) { // 如果参数无效,则转发至当前页面 if(br.hasErrors()) { return "user-registration"; } // other code return "success-page";}BindingResult实例会自动保存在Model中。使用模板引擎时,可以在模板中轻松获取并渲染错误信息。例如在thymeleaf模板中,使用下述模板语法判断是否校验失败,并显示所有错误信息:

if="${#fields.hasErrors('*')}"> "err : ${#fields.errors('*')}" th:text="${err}">

或是为输入非法值的文本框添加一个错误CSS类,并在文本框下显式对应的错误信息:

type=

"*{name}">

2. 业务校验

注解校验足够简洁易用,但不适合处理复杂的校验逻辑。当业务逻辑复杂时,不可避免的需要编写额外的校验代码。当校验失败时,可以向BindingResult注入错误信息,使自定义的校验代码与注解校验统一:

@PostMappingpublic String create(@Validated User user, BindingResult br) { // 如果参数无效,则转发至当前页面 if (br.hasErrors()) { return "user-registration"; } if ("张三".equals(user.getName())) { // 注入与字段相关的错误消息 br.rejectValue("name", "FIELD-MSG-0001"); return "user-registration"; } if ("李四".equals(user.getName()) && Objects.isNull(user.getEmail())) { // 注入全局的错误消息        br.reject("GLOBAL-MSG-0001"); return "user-registration"; } // other code return "success-page";}

BindingResult会在MessageSource中找到错误码对应的消息:

# messages.propertiesFIELD-MSG-0001 = 张三被系统拉黑了。GLOBAL-MSG-0001     = 李四没有邮箱。


二、 业务层异常

每个业务层方法通常是一个事务单元。在业务校验失败时,需要抛出异常回滚事务:

@Getterpublic class BussinessException extends RuntimeException { private static final long serialVersionUID = -3087418646815345707L; private String errorCode; public BussinessException(String errorCode) { super("发生了业务异常:" + errorCode); this.errorCode = errorCode; }}@Servicepublic class UserService { @Autowired private UserMapper mapper; @Transactional public void createUser(User user) { User existingUser = mapper.selectByName(user.getName()); if(Objects.nonNull(existingUser)) { throw new BusinessException("BUSINESS-ERROR-0001"); } mapper.insert(user); }}如果不显式的捕获异常,Spring MVC会丢弃当前的Model,防止处于错误状态的数据被继续使用。接下来,Spring Boot会将请求转发到错误页面,并将状态码设定为500。对于有状态服务端,如果只是希望停留在当前页面,并向用户反馈错误信息,需要在Web层显式的捕获异常并处理:

@PostMappingpublic String create(@Validated User user, BindingResult br) { if (br.hasErrors()) { return "user-registration"; } // 发生业务异常时,注入错误消息,转发至当前页面 try { service.createUser(user); } catch (BusinessException e) { br.reject(e.getErrorCode()); return "user-registration"; } // other code return "success-page";}


三、全局异常Spring Boot提供了异常处理控制器BasicErrorController映射到/error,它以一种明智的方式处理从Web层抛出的异常:对于媒体类型为HTML的请求,它将返回错误页面;如果是其他的媒体类型(通常是JSON),它将返回JSON格式的错误信息。1、定制错误页面首先在控制器中写一段会抛出空指针异常的代码:

@PostMappingpublic String create(User user) { String a = null;    a.getBytes(); return "success-page";}以post方法访问/user,该控制器抛出空指针异常后,请求被转发至/error,由BasicErrorController处理,返回whitelabel视图作为错误页面:8fa87e4c3fcd5604a1ad9751b426b48f.png

这是由于BasicErrorController在创建错误视图时,资源路径下寻找名为error.html的视图文件。如果没有找到,则返回“whitelabel”视图。因此,可以通过提供error.html定制错误页面的视图:

自定义的错误页面title>head>

status: [[${status}]]h1>
错误信息:[[${message}]]h5>body>html>

重启服务后,再次以post方法访问/user,会返回定制的错误页面:

c47dacc838d15fa891bbc2be1860f8a4.png

视图文件既可以是存放于templates目录下的模板文件,也可以是存放在static目录下的静态html文件。Spring Boot还提供了错误视图解析器DefaultErrorViewResolver,用于根据Http状态码使用不同的错误视图。DefaultErrorViewResolver在/templates/error或/static/error下匹配视图,具有两种匹配模式:
  • 视图文件名是具体的Http状态码。例如404.html,当发生404错误时,使用该视图文件。

  • 视图文件名以某一类Http状态码开头,例如5xx.html。当发生5开头的错误时(例如500),使用该视图文件。

在templates下创建错误视图目录error,在error下创建404错误专用的视图模板404.html,和5开头的错误通用的视图模板5xx.html:

404title>head>页面未找到!body>html> 5xxtitle>head>服务端错误:[[${status}]]body>html>启动服务,访问不存在的路径时,显示404页面:497c4dff434f81595946a321ce994714.png以post方法访问/user,显示5xx页面:ae7d8e8f4b8e73102a4d96d6107fa4bc.png综上所述,当发生异常时,Spring Boot首先根据Http状态码寻找匹配的视图,如果没找到,再寻找名为error的视图,如果仍没有找到,则返回whitelabel视图。2、JSON响应当Content-Type为application/json的请求发生异常时,Spring Boot将响应JSON格式的错误信息。使用JQuery的ajaxError函数处理全局ajax异常:

$( document ).ajaxError(function( event, request, settings, thrownError) { var res = request.responseJSON; // 在body中输出json错误信息 $('body').html('

' + JSON.stringify(res, null, 4) + ' });

创建submit事件监听器,向/user发起ajax请求:

$(document).on('submit', function() { $.ajax({ type: "POST", url: 'user', contentType: "application/json; charset=utf-8", data: JSON.stringify({}), success: function (res) { alert("成功!"); } }); return false; });

提交后,请求被转发至/error由BasicErrorController处理,它将响应json格式的错误信息:

db2e969af03b89916769c3a5dafb63ff.png
四、处理特定异常

在具有@Controller或@ControllerAdvice注解的类中,可以使用@ExceptionHandler定制特定于某种异常的处理,而不是使用BasicErrorController。

例如,发生特定异常时,在跳转到错误页面前打印日志:

@ControllerAdvice@Slf4jpublic class GlobalControllerAdvice { @Autowired private MessageSource messageSource; @ExceptionHandler(BussinessException.class) public String handleBussinessException( BussinessException e, HandlerMethod method, Locale locale) { var methodName = method.getShortLogMessage(); var exName = e.getClass().getName(); log.warn(MessageFormat.format("在{0}中发生了{1}异常", methodName, exName)); var errorCode = e.getErrorCode(); var message = messageSource.getMessage(e.getErrorCode(), null, locale); log.warn(MessageFormat.format("[{0}]{1}", errorCode, message)); return "/bussiness-error"; }}

发生异常时,将打印下述log:

2020-11-14 17:07:24.423 WARN 15768 --- [nio-8080-exec-3] c.c.w.d.w.c.GlobalControllerAdvice : 在com.cn.wjw.demo.web.controller.UserController#create[0 args]中发生了com.cn.wjw.demo.exception.BussinessException异常2020-11-14 17:07:24.423 WARN 15768 --- [nio-8080-exec-3] c.c.w.d.w.c.GlobalControllerAdvice : [E00001]其他用户已经更新了数据,请刷新页面。

当然,也可以继续利用BasicErrorController,但在向客户端响应之前做额外的处理。只需要在@ExceptionHandler中实现额外的处理,最后将请求转发到/error,或是将正在处理的异常重新抛出:

@ExceptionHandler(Throwable.class) public void handleException(Throwable t) throws Throwable { // TODO 在这里实现额外的逻辑,然后重新抛出异常 throw t; }




推荐阅读
author-avatar
无为2502863873
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有