Spring Boot 数据校验@Valid + 自定义返回异常信息格式

参考文章： https://blog.csdn.net/JYTXIOABAI/article/details/83823486

在实体类上面加上所需的注解

例：

public class UserInfo implements Serializable {
    /** */
    private Integer id;

    /** */
    @NotNull(message = "用户姓名不能为空")
    private String uname;

    /** */
    @NotNull(message = "登陆名不能为空")
    private String loginName;

    /** */
    private String loginPwd;

    private static final long serialVersionUID = 1L;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUname() {
        return uname;
    }

    public void setUname(String uname) {
        this.uname = uname == null ? null : uname.trim();
    }

    public String getLoginName() {
        return loginName;
    }

    public void setLoginName(String loginName) {
        this.loginName = loginName == null ? null : loginName.trim();
    }

    public String getLoginPwd() {
        return loginPwd;
    }

    public void setLoginPwd(String loginPwd) {
        this.loginPwd = loginPwd == null ? null : loginPwd.trim();
    }
}

@Valid其他参数校验

空检查

@Null 验证对象是否为null

@NotNull 验证对象是否不为null, 无法查检长度为0的字符串

@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.

@NotEmpty 检查约束元素是否为NULL或者是EMPTY.

Booelan检查

@AssertTrue 验证 Boolean 对象是否为 true

@AssertFalse 验证 Boolean 对象是否为 false

长度检查

@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内

@Length(min=, max=) Validates that the annotated string is between min and max included.

日期检查

@Past 验证 Date 和 Calendar 对象是否在当前时间之前

@Future 验证 Date 和 Calendar 对象是否在当前时间之后

@Pattern 验证 String 对象是否符合正则表达式的规则

数值检查

建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null

@Min 验证 Number 和 String 对象是否大等于指定的值

@Max 验证 Number 和 String 对象是否小等于指定的值

@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度

@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度

@Digits 验证 Number 和 String 的构成是否合法

@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 @Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum. @Range(min=10000,max=50000,message=“range.bean.wage”) private BigDecimal wage;

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)

@CreditCardNumber信用卡验证

@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。

@ScriptAssert(lang= ,script=, alias=)

@URL(protocol=,host=, port=,regexp=, flags=)

在controller层加@Valid注解使实体类中的注解生效

例：

public class UserController {
	@PostMapping(value="/saveUser", produces = {"application/json;charset=UTF-8"})
	@ResponseBody
	public String saveUser(@RequestBody @Valid UserInfo userInfo) {
		Map<String,Object> map = new HashMap<String,Object>();
		int i = userService.saveUserInfo(userInfo);
		if(i > 0) {
			map.put("user", userInfo);
			return setResult(200,"保存用户成功","");
		}else {
			return setResult(202,"保存用户失败","");
		}
	}
}

创建统一处理的异常类

@RestControllerAdvice(定义全局处理异常类)
@ExceptionHandler(写你想要拦截的异常类型)
这两个注解必须要
@RestControllerAdvice异常处理类与@ControllerAdvice相比不需要添加@ResponseBody就可以返回JSON格式异常
第一个方法是校验异常的统一处理
第二个是防止参数类型不一致的处理
当然你也可以在里面处理其他异常。

@RestControllerAdvice
public class BadRequestExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(BadRequestExceptionHandler.class);
    /**
     *  校验错误拦截处理
     *
     * @param exception 错误信息集合
     * @return 错误信息
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ServiceResult validationBodyException(MethodArgumentNotValidException exception){

        BindingResult result = exception.getBindingResult();
      /**
      *可解开
      **/
      //  if (result.hasErrors()) {
      //      List<ObjectError> errors = result.getAllErrors();
      //      errors.forEach(p ->{
      //          FieldError fieldError = (FieldError) p;
      //          logger.error("Data check failure : object{"+fieldError.getObjectName()+"},field{"+fieldError.getField()+
      //                  "},errorMessage{"+fieldError.getDefaultMessage()+"}");
      //      });
      //  }
      //返回自定义错误格式
      //fieldError.getDefaultMessage()为实体类中的message
        return setResult("500",fieldError.getDefaultMessage(),"");
    }

    /**
     * 参数类型转换错误
     *
     * @param exception 错误
     * @return 错误信息
     */
    @ExceptionHandler(HttpMessageConversionException.class)
    public ServiceResult parameterTypeException(HttpMessageConversionException exception){
        logger.error(exception.getCause().getLocalizedMessage());
        return setResult("类型转换错误");
    }
}