2021-10-13 关于参数校验及@Valid和@RequestBody注解的组合使用

  • Post author:
  • Post category:其他


一、前言:学会并熟悉注解的使用,在开发过程中,是可以提高效率和简化工作复杂程度的,也是会逐渐称为主要编码方式之一。

二、

1、@RequestBody注解:

该注解在处理控制层的请求方法的参数列表中,作用于参数上;他可以将请求主体中的参数绑定到一个对象中,这个对象一般是自定义的,请求的主体参数是通过HttpMessageConverter进行传递的,


其原理是:根据请求主体中的参数名与对象的属性(字段)名进行匹配绑定值。

下面是@RequestBody的使用示例(

一般与@Valid注解配合使用

):

2、

@Valid注解:

用于校验,对于前端传进来的参数进行判断检查。其使用方法如下:在自定义的类中的字段上(参数字段),加上校验条件注解,来充当判断的条件,如下图:

这里是一个自定义的用户类UserRegisterFrom,其中有三个字段,都是注册功能用需要用到的参数,

在参数上加上判断条件的注解,这里介绍16个:

①@NotBlank:表示该字段不能为空白(空格),只作用于String(字符串),并且调用trim()长度要大于零。该注解的message为当字段不符合这个条件时的报错信息,可以通过BindingResult类的相关方法进行获取,打印在控制台查看;

②@NotEmpty:用于集合类,检查集合是否为空,不能为null,且长度必须大于零。③@NotNull:判断是否为null,用于基本类型,可以为empty。④@Null:限制只能为null

⑤@AssertFalse  :限制必须为false

⑥@AssertTrue:限制必须为true

⑦@DecimalMax(value):限制必须为一个不大于指定值的数字

⑧@Max(value):限制必须为一个不大于指定值的数字

⑨@Min(value) :限制必须为一个不小于指定值的数字

⑩@DecimalMin(value):限制必须为一个不小于指定值的数字

(11)@Digits(integer,fraction):限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction

(12)@Future:限制必须是一个将来的日期

(13)@Pattern(value):限制必须符合指定的正则表达式

(14)@Size(max,min): 限制字符长度必须在min到max之间

(15)@Past:验证注解的元素值(日期类型)比当前时间早

(16)@Email:验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式


如何获取控制台信息:

在控制层方法中,传入BindingResult对象,调用其中的方法,打印错误信息时,建议使用@Slf4j,使用log.error打印,不推荐使用system.out.println。如图所示:

三、总结:@RequestBody一般与@Valid注解一起使用,在参数的校验上,是十分友好的。



版权声明:本文为weixin_51373750原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。