在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) {
// 处理异常的代码
}本文参与 腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。
原始发表：2020/07/03 ，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
腾讯云开发者
