Spring-web-Validated/Valid/ConstraintValidator

本文主要是介绍Spring-web-Validated/Valid/ConstraintValidator，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

笔记：刚刚看了这篇文章，第一次写还是在2015年，时间过的真提莫快，本次重新维护关于注解校验的代码，阐述JSR303规范，@validated注解，@valid注解，和ConstraintValidator接口

我们在spring mvc的controller中要想使用@Valid（JSR303）或者@Validated注解校验，则项目中必须存在JSR303的实现，hibernate-validator实现了JSR303，所以多数项目都使用该实现，当然了，你也可以自己实现，不过我相信你肯定没有hibernate-validator实现的好，它的maven如下

<dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId><version>6.0.13.Final</version>
</dependency>

@Valid或者@Validated的使用方式

假设有一个用户实体类User，如下，它表示name这个字段不允许为null或者空字符串""

import javax.validation.constraints.NotEmpty;public class User {@NotEmpty(message = "name必填")private String name;// 省略get set方法，但是我真的很讨厌lombok，打破封装并且无法写标准注释// 所以任何优秀的源码你是看不到lombok的，从来不用
}

下面的代码是一个controller，它表示前端传递过来的参数，name字段如果null或者空字符串""，就返回"name必填"，但是你也看出来了，这种方式是自己手动写代码在controller中处理，并且controller中多出一个"br"参数，代码看起来很冗余

import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class TestValidatorController {@GetMapping("test111")public String test111(@Valid User dto, BindingResult br) {if (br.hasErrors()) {return br.getAllErrors().get(0).getDefaultMessage();}return "OK";}
}

下面的代码是没有BindingResult br的代码，这种情况下，如果name为null或者空字符串""，则会抛异常，这个异常就是hibernate-validator抛出来的

@RestController
public class TestValidatorController {@GetMapping("test111")public String test111(@Valid User dto) {return "OK";// 如果dto.name为empty，代码不会走到这里，直接抛异常}
}

对于上述这个示例，我们应该统一定义一个异常解析器，来捕获hibernate-validator抛出来的异常，然后组织称合理的语言，返回给前端，至于异常解析器就不阐述了，可以查看关于注解方式的异常解析器，或者原生的接口方式异常解析器

ConstraintValidator接口
这是一个自定义校验的接口，全限定名为javax.validation.ConstraintValidator
下面的几段代码表达了这样一个需求：当前端传递字符串"抱抱"的时候，我认为这个名字非法，提示前端name不允许使用"抱抱"两个字

1.首先定义一个注解，这个注解标记到哪个字段，哪个字段就不可以用"抱抱"这两个字，注意代码中@Constraint注解的内容

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.validation.Constraint;@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = NotAllowBaoBaoImpl.class)// 注意这个注解
public @interface NotAllowBaoBao {String message() default "name不允许使用\"抱抱\"两个字";// 直接复制@NotEmpty注解的内容粘贴到这里，这个groups必须要有，否则spring处理会报错// 如了解该字段的话，后文会使用groups这个字段演示代码Class<?>[] groups() default {};// 直接复制@NotEmpty注解的内容粘贴到这里，这个payload必须要有，否则spring处理会报错Class<? extends Payload>[] payload() default {};// 这个List不是必须的，如果没有，spring处理起来也不会报错@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })@Retention(RUNTIME)@Documentedpublic @interface List {NotEmpty[] value();}
}

2.定义一个校验器，专门处理上面这个注解，这个校验器需要实现ConstraintValidator接口，这个类就是上述@Constraint中的类

public class NotAllowBaoBaoImpl implements ConstraintValidator<NotAllowBaoBao, Object> {@Overridepublic boolean isValid(Object value, ConstraintValidatorContext context) {// 对于本文，这个value就是User.name字段，如果为"抱抱"，就返回false，表示校验不通过return !"抱抱".equals(value);}
}

3.重新修改User类，变成如下这个样子

public class User {@NotAllowBaoBaoprivate String name;// 省略get set方法，依旧讨厌lombok
}

好了，此时调用controller，如果传递的参数是"抱抱"，则会报错，至此，ConstraintValidator接口介绍完毕

脱离Spring，独立使用hibernate-validator校验
下面的代码演示了如何使用hibernate-validator（JSR303的实现，切记）的API硬编码实现注解校验

public static void main(String[] aaa) {ValidatorFactory factory = Validation.buildDefaultValidatorFactory();Validator validator = factory.getValidator();User person = new User();Set<ConstraintViolation<User>> constraintViolations = validator.validate(person);for (ConstraintViolation<YearSceneUsersCondition> violation : constraintViolations) {// 打印错误信息System.out.println(violation.getMessage());}
}

关于groups字段
在实际开发当中，如果插入和修改使用同一个User类，有时候会遇到这种需求：插入操作的时候，name不能为空，但是修改的时候，name可以为空，这种情况我们需要如下改进

1.要写两个接口，一个表示插入，一个表示修改

public interface Add {// 这个接口表示插入
}
public interface Edit {// 这个接口表示修改
}

2.修改User类如下
注意：如果不行，就将@NotEmpty放到get方法上，在多年前，@NotEmpty是必须放到get方法上的

public class User {@NotEmpty(message = "插入操作name必填", groups = { Add.class })private String name;// 如果不行，就将@NotEmpty放到get方法上，在多年前，@NotEmpty是必须放到get方法上的
}

3.重新测试

public static void main(String[] aaa) {User person = new User();person.setName("二抱三抱");ValidatorFactory factory = Validation.buildDefaultValidatorFactory();Validator validator = factory.getValidator();//主要是这里发生了变化，这里告诉HibernateValidation是添加操作，还是修改操作Set<ConstraintViolation<User>> constraintViolations = validator.validate(person, Edit.class);//constraintViolations.size()不等于0，说明不通过System.out.println(constraintViolations.size());for (ConstraintViolation<User> c : constraintViolations) {//打印信息System.out.println(c.getMessage());}
}