springboot 参数校验

 

注解说明

验证注解	验证的数据类型	说明
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=值）	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)	和@Min要求一样	验证注解的元素值大于等于@DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求一样	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型（如String）	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	String，任何CharSequence的子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证

 

实际业务开发中，为了避免入参错误对业务系统有影响，一般会都会在Controller层进行参数校验，常见的方式主要包含了两种：

get、delete等请求，参数形式为RequestParam/PathVariable
post、put等请求，参数形式为RequestBoty
RequestParam/PathVariable形式的参数校验
Get、Delete请求一般会使用RequestParam/PathVariable形式参数参数，这种形式的参数校验一般需要以下两个步骤，如果校验失败，会抛出ConstraintViolationException异常。

必须在Controller类上标注@Validated注解；
在接口参数前声明约束注解(如@NotBlank等)

@Validated
@RestController
@RequestMapping("/validate")
public class ValidationController {

private Logger log = LoggerFactory.getLogger(ValidationController.class);

/**
* get、delete请求使用requestParam/PathVariable形式传递参数的，
* 参数校验需要在Controller添加上@Validated注解，并在参数列表中添加对应的校验注解即可
*
* @param id ID
* @return true/false 成功或失败
*/
@GetMapping("/get")
public ResultObject<Boolean> validateGetRequest(@NotBlank(message = "id不能为空") String id,
@NotBlank(message = "appkey不能为空") String appkey) {
// 具体业务逻辑调用
log.info("id [{}] appKey [{}]", id, appkey);
return ResultObject.success();
}
}

　　

RequestBoty形式的参数校验
POST、PUT请求一般会使用requestBody传递参数，这种情况下，在入参对象上添加@Validated注解就能实现自动参数校验。

比如，有一个保存用户信息的接口，要求username长度是2-20位，password字段长度是8-20位，还要加上邮箱校验。如果校验失败，会抛出MethodArgumentNotValidException异常，Spring默认会将其转为400（Bad Request）请求。

@Data
public class UserDTO {

@NotBlank(message = "id不能为空")
private String id;

@NotBlank(message = "用户名不能为空")
@Length(min = 2, max = 20)
private String username;

@NotBlank(message = "密码不能为空")
@Length(min = 8, max = 20)
private String password;

@Email(message = "邮箱格式不正确")
private String email;

}

　　

在对应的接口上加上@Valid或者@Validated注解即可。@Validated 支持分组校验

/**
* post、put等请求使用requestBody形式传递参数的，
* 在参数列表中使用@Valid或者@Validated进行校验即可
*
* @param userDTO 入参
* @return true/false 成功或失败
*/
@PostMapping("/post")
public ResultObject<Boolean> validatePostRequest(@Valid @RequestBody UserDTO userDTO) {
// 具体业务逻辑调用
log.info("userDTO [{}]", userDTO);
return ResultObject.success();
}

　　

自定义校验工具类

有时候，直接在Controller层进行参数校验，并不满足我们所有的需求，这时，就需要自定义校验工具类。结合全局异常处理，就能非常方便简洁地进行参数校验了

public class ValidationUtils {

    private static final ValidatorFactory VALIDATOR_FACTORY = Validation.buildDefaultValidatorFactory();

    /**
     * 参数校验
     *
     * @param paramObject 需要校验的参数
     */
    public static void validateObject(Object paramObject) {
        Validator validator = VALIDATOR_FACTORY.getValidator();
        Set<ConstraintViolation<Object>> validateResult = validator.validate(paramObject);
        if (CollectionUtils.isEmpty(validateResult)) {
            return;
        }

        StringBuilder errorMessageSb = new StringBuilder();
        for (ConstraintViolation<Object> violation : validateResult) {
            errorMessageSb.append(violation.getMessage()).append(";");
        }
        throw new GlobalException(ResultCodeEnum.USER_PARAMETER_ERROR.getCode(), errorMessageSb.toString());
    }

    /**
     * 参数校验【支持分组校验】
     *
     * @param paramObject 需要校验的参数
     * @param classes     具体的分组
     */
    public static void validateObject(Object paramObject, Class<?> classes) {
        Validator validator = VALIDATOR_FACTORY.getValidator();
        Set<ConstraintViolation<Object>> validateResult = validator.validate(paramObject, classes);
        if (CollectionUtils.isEmpty(validateResult)) {
            return;
        }

        Set<String> errorMsgSet = new HashSet<>();
        for (ConstraintViolation<Object> violation : validateResult) {
            errorMsgSet.add(violation.getMessage());
        }
        throw new GlobalException(ResultCodeEnum.USER_PARAMETER_ERROR.getCode(), String.join(",", errorMsgSet));
    }

    private ValidationUtils() {
    }
}

　　

全局异常处理

/**
 * Created by shijiufeng on 2022/4/29.
 * 出错的处理，BindException用来验证传递参数是否符合要求
 * 验证注解说明https://www.cnblogs.com/netcorner/p/16207016.html
 */
@RestControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    /**
     * 方法参数校验异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResultObject<String> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        log.error("[全局异常处理] [参数校验不通过]{}", e.getMessage(), e);
        return ResultObject.<String>builder()
                .success(false)
                .result(ResultCodeEnum.USER_PARAMETER_ERROR.getCode())
                .msg(Objects.requireNonNull(e.getBindingResult().getFieldError()).getDefaultMessage())
                .build();
    }

    /**
     * 方法RequestParam/PathVariable形式参数校验异常
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public ResultObject<String> handleConstraintViolationException(ConstraintViolationException e) {
        log.error("[全局异常处理] [参数校验不通过]{}", e.getMessage(), e);
        return ResultObject.<String>builder()
                .success(false)
                .result(ResultCodeEnum.USER_PARAMETER_ERROR.getCode())
                .msg(e.getMessage())
                .build();
    }

    /**
     * 方法参数校验异常[类型不配备]
     */
    @ExceptionHandler(UnexpectedTypeException.class)
    public ResultObject<String> handleUnexpectedTypeException(UnexpectedTypeException e) {
        log.error("[全局异常处理] [参数校验类型不匹配]{}", e.getMessage(), e);
        return ResultObject.builder(e.getMessage()).success(false)
                .result(ResultCodeEnum.USER_PARAMETER_UNEXPECTED_TYPE.getCode())
                .msg("校验参数类型异常，请检查注释使用是否正确")
                .build();
    }

    /**
     * 前端传递参数验证异常
     * @param ex
     * @return
     */
    @ExceptionHandler(BindException.class)
    public ResultObject<String> handleBindException(BindException ex) {
        log.warn("[全局异常处理] [提交参数校不符合规则]{}", ex.getMessage(), ex);
        return ResultObject.builder(ex.getMessage()).success(false)
                .result(ResultCodeEnum.USER_PARAMETER_ERROR.getCode())
                .msg(ex.getAllErrors().get(0).getDefaultMessage())
                .build();
    }


}