注解系列——参数验证

最新推荐文章于 2024-04-03 19:15:00 发布

耘田

最新推荐文章于 2024-04-03 19:15:00 发布

阅读量820

点赞数

分类专栏： Spring 文章标签：参数验证 valid validation

本文链接：https://blog.csdn.net/fgszdgbzdb/article/details/93477296

版权

Spring 专栏收录该内容

29 篇文章 1 订阅

订阅专栏

最常用的参数验证方式莫过于使用@Valid 或 @Validated 。

简介

package javax.validation;
@Valid

package org.springframework.validation.annotation;
@Validated

Variant of JSR-303’s Valid, supporting the specification of validation groups. Designed for convenient use with Spring’s JSR-303 support but not JSR-303 specific.

Spring Validation 验证框架对参数的验证机制提供了@Validated（Spring’s JSR-303 规范，是标准 JSR-303 的一个变种），javax提供了@Valid（标准JSR-303规范），配合 BindingResult 可以直接提供参数验证结果。

在检验 Controller 的入参是否符合规范时，使用 @Validated 或者 @Valid 在基本验证功能上没有太多区别。但在分组支持、注解地方和嵌套验证却又不同之处。

区别

分组支持
@Valid：作为标准JSR-303规范，还没有吸收分组的功能。
@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制。
注解地方
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上
@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上
两者是否能用于成员属性（字段）上直接影响能否提供嵌套验证的功能。
嵌套验证
@Valid：用在方法入参上无法单独提供嵌套验证功能。能够用在成员属性（字段）上，提示验证框架进行嵌套验证。能配合嵌套验证注解@Valid进行嵌套验证。
@Validated：用在方法入参上无法单独提供嵌套验证功能。不能用在成员属性（字段）上，也无法提示框架进行嵌套验证。能配合嵌套验证注解@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 的构成是否合法
@Range(min=, max=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum.
其他
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber 信用卡验证
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@URL 验证是否是邮件地址，如果为null,不进行验证，算通过验证。

@Valid 使用

Bean

@Data
public class PersonDO {

    /**
     * 姓名注释
     */
    @Size(min = 1, max = 50, message = "name长度应为1-50字符")
    private String name;

    /**
     * 年龄注释
     */
    @Max(value = 200, message = "age最大200")
    @Min(value = 0, message = "age最小为0")
    private Integer age;
}

Controller 接口 + 参数前加 @Validated

/**
 * valid 测试 get params
 *
 * @param person
 * @return
 */
@GetMapping("valid")
public Result validParam(@Valid PersonDO person) {
    System.out.println(person);
    return new Result<>(person);
}

/**
 * validParam 测试 post {params, form-data, x-www-form-urlencoded}
 * @param person
 * @return
 */
@PostMapping("validParam")
public Result validPostParam(@Valid PersonDO person) {
    System.out.println(person);

    return new Result<>(person);
}

/**
 * validBody 测试 post raw application/json
 * @param person
 * @return
 */
@PostMapping("validBody")
public Result validPostBodyParam(@Valid @RequestBody PersonDO person) {
    System.out.println(person);
    return new Result<>(person);
}

@ControllerAdvice

@ExceptionHandler(BindException.class)
@ResponseBody
public Result<?> handleFieldNotValidException(BindException ex) {

    BindingResult bindingResult = ex.getBindingResult();

    return handleBindingResult(bindingResult, ex.getMessage());
}

/**
 * 通过requestBody提交参数
 * 标识 @Valid 注解验证时抛出异常 MethodArgumentNotValidException 
 * @param ex
 * @return
 */
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public Result<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
    BindingResult bindingResult = ex.getBindingResult();

    return handleBindingResult(bindingResult, ex.getMessage());
}


/**
 * 处理参数绑定结果
 *
 * @param bindingResult
 * @param errorMsg
 * @return
 */
private Result handleBindingResult(BindingResult bindingResult, String errorMsg) {
    if (bindingResult.hasErrors()) {
        List<ObjectError> objectErrors = bindingResult.getAllErrors();

        if (CollectionUtils.isEmpty(objectErrors)) {
            return new Result<>(EErrorCode.BAD_REQUEST, errorMsg);
        }

        StringBuilder sb = new StringBuilder();
        for (ObjectError objectError : objectErrors) {
            if (sb.length() > 0) {
                sb.append(";");
            }
            sb.append(objectError.getDefaultMessage());
        }

        return new Result<>(EErrorCode.BAD_REQUEST, sb.toString());

    }
    return new Result<>(EErrorCode.BAD_REQUEST, errorMsg);
}

@Validated 使用

Bean
同上
Controller 接口 + 参数前加 @Validated

/**
 *  validated 测试 get params
 *
 * @param person
 * @return
 */
@GetMapping("validated")
public Result validatedParam(@Validated PersonDO person) {
    System.out.println(person);
    return new Result<>(person);
}

/**
 * validatedParam 测试 post {params, form-data, x-www-form-urlencoded}
 * @param person
 * @return
 */
@PostMapping("validatedParam")
public Result validatedPostParam(@Validated PersonDO person) {
    System.out.println(person);

    return new Result<>(person);
}

/**
 * validatedBody post raw application/json
 * @param person
 * @return
 */
@PostMapping("validatedBody")
public Result validatedPostBodyParam(@Validated @RequestBody PersonDO person) {
    System.out.println(person);
    return new Result<>(person);
}

@ControllerAdvice

@ExceptionHandler(BindException.class)
@ResponseBody
public Result<?> handleFieldNotValidException(BindException ex) {

    BindingResult bindingResult = ex.getBindingResult();
    if (bindingResult.hasErrors()){
        List<ObjectError> objectErrors = bindingResult.getAllErrors();

        if (CollectionUtils.isEmpty(objectErrors)) {
            return new Result<>(EErrorCode.BAD_REQUEST, ex.getMessage());
        }

        StringBuilder sb = new StringBuilder();
        for (ObjectError objectError : objectErrors) {
            if (sb.length() > 0) {
                sb.append(";");
            }
            sb.append(objectError.getDefaultMessage());
        }

        return new Result<>(EErrorCode.BAD_REQUEST, sb.toString());

    }
    return new Result<>(EErrorCode.BAD_REQUEST, ex.getMessage());
}

模拟请求

// 结果
{
    "code": 400,
    "msg": "请求信息错误",
    "data": "name长度应为1-50字符;age最大200"
}

嵌套验证

Bean更改

@Data
public class PersonDO {
    @Size(min = 1, max = 50, message = "name长度应为1-50字符")
    private String name;

    @Max(value = 200, message = "age最大200")
    @Min(value = 0, message = "age最小为0")
    private Integer age;

	@NotNull(message ="list不能为空")
    @Size(min = 1,message = "至少一件")
    private List<Achievements> list;
}

@Data
public class Achievements {

    @NotNull
    @Length(min = 2)
    private String detail;
}

-Controller

    @PostMapping("nestValidBody")
    public Result nestValidBody(@Valid @RequestBody PersonDO person) {
        System.out.println(person);
        return new Result<>(person);
    }


    // ******** Validated

    @PostMapping("nestValidatedBody")
    public Result nestValidatedBody(@Validated @RequestBody PersonDO person) {
        System.out.println(person);
        return new Result<>(person);
    }

Result

验证直属属性

{
    "code": 400,
    "msg": "请求信息错误",
    "data": "age最大200;name长度应为1-50字符;list不能为空"
}

验证直属属性+嵌套属性

// 加@Valid能加在成员属性（字段）上之后
	@Valid
	@NotNull(message ="list不能为空")
    @Size(min = 1,message = "至少一件")
    private List<Achievements> list;

{
    "code": 400,
    "msg": "请求信息错误",
    "data": "age最大200;长度需要在2和2147483647之间;name长度应为1-50字符"
}

Reference

https://www.cnblogs.com/javastack/p/10297550.html

耘田

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录