spring boot学习系列之统一异常处理6

 3,764浏览     wenqyAdmin   

在写应用程序的时候遇到异常，我们自然而然会用try catch捕获异常处理，但这样到处捕获比较繁琐，代码也比较冗余，直接抛出异常又不大友好。这时就可以做个通用的异常处理。统一大部分的异常，也可以比较专注于业务。我们可以做个控制层切面，下层不断往上层抛，控制层上统一异常处理。

我们可以用@ControllerAdvice和@ExceptionHandler注解实现异常处理，应用抛出异常的时候跳转到一个友好的提示页面，以此规避页面上打印出大量异常堆栈信息，影响体验不说，还有可能被有心的骇客用来分析系统漏洞。如果前端Ajax异步化，也可以统一异常信息，返回json等格式的数据。@ControllerAdvice注解捕获控制层的异常，所有对于DAO、Service层不想吃掉的异常都要往上抛。@ExceptionHandler定义方法处理的异常类型，最后将Exception对象和请求URL映射到相应的异常界面中，这适应Spring Mvc控制层那一套，如果是异步，加个@ResponseBody注解，返回异常对象。

定义一个全局异常处理类，捕获异常，将操作用户信息和异常信息插入异常日志表。

异常处理类

  1. /**
  2.  * 统一异常处理
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @ControllerAdvice
  8. public class GlobalExceptionHandler {
  10.     private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  12.     @Autowired
  13.     ExceptionLogExecutors executors;
  15.     /**
  16.      * 403 异常
  17.      */
  18. //  @ExceptionHandler({ UnauthorizedException.class })
  19. //  public String unauthorized(UnauthorizedException ue) {
  20. //      return “error/403”;
  21. //  }
  23.     /**
  24.      * 405 异常
  25.      * @param ue
  26.      * @return
  27.      * @author wenqy
  28.      */
  29.     @ExceptionHandler({ HttpRequestMethodNotSupportedException.class })
  30.     public String notSupportedException(HttpRequestMethodNotSupportedException ue) {
  31.         return “error/405”;
  32.     }
  34.     @ExceptionHandler({ MyBusinessException.class })
  35.     public String serviceException(MyBusinessException se, Model model) {
  36.         logger.error(“业务异常:” + se.getMessage(), se);
  37.         model.addAttribute(“message”, se.getMessage());
  38.         return “error/businessception”;
  39.     }
  41.     /**
  42.      * 服务器异常
  43.      * @param throwable
  44.      * @param model
  45.      * @return
  46.      * @author wenqy
  47.      */
  48.     @ExceptionHandler({ Error.class, Exception.class, RuntimeException.class, Throwable.class })
  49.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  50.     public String globalException(Throwable throwable, Model model) {
  51.         String clientIp = WebUtils.getClientIp();
  52.         StringBuffer traceString = new StringBuffer(“ip:”).append(clientIp);
  53.         String stackTraceAsString = ExceptionUtils.getStackTraceAsString(throwable);
  54.         traceString.append(“exection:”).append(stackTraceAsString);
  55.         logger.error(traceString.toString());
  57.         ExceptionLog exceptionLog = new ExceptionLog();
  58.         exceptionLog.setUserId(IdGenerator.randomLong());
  59.         exceptionLog.setHostIp(clientIp);
  60.         exceptionLog.setCreatedDate(new Date());
  61.         exceptionLog.setExptTime(new Date());
  62.         exceptionLog.setUuid(IdGenerator.randomString(11));
  63.         exceptionLog.setStatckTrace(stackTraceAsString);
  64. // 扔到线程池执行
  65.         this.executors.execute(new ExceptionLogThread(exceptionLog));
  66. // 抛出异常码
  67.         model.addAttribute(“errCode”, exceptionLog.getUuid().substring(0,3)
  68.                 + ” “ + exceptionLog.getUuid().substring(3,7)
  69.                 + ” “ + exceptionLog.getUuid().substring(7,11));
  71.         return “error/500”;
  72.     }
  73. }

自定义异常

我们可以自定义些业务异常，用短语标识。

  1. /**
  2.  * 自定义业务异常
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @SuppressWarnings(“serial”)
  8. public class MyBusinessException extends RuntimeException {
  10.     private String errCode;
  11.     private String message;
  12.     private String detail;
  14.     public MyBusinessException() {
  15.         super();
  16.     }
  17.     public MyBusinessException(String message) {
  18.         this(null,message,null);
  19.     }
  21.     public MyBusinessException(String errorCode, String message) {
  22.         this(errorCode,message,null);
  23.     }
  25.     public MyBusinessException(String errorCode, String message, String detail) {
  26.         super();
  27.         this.errCode = errorCode;
  28.         this.message = message;
  29.         this.detail = detail;
  30.     }
  32.     public String getErrCode() {
  33.         return errCode;
  34.     }
  36.     public void setErrCode(String errCode) {
  37.         this.errCode = errCode;
  38.     }
  40.     public String getMessage() {
  41.         return message;
  42.     }
  44.     public void setMessage(String message) {
  45.         this.message = message;
  46.     }
  48.     public String getDetail() {
  49.         return detail;
  50.     }
  52.     public void setDetail(String detail) {
  53.         this.detail = detail;
  54.     }
  56. }

异常日志

异常日志的保存应该是异步的，用工作线程处理。

  1. /**
  2.  * 
  3.  * 异常日志保存线程
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. public class ExceptionLogThread implements Runnable {
  9.     private ExceptionLog exceptionLog;
  11.     public ExceptionLogThread(ExceptionLog log) {
  12.         this.exceptionLog = log;
  13.     }
  15.     @Override
  16.     public void run() {
  17. // 加载异常日志处理服务
  18.         ExceptionLogService logService = (ExceptionLogService) SpringAppContextHolder
  19.                 .getBean(ExceptionLogService.class);
  20.         logService.saveExceptionLog(exceptionLog);
  21.     }
  23. }

避免线程的开销太大，定义线程池。

  1. /**
  2.  * 异常日志处理线程池
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @SuppressWarnings(“serial”)
  8. @Component
  9. public class ExceptionLogExecutors extends ThreadPoolTaskExecutor {
  11.     public ExceptionLogExecutors() {
  12.         super.setCorePoolSize(10);
  13.         super.setMaxPoolSize(20);
  14.     }
  15. }

定义Spring 应用上下文持有者，以便注入bean。

  1. /**
  2.  * 
  3.  * Spring ApplicationContext 持有者
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @Component
  8. public class SpringAppContextHolder implements ApplicationContextAware {
  10.     /**
  11.      * Spring 自动注入
  12.      */
  13.     private static ApplicationContext applicationContext = null;
  15.     @Override
  16.     public void setApplicationContext(ApplicationContext context) throws BeansException {
  17.         if (applicationContext == null) {
  18.             applicationContext = context;
  19.         }
  20.     }
  22.     public static ApplicationContext getApplicationContext() {
  23.         return applicationContext;
  24.     }
  26.     /**
  27.      * getBeanByName
  28.      * @param name
  29.      * @return
  30.      * @author wenqy
  31.      */
  32.     public static Object getBean(String name){
  33.         return getApplicationContext().getBean(name);
  34.     }
  36.     /**
  37.      * getBeanByClazz
  38.      * @param clazz
  39.      * @return
  40.      * @author wenqy
  41.      */
  42.     public static <T> T getBean(Class<T> clazz){
  43.         return getApplicationContext().getBean(clazz);
  44.     }
  46.     public static <T> T getBean(String name,Class<T> clazz){
  47.         return getApplicationContext().getBean(name, clazz);
  48.     }
  49. }

分层处理

然后是分层的那一套。。。

异常日志VO

  1. /**
  2.  * 异常日志VO
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @SuppressWarnings(“serial”)
  8. public class ExceptionLog implements Serializable {
  10.     private Long id;
  11.     private String uuid; // 系统异常码
  12.     private String hostIp; // ip
  13.     private Date exptTime; // 异常时间
  14.     private String statckTrace; // 异常栈
  15.     private Date createdDate;
  16.     private Long userId; // 操作用户Id
  17.     // 省略setter、getter方法
  19. }

Mybatis Mapper定义DAO操作

  1. /**
  2.  * 异常日志Mapper
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  */
  7. @Repository
  8. public interface ExceptionLogMapper {
  10.     /**
  11.      * 保存日志日志
  12.      * @param exceptionLog
  13.      * @author wenqy
  14.      */
  15.     public void saveExceptionLog(@Param(“exceptionLog”) ExceptionLog exceptionLog);
  16. }

配置文件 ExceptionLogMapper.xml

  1. <!– namespace必须指向Dao接口 –>
  2. <mapper namespace=“com.wenqy.mapper.one.ExceptionLogMapper”>
  4.     <!– 保存日志 –>
  5.     <insert id=“saveExceptionLog”>
  6.         insert into exception_log(uuid,host_ip,expt_time,created_date,stacktrace,user_id)
  7.             values(#{exceptionLog.uuid},#{exceptionLog.hostIp},#{exceptionLog.exptTime},
  8.             #{exceptionLog.createdDate},#{exceptionLog.statckTrace},#{exceptionLog.userId})
  9.     </insert>
  10. </mapper>

业务逻辑层 Service

  1. /**
  2.  * 异常日志 Service
  3.  * 
  4.  * @version V5.0
  5.  * @author wenqy
  6.  * @date   2017年12月23日
  7.  */
  8. @Service
  9. public class ExceptionLogServiceImpl implements ExceptionLogService {
  11.     @Autowired
  12.     private ExceptionLogMapper exceptionLogMapper;
  14.     @Override
  15.     public void saveExceptionLog(ExceptionLog exceptionLog) {
  16.         exceptionLogMapper.saveExceptionLog(exceptionLog);
  17.     }
  19. }

定义服务器异常页面模板 500.ftl

  1. <#assign webRoot=request.contextPath />
  2. <!DOCTYPE html>
  3. <html lang=“en”>
  4.   <head>
  5.     <meta charset=“utf-8”>
  6.     <meta http-equiv=“X-UA-Compatible” content=“IE=edge”>
  7.     <meta name=“viewport” content=“width=device-width, initial-scale=1”>
  8.     <!– The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags –>
  9.     <meta name=“description” content=“”>
  10.     <meta name=“author” content=“”>
  11.     <link rel=“icon” href=“${webRoot}/static/favicon.ico”>
  13.     <title>Signin Template for Bootstrap</title>
  15.     <!– Bootstrap core CSS –>
  16.     <link href=“${webRoot}/static/css/bootstrap/bootstrap.min.css” rel=“stylesheet”>
  18.     <!– IE10 viewport hack for Surface/desktop Windows 8 bug –>
  19.     <link href=“${webRoot}/static/css/bootstrap/ie10-viewport-bug-workaround.css” rel=“stylesheet”>
  21.     <!– Custom styles for this template –>
  22.     <link href=“${webRoot}/static/css/custom/signin.css” rel=“stylesheet”>
  24.     <!– Just for debugging purposes. Don’t actually copy these 2 lines! –>
  25.     <!–[if lt IE 9]><script src=”../../assets/js/ie8-responsive-file-warning.js”></script><![endif]–>
  26.     <script src=“${webRoot}/static/js/bootstrap/ie-emulation-modes-warning.js”></script>
  28.     <!– HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries –>
  29.     <!–[if lt IE 9]>
  30.       <script src=“${webRoot}/static/js/bootstrap/html5shiv.min.js”></script>
  31.       <script src=“${webRoot}/static/js/bootstrap/respond.min.js”></script>
  32.     <![endif]–>
  33.   </head>
  34. <body>
  35.     <div class=“container”>
  36.         <div class=“panel panel-success”>
  37.             <div class=“panel-heading”>
  38.                 <input id=“backBtn” class=“btn btn-primary” onclick=“history.go(-1);” type=“button” value=“返回上一页” >
  39.             </div>
  40.             <div class=“panel-body”>
  41.                 <span>系统繁忙，请稍后重试，若仍有问题，请联系客服，电话：XXX-XXXX-XXXX</span>
  42.                 <span>请将状态码&nbsp;<strong>${ errCode }</strong>&nbsp;告知客服</span>
  43.             <br/>
  44.             </div>
  45.         </div>
  46.     </div>
  47. </body>
  48. </html>

业务异常的界面，常用HTTP异常状态相应的异常界面等等，不一一列举了。

还有一些异常工具类，ID生成器、Web工具类等等。。。

查看效果

发生业务异常测试。。。

business_exception.png

测试发生500异常

500_exception

插入异常日志，ip记录有问题。。。

exception_table

大致统一异常处理就这样，当然还有其他实现方式，但这种切面方式胜在侵入性低，解耦强。。。

网易云音乐就不插了，伤不起。。。

小二，再来一碟

赏

One thought on “spring boot学习系列之统一异常处理6”

  1. Pingback: spring boot学习系列之统一日志处理7 - 小温之家

发表评论

电子邮件地址不会被公开。 必填项已用*标注

24 + 16 = ?