SpringBoot + thymeleaf 捕捉校验参数异常并统一处理

Spring Boot + thymeleaf 捕捉校验参数异常并统一处理

捕捉校验失败异常信息类

import com.fyyc.jhyzm.blog.mayday.exception.BlogException;
import com.fyyc.jhyzm.blog.mayday.reuse.Data;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.stream.Collectors;

/**
 * @ ClassName: ControllerExceptionHandler
 * @ Author: longxin
 * @ CreatTime: 2020/4/13 0013 17:35
 * @ version: 1.0
 */
//加了改注解会拦截所有抛出的异常
@ControllerAdvice
public class ControllerExceptionHandler {
	//异常接收的前端页面
    private final static String error_path = "error/error";
    //日志
    private final Logger logger = LoggerFactory.getLogger(this.getClass());
    
    //BlogException 自定义通用异常处理
    @ExceptionHandler(BlogException.class)
    public ModelAndView exceptionHander(HttpServletRequest request, BlogException e) throws Exception {
        logger.error("路由 : {}，Blog错误信息 : {}", request.getRequestURL(), e.getStatus() + " " + e.getMessage());
        //Data - 我定义的通用数据模型 
        Data<String> data = new Data(e.getMessage(), e.getCode(), false, request.getRequestURL());

        ModelAndView mv = new ModelAndView();
        mv.addObject("data", data);
        mv.setViewName(error_path);
        return mv;
    }
    //处理请求参数格式错误 @RequestBody上validate失败后抛出的异常是MethodArgumentNotValidException异常。
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ModelAndView exceptionHander(HttpServletRequest request, MethodArgumentNotValidException e) throws Exception {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        logger.error("路由 : {}，RequestBody-Valid错误信息 : {}", request.getRequestURL(), message);
		//Data - 我定义的通用数据模型 
        Data<String> data = new Data(message, false, request.getRequestURL());

        ModelAndView mv = new ModelAndView();
        mv.addObject("data", data);
        mv.setViewName(error_path);
        return mv;
    }
    //处理请求参数格式错误 @RequestParam上validate失败后抛出的异常是javax.validation.ConstraintViolationException
    @ExceptionHandler(ConstraintViolationException.class)
    public ModelAndView exceptionHander(HttpServletRequest request, ConstraintViolationException e) throws Exception {
        String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
        logger.error("路由 : {}，RequestParam-Valid错误信息 : {}", request.getRequestURL(), message);
		//Data - 我定义的通用数据模型 
        Data<String> data = new Data(message, false, request.getRequestURL());

        ModelAndView mv = new ModelAndView();
        mv.addObject("data", data);
        mv.setViewName(error_path);
        return mv;
    }
    //处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常，
    @ExceptionHandler(BindException.class)
    public ModelAndView exceptionHander(HttpServletRequest request, BindException e) throws Exception {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        logger.error("路由 : {}，Get-Valid错误信息 : {}", request.getRequestURL(), message);
		//Data - 我定义的通用数据模型 
        Data<String> data = new Data(message, false, request.getRequestURL());

        ModelAndView mv = new ModelAndView();
        mv.addObject("data", data);
        mv.setViewName(error_path);
        return mv;
    }
    //其它异常
    @ExceptionHandler(Exception.class)
    public ModelAndView exceptionHander(HttpServletRequest request, Exception e) throws Exception {
        logger.error("路由 : {}，错误信息 : {}", request.getRequestURL(), e.getMessage());
		//Data - 我定义的通用数据模型 
        Data<String> data = new Data(e.getMessage(), false, request.getRequestURL());

        ModelAndView mv = new ModelAndView();
        mv.addObject("data", data);
        mv.setViewName(error_path);
        return mv;
    }
}

示例说明

• 如下当我使用 @Valid 注解来使@Validated ，@Valid ，@NotBlank，@NotNull 等注解生效时，如果抛出异常将会被上面代码中的 MethodArgumentNotValidException 所拦截并处理
  
• 其他的不一一列举

Data - 我定义的通用数据模型 （高复用返回数据类）

import org.apache.commons.lang.StringUtils;
/**
 * @ ClassName: Reuse
 * @ Author: longxin
 * @ CreatTime: 2020/4/14 0014 15:41
 * @ version: 1.0
 */
@lombok.Data
public class Data<T> {
    private Integer code;
    private String msg;
    private Boolean success;
    private T data;

    public Data() {
    }
    public Data(T data) {
        this.data = data;
        reuseCheck();
    }
    public Data(String msg, T data) {
        this.data = data;
        this.msg = msg;
        reuseCheck();
    }
    public Data(String msg, Integer code, T data) {
        this.data = data;
        this.code = code;
        this.msg = msg;
        reuseCheck();
    }
    public Data(String msg, Boolean success, T data) {
        this.data = data;
        this.msg = msg;
        this.success = success;
        reuseCheck();
    }
    public Data(String msg, Integer code, Boolean success, T data) {
        this.data = data;
        this.code = code;
        this.msg = msg;
        this.success = success;
        reuseCheck();
    }
    private void reuseCheck(){
        msg = StringUtils.isBlank(msg) ? "操作成功." : msg;
        success = success == null ? true : success;
        code = code == null ? success ? 200 : 0 : code;
    }
}

BlogException 我定义的通用异常处理

import org.springframework.http.HttpStatus;

public class BlogException extends AbstractException {
	//状态
    private HttpStatus httpStatus;
    public BlogException(String message) {
        super(message);
    }
    public BlogException(String message, HttpStatus httpStatus) {
        super(message);
        this.httpStatus = httpStatus;
    }
    public BlogException(String message, Throwable cause) {
        super(message, cause);
    }
    @Override
    public HttpStatus getStatus() {
        return this.httpStatus == null ? HttpStatus.INTERNAL_SERVER_ERROR : this.httpStatus;
    }
    public Integer getCode(){
        return this.httpStatus.value();
    }
}

抽象异常类（BlogException 继承它）

import org.springframework.http.HttpStatus;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;

public abstract class AbstractException extends RuntimeException {
    private Object errorData;
    public AbstractException(String message) {
        super(message);
    }
    public AbstractException(String message, Throwable cause) {
        super(message, cause);
    }
    public abstract HttpStatus getStatus();
    @Nullable
    public Object getErrorData() {
        return errorData;
    }
    @NonNull
    public AbstractException setErrorData(@Nullable Object errorData) {
        this.errorData = errorData;
        return this;
    }
}

前端错误页接收代码

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<body>
      <span th:text="${data}">整体</span>
      <span th:text="${data.code}">状态码</span>
      <span th:text="${data.msg}">信息</span>
      <span th:text="${data.data}">数据</span>
</body>
</html>

使用场景

代码中抛出

		try {
            //你的代码处
        }catch (Exception e){
            throw new BlogException("异常信息", "状态码");
        }

注解中生效

	@NotBlank(message = "用户名或邮箱不能为空")
    @Size(max = 255, message = "用户名或邮箱的字符长度不能超过 {max}")
    private String username;

其他系统异常：服务器异常，请求参数异常等等，很多地方都可以用到

使用实例截图

某Service登陆接口示例

登录时未查询到用户信息或密码不正确时抛出异常

测试效果

Blog错误：用户名或密码错误

• 后台
  
• Swagger测试
  

参数空异常

• 后台
  

• Swagger测试
  

• 其他异常不一一列举