使用@Valid或@Validated+BindingResult进行controller参数校验,或仅使用@Valid或@Validated进行controller参数校验的区别。

港控/mmm° 2023-10-10 15:03 107阅读 0赞

这篇文章主要介绍了关于BindingResult的使用总结及注意事项,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

BindingResult总结及注意事项

记一个简单又好用的API:BindingResult

BindingResult使用起来很简单,一般在controller中使用

作用:用于对前端穿进来的参数进行校验,省去了大量的逻辑判断操作

使用方法一:@Valid或@Validated+BindingResult进行controller参数校验

效果就是:在controller中的某个方法添加了这个注解和参数后,可以去效验前端传参,也就是在实体类的参数中去加入一些注解去做一些简单的判断,比如是否为空,不能为空,等。简化开发

先上实体类代码:加了一些判断:

  1. public class ApplyUserInfo extends BaseEntity
  2. {
  3. private static final long serialVersionUID = 1L;
  4. /** 申请人姓名 */
  5. @Excel(name = "用户姓名")
  6. @NotEmpty(message = "用户姓名不能为空")
  7. private String applicantName;
  8. /** 申请人性别,0:女士,1:先生 */
  9. @Excel(name = "用户性别", readConverterExp = "0=女士,1=先生")
  10. @NotNull(message = "用户性别不能为空")
  11. private Integer applicantGender;
  12. /** 医院名称 */
  13. @Excel(name = "医院名称")
  14. @NotEmpty(message = "医院名称不能为空")
  15. private String hospitalName;
  16. }

用法:controller代码:

  1. public AjaxResult save(@Validated @RequestBody ApplyUserInfo applyUserInfo, BindingResult bindingResult){
  2. if(bindingResult.hasErrors()) {
  3. String errorMsg = bindingResult.getFieldError().getDefaultMessage();
  4. return AjaxResult.error(errorMsg);
  5. }
  6. }

结果:

  1. 2018-05-09 00:59:37.453 INFO 14044 --- [ main] c.i.s.d.web.controller.AnimalController : password:may not be empty

方法一,二的区别:

里面哪一块是因为加了BindingResult,它的作用就是可以把异常封装起来再返回给前端,

如果不加BindingResult,也就是直接把异常抛给前端,效果差不多,都是效验作用。

使用方法二:@Valid或@Validated

实体类代码和上面一样

用法:controller代码:

  1. public AjaxResult save(@Validated @RequestBody ApplyUserInfo applyUserInfo){
  2. }

结果:

  1. java.lang.AssertionError: Status
  2. Expected :200
  3. Actual :400
  4. <Click to see difference>
  5. at org.springframework.test.util.AssertionErrors.fail(AssertionErrors.java:54)
  6. at org.springframework.test.util.AssertionErrors.assertEquals(AssertionErrors.java:81)

相关的校验API

空检查

@NotEmpty:用在集合类上面;不能为null,而且长度必须大于0
@NotBlank:用在String上面;只能作用在String上,不能为null,而且调用trim()后,长度必须大于0
@NotNull:用在基本类型上;不能为null,但可以为empty。
长度检查

@Size(min=,max=):验证对象(Array,Collection,Map,String)长度是否在给定的范围之内 不要错用了异常类型,比如在int上不可用@size
@Length(min=, max=):只适用于String 类型
Booelan检查

@AssertTrue:验证 Boolean 对象是否为 true
@AssertFalse:验证 Boolean 对象是否为 false
日期检查

@Past:验证 Date 和 Calendar 对象是否在当前时间之前
@Future:验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern:验证 String 对象是否符合正则表达式的规则
其他验证

@Vaild 递归验证,用于对象、数组和集合,会对对象的元素、数组的元素进行一一校验
@Email 用于验证一个字符串是否是一个合法的右键地址,空字符串或null算验证通过
@URL(protocol=,host=,port=,regexp=,flags=) 用于校验一个字符串是否是合法URL
数值检查

建议使用在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指定小数精度。
项目使用中遇到的问题

一开始传入的参数没有使用@Validated 修饰,结果绑定不起作用,参数校验不成功,加上此注解即可生效。所以BingdingResult是要与@Validated同时使用的。

发表评论

表情:
评论列表 (有 0 条评论,107人围观)

还没有评论,来说两句吧...

相关阅读