SpringBoot 统一异常管理

avatar 2018年03月24日16:42:02 6 3119 views
博主分享免费Java教学视频，B站账号：Java刘哥
通常，SpringBoot 默认的异常页面是这样的，用户根本看不懂，系统遇到 Bug 的话，也不知道跟管理员怎么反馈。   而自定义的异常页面是这样的，意思明朗很多。     通过配置全局异常管理，我们不仅可以美化页面的显示，自定义错误的信息。还可以捕获很多我们遇到的错误，并将它们写入日志中。虽然很多提交表单的异常可以通过前台 js 避免，但是万一用户禁用 js 呢？为了数据安全，我们在后台还是要加一层安全保护。   现在就开始吧！

代码如下

1、这是一个统一异常处理类 GlobalExceptionHandler.java
  1. package com.liuyanzhao.forum.exception;
  3. import org.hibernate.service.spi.ServiceException;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.http.HttpStatus;
  7. import org.springframework.http.converter.HttpMessageNotReadableException;
  8. import org.springframework.ui.Model;
  9. import org.springframework.validation.BindException;
  10. import org.springframework.validation.BindingResult;
  11. import org.springframework.validation.FieldError;
  12. import org.springframework.web.HttpMediaTypeNotSupportedException;
  13. import org.springframework.web.HttpRequestMethodNotSupportedException;
  14. import org.springframework.web.bind.MethodArgumentNotValidException;
  15. import org.springframework.web.bind.MissingServletRequestParameterException;
  16. import org.springframework.web.bind.annotation.ControllerAdvice;
  17. import org.springframework.web.bind.annotation.ExceptionHandler;
  18. import org.springframework.web.bind.annotation.ResponseStatus;
  19. import org.springframework.web.servlet.NoHandlerFoundException;
  21. import javax.validation.ConstraintViolation;
  22. import javax.validation.ConstraintViolationException;
  23. import javax.validation.ValidationException;
  24. import java.util.Set;
  26. /**
  27.  * @author 言曌
  28.  * @date 2018/3/20 下午12:57
  29.  */
  31. @ControllerAdvice
  32. public class GlobalExceptionHandler {
  33.     // 日志记录工具
  34.     private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  36.     //错误显示页面,即 /public/error/error.html 文件
  37.     public static final String viewName = "/error/error";
  40.     /**
  41.      * 400 - Bad Request
  42.      */
  43.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  44.     @ExceptionHandler(MissingServletRequestParameterException.class)
  45.     public String handleMissingServletRequestParameterException(MissingServletRequestParameterException e, Model model) {
  46.         logger.error("缺少请求参数", e);
  47.         String message = "【缺少请求参数】" + e.getMessage();
  48.         model.addAttribute("message", message);
  49.         model.addAttribute("code", 400);
  50.         return viewName;
  51.     }
  53.     /**
  54.      * 400 - Bad Request
  55.      */
  56.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  57.     @ExceptionHandler(HttpMessageNotReadableException.class)
  58.     public String handleHttpMessageNotReadableException(HttpMessageNotReadableException e, Model model) {
  59.         logger.error("参数解析失败", e);
  60.         String message = "【参数解析失败】" + e.getMessage();
  61.         model.addAttribute("message", message);
  62.         model.addAttribute("code", 400);
  63.         return viewName;
  64.     }
  66.     /**
  67.      * 400 - Bad Request
  68.      */
  69.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  70.     @ExceptionHandler(MethodArgumentNotValidException.class)
  71.     public String handleMethodArgumentNotValidException(MethodArgumentNotValidException e, Model model) {
  72.         logger.error("参数验证失败", e);
  73.         BindingResult result = e.getBindingResult();
  74.         FieldError error = result.getFieldError();
  75.         String field = error.getField();
  76.         String code = error.getDefaultMessage();
  77.         String message = "【参数验证失败】" + String.format("%s:%s", field, code);
  78.         model.addAttribute("message", message);
  79.         model.addAttribute("code", 400);
  80.         return viewName;
  81.     }
  83.     /**
  84.      * 400 - Bad Request
  85.      */
  86.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  87.     @ExceptionHandler(BindException.class)
  88.     public String handleBindException(BindException e, Model model) {
  89.         logger.error("参数绑定失败", e);
  90.         BindingResult result = e.getBindingResult();
  91.         FieldError error = result.getFieldError();
  92.         String field = error.getField();
  93.         String code = error.getDefaultMessage();
  94.         String message = "【参数绑定失败】" + String.format("%s:%s", field, code);
  96.         model.addAttribute("message", message);
  97.         model.addAttribute("code", 400);
  98.         return viewName;
  99.     }
  102.     /**
  103.      * 400 - Bad Request
  104.      */
  105.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  106.     @ExceptionHandler(ConstraintViolationException.class)
  107.     public String handleServiceException(ConstraintViolationException e, Model model) {
  108.         logger.error("参数验证失败", e);
  109.         Set<ConstraintViolation<?>> violations = e.getConstraintViolations();
  110.         ConstraintViolation<?> violation = violations.iterator().next();
  111.         String message = "【参数验证失败】" + violation.getMessage();
  112.         model.addAttribute("message", message);
  113.         model.addAttribute("code", 400);
  114.         return viewName;
  115.     }
  117.     /**
  118.      * 400 - Bad Request
  119.      */
  120.     @ResponseStatus(HttpStatus.BAD_REQUEST)
  121.     @ExceptionHandler(ValidationException.class)
  122.     public String handleValidationException(ValidationException e, Model model) {
  123.         logger.error("参数验证失败", e);
  124.         String message = "【参数验证失败】" + e.getMessage();
  125.         model.addAttribute("message", message);
  126.         model.addAttribute("code", 400);
  127.         return viewName;
  128.     }
  130.     /**
  131.      * 404 - Not Found
  132.      */
  133.     @ResponseStatus(HttpStatus.NOT_FOUND)
  134.     @ExceptionHandler(NoHandlerFoundException.class)
  135.     public String noHandlerFoundException(NoHandlerFoundException e, Model model) {
  136.         logger.error("Not Found", e);
  137.         String message = "【页面不存在】" + e.getMessage();
  138.         model.addAttribute("message", message);
  139.         model.addAttribute("code", 404);
  140.         System.out.println("404404错误");
  141.         return viewName;
  142.     }
  145.     /**
  146.      * 405 - Method Not Allowed
  147.      */
  148.     @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
  149.     @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
  150.     public String handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e, Model model) {
  151.         logger.error("不支持当前请求方法", e);
  152.         String message = "【不支持当前请求方法】" + e.getMessage();
  153.         model.addAttribute("message", message);
  154.         model.addAttribute("code", 405);
  155.         return viewName;
  156.     }
  158.     /**
  159.      * 415 - Unsupported Media Type
  160.      */
  161.     @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
  162.     @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
  163.     public String handleHttpMediaTypeNotSupportedException(HttpMediaTypeNotSupportedException e, Model model) {
  164.         logger.error("不支持当前媒体类型", e);
  165.         String message = "【不支持当前媒体类型】" + e.getMessage();
  166.         model.addAttribute("message", message);
  167.         model.addAttribute("code", 415);
  168.         return viewName;
  169.     }
  172.     /**
  173.      * 业务层需要自己声明异常的情况
  174.      */
  175.     @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
  176.     @ExceptionHandler(ServiceException.class)
  177.     public String handleServiceException(ServiceException e, Model model) {
  178.         logger.error("业务逻辑异常", e);
  179.         String message = "【业务逻辑异常】" + e.getMessage();
  180.         model.addAttribute("message", message);
  181.         return viewName;
  182.     }
  185.     /**
  186.      * 获取其它异常。包括500
  187.      *
  188.      * @param e
  189.      * @return
  190.      * @throws Exception
  191.      */
  192.     @ExceptionHandler(value = Exception.class)
  193.     public String defaultErrorHandler(Exception e, Model model) {
  194.         logger.error("Exception", e);
  195.         String message = e.getMessage();
  196.         model.addAttribute("message", message);
  197.         model.addAttribute("code", 500);
  198.         return viewName;
  199.     }
  200. }
注意修改 37 行的错误页面地址 不知道为什么 404 页面无法捕获   2、这是一个我们自定义的异常，通常我们可以主动抛它，当然，也可以直接抛 Exception CustomException.java
  1. package com.liuyanzhao.forum.exception;
  3. /**
  4.  * 自定义异常
  5.  * @author 言曌
  6.  * @date 2018/3/20 下午12:50
  7.  */
  9. public class CustomException extends RuntimeException {
  11.     /** serialVersionUID */
  12.     private static final long serialVersionUID = 6417641452178955756L;
  14.     public CustomException() {
  15.         super();
  16.     }
  18.     public CustomException(String message) {
  19.         super(message);
  20.     }
  22.     public CustomException(Throwable cause) {
  23.         super(cause);
  24.     }
  26.     public CustomException(String message, Throwable cause) {
  27.         super(message, cause);
  28.     }
  29. }
  3、在 template 或者资源根目录下新建 error 文件夹 error.html
  1. <div class="error-page">
  2.     ${code=} <span th:text="${code}"></span>
  3.     <h2 class="headline text-red" th:text="${code}"></h2>
  5.     <div class="error-content" style="margin-top: 120px;">
  6.         <h3><i class="fa fa-warning text-red"></i> 天哪! 好像遇到了错误.</h3>
  8.         <p style="font-size: 1.2em;">
  9.             错误信息： <span th:text="${message}" class="text text-danger"></span>
  10.         </p>
  12.         <p><a href="javascript:history.go(-1)">返回上一页</a></p>
  13.         <form class="search-form">
  14.             <div class="input-group">
  15.                 <input type="text" name="search" class="form-control" placeholder="Search">
  17.                 <div class="input-group-btn">
  18.                     <button type="submit" name="submit" class="btn btn-danger btn-flat"><i class="fa fa-search"></i>
  19.                     </button>
  20.                 </div>
  21.             </div>
  22.             <!-- /.input-group -->
  23.         </form>
  24.     </div>
  25. </div>
  26. <!-- /.error-page -->
因为 404 页面好像无法捕获，那么我们可以再新建一个 404.html ，内容和上面差不多，改一下错误码为 404 即可。   4、为了演示使用，这里是 UserServiceImpl.java 里的一个添加新用户的方法
  1. @Transactional(rollbackFor = Exception.class)
  2.    @Override
  3.    public void saveUser(User user) {
  4.        String username = user.getUsername();
  5.        String nickname = user.getNickname();
  6.        String password = user.getPassword();
  7.        String email = user.getEmail();
  9.        //1、非空判断
  10.        if (username == null || nickname == null || password == null || email == null) {
  11.            throw new CustomException("存在必填字段为空");
  12.        } else {
  13.            if (username.trim() == "" || password.trim() == "") {
  14.                throw new CustomException("存在必填字段为空字符串");
  15.            } else if(password.trim().length() < 6) {
  16.                throw new CustomException("密码长度小于6位");
  17.            }
  18.        }
  20.        //2、判断用户名是否合法
  21.        if (username != null && username != "") {
  22.            User user2 = userRepository.findByUsername(username);
  23.            //2.1用户名已存在，不可以注册
  24.            if (user2 != null) {
  25.                throw new CustomException("用户名 " + username + " 已被使用");
  27.            }
  28.        }
  29.        //3、判断Email是否合法
  30.        if (email != null && email != "") {
  31.            User user3 = userRepository.findByEmail(email);
  32.            //1.1用户名已存在，不可以注册
  33.            if (user3 != null) {
  34.                throw new CustomException("Email " + email + "已被使用");
  35.            }
  36.        }
  37.        //4、处理其他字段
  38.        user.setCreateTime(System.currentTimeMillis());
  39.        user.setEncodePassword(user.getPassword()); // 加密密码
  40.        user.setIsBanned("N");//正常状态
  41.        user.setNumberVoteUp(0);//票数
  42.        user.setAvatar(AvatarUtil.getGravatar(email));//头像
  43.        if (user.getNickname() == null) {
  44.            user.setNickname(username);//默认昵称是用户名
  45.        }
  46.        userRepository.save(user);
  48.    }
 

最终效果图

先看几个系统自动抛出的异常 1、页面不存在，400错误   2、编辑用户的时候，修改票数(一个 Integer 类型的字段)，当我们填成字符串 421swsw 的时候，400错误   3、某个字段只允许一个字符如用户状态是否禁用Y或N，党输入abcd的时候，无法执行，数据库报异常   然后再看几个我们主动抛出的异常 2、添加用户的时候，设置了用户名字段为唯一性，500错误   3、密码小于 6 位
历史上的今天
三月
24日
  • 微信
  • 交流学习，有偿服务
  • weinxin
  • 博客/Java交流群
  • 资源分享，问题解决，技术交流。群号：590480292
  • weinxin
avatar

发表评论

avatar 登录者：匿名
匿名评论，评论回复后会有邮件通知

  

已通过评论：0   待审核评论数：0