SpringBoot使用ExceptionHandler做异常处理

这篇文章主要介绍了SpringBoot使用ExceptionHandler做异常处理,这篇文章通过多种方法案例来介绍该项技术的使用,需要的朋友可以参考下

应用程序在运行过程中，会有大量需要处理的异常。在页面解析的一个工程中，会存在多个service类同时出现页面解析异常和解析结果入库异常，而这就表示在程序中需要一个机制，去统一处理这些异常，提供统一的异常处理。因为我设计这个结构的主要目的是为了简化代码。

在探寻spring的异常处理机制的时候，主要有三种方式来统一处理异常。三种方式都是使用的@ExceptionHandler注解。

@ExceptionHandler注解解释：
当一个Controller中有方法加了@ExceptionHandler之后，这个Controller其他方法中没有捕获的异常就会以参数的形式传入加了@ExceptionHandler注解的那个方法中。

三种方式都需要首先为自己的系统设计一个自定义的异常类，通过它来传递状态码，以及一些其他参数信息。

 public class ProcessException extends RuntimeException { private static final long serialVersionUID = 1L; // 任务明细ID protected String rwmxid; public ProcessException(String rwmxid) { this.rwmxid = rwmxid; } public String getRwmxid() { return rwmxid; } public void setRwmxid(String rwmxid) { this.rwmxid = rwmxid; } }

第一种思路，设计一个基类。类中使用@ExceptionHandler注解表明要做异常处理的方法

 /** * Created by liuruijie. * 处理异常的类，需要处理异常的Controller直接继承这个类 */ public class BaseController { /** * 处理Controller抛出的异常 * @param e 异常实例 * @return Controller层的返回值 */ @ExceptionHandler @ResponseBody public Object expHandler(Exception e){ if(e instanceof SystemException){ SystemException ex= (SystemException) e; return WebResult.buildResult().status(ex.getCode()) .msg(ex.getMessage()); }else{ e.printStackTrace(); return WebResult.buildResult().status(Config.FAIL) .msg("系统错误"); } } }

这种方式的缺点为：之后所有需要异常处理的Controller都继承这个类，从而获取到异常处理的方法。

虽然这种方式可以解决问题，但是极其不灵活，因为动用了继承机制就只为获取一个默认的方法，这显然是不好的。

第二种方式，将这个基类变为接口，提供此方法的默认实现（也就是接口中的default方法，java8开始支持接口方法的默认实现）

 /** * Created by liuruijie. * 接口形式的异常处理 */ public interface DataExceptionSolver { @ExceptionHandler @ResponseBody default Object exceptionHandler(Exception e){ try { throw e; } catch (SystemException systemException) { systemException.printStackTrace(); return WebResult.buildResult().status(systemException.getCode()) .msg(systemException.getMessage()); } catch (Exception e1){ e1.printStackTrace(); return WebResult.buildResult().status(Config.FAIL) .msg("系统错误"); } } }

这种方式虽然没有占用继承，但是也不是很优雅，因为几乎所有的Controller都需要进行异常处理，于是我每个Controller都需要去写implement DataExceptionSolver，这显然不是我真正想要的。况且这种方式依赖java8才有的语法，这是一个很大的局限。

第三种方式，使用加强Controller做全局异常处理。

所谓加强Controller就是@ControllerAdvice注解，有这个注解的类中的方法的某些注解会应用到所有的Controller里，其中就包括@ExceptionHandler注解。
于是可以写一个全局的异常处理类：

 /** * @ClassName ExceptionHandle * @Description 统一处理控制层的异常 * @date 2020年3月14日 上午9:55:41 * @version 1.0 */ @ControllerAdvice public class ExceptionHandle { private final Logger log = LoggerFactory.getLogger(getClass()); @ExceptionHandler(ParseException.class) public void parseException(ParseException ex) { ex.printStackTrace(); log.error("parseException ",ExceptionUtil.getMessage(ex)); Map paraMap = new HashMap(); paraMap.put("rwmxid", ex.getRwmxid()); CommonUtil.updateDataLog(paraMap); } @ExceptionHandler(ProcessException.class) public void processException(ProcessException ex) { ex.printStackTrace(); log.error("ProcessException ",ExceptionUtil.getMessage(ex)); Map paraMap = new HashMap(); paraMap.put("rwmxid", ex.getRwmxid()); CommonUtil.updateDataLog(paraMap); } @ExceptionHandler(Exception.class) @ResponseBody public TransEntity error(Exception ex) { ex.printStackTrace(); log.error("Exception ",ExceptionUtil.getMessage(ex)); return TransEntity.error(); } }

如此，我们现在的Controller中的方法就可以很简洁了：

 /** * Created by liuruijie on 2016/12/28. * 账号 */ @RestController @RequestMapping("passport") public class PassportController { PassportService passportService; @RequestMapping("login") public Object doLogin(HttpSession session, String username, String password){ User user = passportService.doLogin(username, password); session.setAttribute("user", user); return WebResult.buildResult().redirectUrl("/student/index"); } }

在passprotService的doLogin方法中，可能会抛出用户名或密码错误等异常，然后就会交由ExceptionHandle 去处理，直接返回异常信息给前端，然后前端也不需要关心是否返回了异常，因为这些都已经定义好了。

如果我们自定义了异常，也可以在指定抛出我们自定义的异常，然后在全局异常处理类中进行处理， @ExceptionHandler(ParseException.class) 表明，会处理抛出的 ParseException 异常。