处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。在我们开发微服务的时候必须确保输入进来的数据是正确的有效的，符合我们业务逻辑的。
validation.annotation为 JavaBean 的验证提供了一套运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。
validation.annotation 常见的constraint
@Null 接收的参数对象必需为null,如果不为null,报错
@Notnull接收的参数不能为null,如果为null,报错
@Min 接收的参数值必需大于Min注解指定的值
@Max接收的参数值必需小于Max注解指定的值
@Size 接收的参数对象(String, List, map)的长度是否满足Max注解的约束条件，Size注解 可以 约束 最 小长度 和最大长度
@Past 接收的参数值必须小于当前系统的时间
@Future接收的参数值必须大于当前系统的时间
@AssertTrue 接收的参数值必须是 true
@AssertFalse接收的参数值必须 false
@Valid 级联验证,不仅 验证 当前注解的对象 ，还要验证当前注解对象的内嵌对象
验证逻辑的简单应用
1：先创建一个申明声明了 contraint 的 JavaBean
public class MBeanValidate {
@Min(1)
@Max(99)
@NotNull
private int id;
//Size: 做长度的判断，如果String的长度，map, list等集合的size大小
@NotNull
@Size(min = 3, max = 9)
private String description;
@Size(min = 3)
private List<Integer> arrData;
//must be null
@Null
private String remark;
public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public List<Integer> getArrData() {
return arrData;
}
public void setArrData(List<Integer> arrData) {
this.arrData = arrData;
}
public String getRemark() {
return remark;
}
public void setRemark(String remark) {
this.remark = remark;
}
}
2：在controller中创建请求接口，并添加启用数据验证的注解@validate
@PostMapping("/beanValidation")
public void doBeanValidation(@Validated @RequestBody MBeanValidate bean)
3：在postman中构造参数验证@Null, @Notnull, @Min,@Max,@Size的注解的功能
{
"id":1,
"description":"not null",
"arrData":["3","1","2","5","7","4","9","6"],
"remark":"not null"
}
image.png
参数校验失败，在返回信息的defaultMessage中提示，remark必须为null
再写个Case验证Min注解
{
"id":0,
"description":"nnnnnn",
"arrData":["3","1","2","5","7","4","9","6"],
"remark":null
}
image.png
在我们的注解中id最小是1，我们传入的id是0小于1，所以验证失败，defaultMessage中提示：“id值必须大于或等于1”
验证Size注解的case
{
"id":1,
"description":"n",
"arrData":["3","1","2","5","7","4","9","6"],
"remark":null
}
image.png
description字段我们要求的长度是最小3，最大9 而 传入的是n,长度为1。所以验证失败，同样在defaultMessage提示"size必须是3到9"
关于时间的注解@Past, @Future的验证
1：先创建一个申明声明了 contraint 的 JavaBean
public class MBeanDateValidate {
//必须之前的某一天
@Past
private Date sDate;
//必须是未来的某一天
@Future
private Date eDate;
public Date getsDate() {
return sDate;
}
public void setsDate(Date sDate) {
this.sDate = sDate;
}
public Date geteDate() {
return eDate;
}
public void seteDate(Date eDate) {
this.eDate = eDate;
}
2：在controller中创建请求接口，并添加启用数据验证的注解@validate
@PostMapping("/dateValidation")
public void doDateValidation(@Validated @RequestBody MBeanDateValidate bean)
3：在postman中构造参数验证@Past, @Future的注解的功能
{
"sDate":"2019-02-01",
"eDate":"2020-03-01"
}
image.png
在我们的测试结果中可以找到当前的时间2020.03.03,但我们输入的eDate是2020-03-01，因为这个字段添加了@Future注解了，所以在验证时就要去eDate必须大于当前时间。
验证@Past注解
{
"sDate":"2020-03-05",
"eDate":"2020-03-05"
}
image.png
在我们的测试结果中可以找到当前的时间2020.03.03,但我们输入的sDate是2020-03-01，因为这个字段添加了@Past注解，所以在验证时就要去sDate必须小于于当前时间。
@Valid注解的作用
前面我将的都是单个对象的注解校验，当实际项目中我们会出现很多的组合类，对象里面嵌套对象，那当我们需要对内外层对象同时做校验的时候，就可以使用@Valid注解。
1: 创建一个java Bean，然后再设置一个list的对象集合
public class MBeanValidValidate {
@AssertTrue
private boolean allRight;
@AssertFalse
private boolean notTrue;
@Valid
@Size(max = 2)
private List<MBeanDateValidate> objs;
public boolean isAllRight() {
return allRight;
}
public void setAllRight(boolean allRight) {
this.allRight = allRight;
}
public boolean isNotTrue() {
return notTrue;
}
public void setNotTrue(boolean notTrue) {
this.notTrue = notTrue;
}
public List<MBeanDateValidate> getObjs() {
return objs;
}
public void setObjs(List<MBeanDateValidate> objs) {
this.objs = objs;
}
}
2：创建验证@valid接口
@PostMapping("/validValidation")
public void doValidValidation(@Validated @RequestBody MBeanValidValidate bean)
3：在postman中构造参数验证@AssertTrue, @AssertFalse,@valid的注解的功能
{
"allRight":true,
"notTrue":false,
"objs":[
{
"sDate":"2020-03-05",
"eDate":"2020-03-05"
},
{
"sDate":"2020-03-05",
"eDate":"2020-03-05"
}]
}
image.png
虽然我们的allRight字段设置true, notTrue字段也设置成false,同时objs集合Size也满足了系统要求设置为2,但最后的校验依然没有通过，原因就是因为我们的objs里面的对象没有满足MBeanDateValidate对象的数据规则。
所以@valid注解会帮我们做级联验证
BindingResult
最后介绍的这个注解是BindingResult，前面我们再校验失败后返回给用户的数据太详细了，也太多了，有时间我们需要对返回值做一定的处理如隐藏一些细节，重新封装一下返回值，这时候就需要用到BindingResult类,使用也很简单，直接看代码：
@PostMapping("/bingResultValidation")
public String doBindingResultValidation(@Validated @RequestBody MBeanValidate bean, BindingResult result){
if (result.hasErrors()) {
return "参数校验失败！";
}
return "参数校通过";
}
测试结果：
image.png
这时候我们的返回值就变成了一串提示语。
在内部我们可以将详细的错误信息记录在log中，方便我们查问题，下面介绍一下通过BindingResult获取详细信息：
BindingResult result;
List<FieldError> fe = result.getFieldErrors();
fe.get(0).getField() ### 哪个字段没通过校验
fe.get(0).getObjectName() ## 哪个对象没通过校验'MBeanValidate'
fe.get(0).field() ## 字段的约束信息[Size.MBeanValidate.description,Size.description,Size.java.lang.String,Size
fe.get(0).resolvableToString(); ##详细信息default message [description],9,3]; default message [size mustbe between 3 and 9]
网友评论