Ilren 小记

我们在项目开发过程中controller层方法入参检验中存在一个问题，就是会对参数进行校验。以往我们就会写大量的if else 来对参数进行判断，但是大量的入参校验也使得代码十分的不友好！所以本文主要介绍了在SpringBoot中@Valid参数校验及参数错误的统一异常处理。

开发环境

Java版本：1.8
SpringBoot版本：2.2.2.RELEASE

测试代码

1.在实体类中添加入参校验注解

import lombok.Data;
import javax.validation.constraints.NotBlank;
@Data
public class User {

    /**
     * 用户账号
     */
    @NotBlank(message = "账号不能为空")
    private String username;

    /**
     * 用户密码
     */
    @NotBlank(message = "密码不能为空")
    private String password;


}

2.在Controller层添加@Valid注解

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.validation.Valid;

@Slf4j
@RestController
public class UserController {

    @Resource
    private UserService userService;

    /**
     * 保存用户信息接口
     * @param user    用户信息
     * @return
     */
    @PostMapping("/")
    public ReturnVo insert(@ModelAttribute @Valid User user){
        try{
            return userService.insert(user);
        }catch (Exception e){
            log.error("添加失败",e);
            return ReturnVoUtils.error("添加失败");
        }
    }


}

3.添加统一异常捕获

import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.List;

@Slf4j
@RestControllerAdvice
public class GlobalExceptionAdvisor {

    /**
     *  校验错误拦截处理
     * @param exception     错误信息集合
     * @return                 错误信息
     */
    @ExceptionHandler(BindException.class)
    public ReturnVo validationBodyException(BindException exception){
        BindingResult result = exception.getBindingResult();
        String msg = null;
        if (result.hasErrors()) {

            List<ObjectError> errors = result.getAllErrors();
            for(ObjectError fieldError : errors){
                String errMsg = fieldError.getDefaultMessage();
                if(null==msg){
                    msg = errMsg;
                }
                log.error("参数错误："+errMsg);
            }
        }
        return ReturnVoUtils.error(msg);
    }
}

参数校验注解规则

空检查    

@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=)

SpringBoot+@Valid参数校验+统一异常处理

开发环境

测试代码

参数校验注解规则