在SpringMVC中统一处理异常

简介: 在SpringMVC中统一处理异常

在SpringMVC中,允许开发人员自定义方法,用于统一处理异常,以至于某些异常可能在多种处理请求的过程中都可能出现,但是,只需要编写1次处理的代码即可!


该机制的核心在于:可能出现异常的、处理请求的方法,并不通过代码显式的处理异常!则等同于这些处理请求的方法会将异常抛出,而SpringMVC框架在调用这些处理请求的方法时,会捕获这些异常,此时,如果开发人员自定义了处理异常的方法,则SpringMVC会在捕获到异常之后,调用处理异常的方法。


关于统一处理异常的方法,其声明原则:


访问权限:应该使用public权限;


返回值类型:与处理请求的方法的返回值设计原则相同;


方法名称:自定义;


参数列表:必须添加1个异常类型的参数,以表示需要处理的异常对象;还可以按需添加HttpServletRequest、HttpServletResponse对象等,但是,不可以随意添加参数;


注解:必须添加@ExceptionHandler注解。


例如,可以设计为:


@ExceptionHandler
public JsonResult<Void> aaaaa(Throwable e) {
    JsonResult<Void> jsonResult = new JsonResult<>();
    if (e instanceof UsernameDuplicateException) {
        jsonResult.setState(2);
        jsonResult.setMessage("注册失败!用户名已经被占用!");
    } else if (e instanceof InsertException) {
        jsonResult.setState(3);
        jsonResult.setMessage("注册失败!插入用户数据错误!");
    } else {
        jsonResult.setState(998);
        jsonResult.setMessage("操作失败!出现了不可识别的问题,请联系系统管理员!");
    }
    return jsonResult;
}


注意:当统一处理异常的代码在某个控制器类的内部时,只能作用于当前控制器类中抛出的异常!


如果需要统一处理异常的代码能够处理所有控制器类中的异常,可选的解决方法有:


创建控制器类的基类(所有控制器类的共同父类),将统一处理异常的代码放在基类中;

自定义某个类,将统一处理异常的代码放在这个类中,并为这个类添加@ControllerAdvice注解或@RestControllerAdvice注解;

例如,采取以上第2种做法时,代码示例:


package cn.tedu.store.controller;
@RestControllerAdvice
public class GlobalExceptionHandler {
  @ExceptionHandler
  public JsonResult<Void> handleException(Throwable e) {
  JsonResult<Void> jsonResult = new JsonResult<>();
  if (e instanceof UsernameDuplicateException) {
    jsonResult.setState(2);
    jsonResult.setMessage("注册失败!用户名已经被占用!");
  } else if (e instanceof InsertException) {
    jsonResult.setState(3);
    jsonResult.setMessage("注册失败!插入用户数据错误!");
  } else {
    jsonResult.setState(998);
    jsonResult.setMessage("操作失败!出现了不可识别的问题,请联系系统管理员!");
  }
  return jsonResult;
  }
}


以上使用到的@ExceptionHandler注解的源代码:


@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {
  /**
  * Exceptions handled by the annotated method. If empty, will default to any
  * exceptions listed in the method argument list.
  */
  Class<? extends Throwable>[] value() default {};
}


注解中的value属性是异常类型的数组,其作用是:被添加注解的方法处理的异常的种类,如果该属性值为空,将对应处理异常的方法的参数列表中所有异常!


也就是说,如果代码是:


@ExceptionHandler
public JsonResult<Void> handleException(Throwable e) {
  // 处理异常的代码
}


则表示handleException()将处理Throwable类型的异常!


如果代码是:


@ExceptionHandler
public JsonResult<Void> handleException(RuntimeException e) {
  // 处理异常的代码
}


则表示handleException()将处理RuntimeException类型的异常,而其它类型的,例如IOException等异常将不会被该方法处理!


如果在一个项目中,多种不同的异常有不同的处理方式,可以创建多个处理异常的方法,并且,通过方法的参数或配置@ExceptionHandler注解的参数,来指定需要被处理的异常的种类。


通常,推荐通过注解参数来指定被处理的异常的种类,例如:


@ExceptionHandler({UsernameDuplicateException.class, InsertException.class})
public JsonResult<Void> handleException(Throwable e) {
  // 处理异常的代码
}

或:


@ExceptionHandler({ServiceException.class})
public JsonResult<Void> handleException(Throwable e) {
  // 处理异常的代码
}
目录
相关文章
|
8天前
|
设计模式 前端开发 Java
步步深入SpringMvc DispatcherServlet源码掌握springmvc全流程原理
通过对 `DispatcherServlet`源码的深入剖析,我们了解了SpringMVC请求处理的全流程。`DispatcherServlet`作为前端控制器,负责请求的接收和分发,处理器映射和适配负责将请求分派到具体的处理器方法,视图解析器负责生成和渲染视图。理解这些核心组件及其交互原理,有助于开发者更好地使用和扩展SpringMVC框架。
23 4
|
26天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
80 2
|
2月前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
2月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
65 2
|
3月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
|
2月前
|
XML 前端开发 Java
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
本文阐述了Spring、Spring Boot和Spring MVC的关系与区别,指出Spring是一个轻量级、一站式、模块化的应用程序开发框架,Spring MVC是Spring的一个子框架,专注于Web应用和网络接口开发,而Spring Boot则是对Spring的封装,用于简化Spring应用的开发。
189 0
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
|
3月前
|
XML 缓存 前端开发
springMVC02,restful风格,请求转发和重定向
文章介绍了RESTful风格的基本概念和特点,并展示了如何使用SpringMVC实现RESTful风格的请求处理。同时,文章还讨论了SpringMVC中的请求转发和重定向的实现方式,并通过具体代码示例进行了说明。
springMVC02,restful风格,请求转发和重定向
|
4月前
|
Java 数据库连接 Spring
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
文章是关于Spring、SpringMVC、Mybatis三个后端框架的超详细入门教程,包括基础知识讲解、代码案例及SSM框架整合的实战应用,旨在帮助读者全面理解并掌握这些框架的使用。
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
|
4月前
|
XML JSON 数据库
SpringMVC入门到实战------七、RESTful的详细介绍和使用 具体代码案例分析(一)
这篇文章详细介绍了RESTful的概念、实现方式,以及如何在SpringMVC中使用HiddenHttpMethodFilter来处理PUT和DELETE请求,并通过具体代码案例分析了RESTful的使用。
SpringMVC入门到实战------七、RESTful的详细介绍和使用 具体代码案例分析(一)
|
4月前
|
前端开发 应用服务中间件 数据库
SpringMVC入门到实战------八、RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查
这篇文章通过一个具体的项目案例,详细讲解了如何使用SpringMVC、Thymeleaf、Bootstrap以及RESTful风格接口来实现员工信息的增删改查功能。文章提供了项目结构、配置文件、控制器、数据访问对象、实体类和前端页面的完整源码,并展示了实现效果的截图。项目的目的是锻炼使用RESTful风格的接口开发,虽然数据是假数据并未连接数据库,但提供了一个很好的实践机会。文章最后强调了这一章节主要是为了练习RESTful,其他方面暂不考虑。
SpringMVC入门到实战------八、RESTful案例。SpringMVC+thymeleaf+BootStrap+RestFul实现员工信息的增删改查