深入了解数据校验：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validation 6.x使用案例【享学Java】

public String queryValueByKey(String parmTemplateCode, String conditionName, String conditionKey, String resultName) {
    checkNotNull(parmTemplateCode, "parmTemplateCode not null");
    checkNotNull(conditionName, "conditionName not null");
    checkNotNull(conditionKey, "conditionKey not null");
    checkNotNull(resultName, "resultName not null");
    ...
}

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <!-- <version>1.1.0.Final</version> -->
    <version>2.0.1.Final</version>
</dependency>

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

@Getter
@Setter
@ToString
public class Person {

	// 错误消息message是可以自定义的
	@NotNull(message = "名字不能为null")
    public String name;
    @Positive
    public Integer age;

    @NotNull
    @NotEmpty
    private List<@Email String> emails;
    @Future
    private Date start;

}

    public static void main(String[] args) {
        Person person = new Person();
        //person.setName("fsx");
        person.setAge(-1);
        // email校验：虽然是List都可以校验哦
        person.setEmails(Arrays.asList("fsx@gmail.com", "baidu@baidu.com", "aaa.com"));
        //person.setStart(new Date()); //start 需要是一个将来的时间: Sun Jul 21 10:45:03 CST 2019
        //person.setStart(new Date(System.currentTimeMillis() + 10000)); //校验通过

        // 对person进行校验然后拿到结果（显然使用时默认的校验器）   会保留下校验失败的消息
        Set<ConstraintViolation<Person>> result = Validation.buildDefaultValidatorFactory().getValidator().validate(person);
        // 对结果进行遍历输出
        result.stream().map(v -> v.getPropertyPath() + " " + v.getMessage() + ": " + v.getInvalidValue())
                .forEach(System.out::println);
    }

Caused by: java.lang.ClassNotFoundException: javax.el.ELManager
	at java.net.URLClassLoader.findClass(URLClassLoader.java:382)
...

<!-- 注意这里导入的是Apr, 2013发布的el3.x的版本，但是glassfish-web并没有对此版本进行支持了  当然tomcat肯定是支持的 -->
<dependency>
    <groupId>javax.el</groupId>
    <artifactId>javax.el-api</artifactId>
    <version>3.0.1-b06</version>
</dependency>
<!-- servlet容器大都对el有实现（支持jsp的都对此有实现），比如tomcat/glassfish等 -->
<dependency>
    <groupId>org.glassfish.web</groupId>
    <artifactId>javax.el</artifactId>
    <version>2.2.6</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.glassfish/javax.el -->
<dependency>
    <groupId>org.glassfish</groupId>
    <artifactId>javax.el</artifactId>
    <version>3.0.1-b11</version>
</dependency>

<!-- 嵌入式的tomcat -->
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-el</artifactId>
    <version>9.0.22</version>
</dependency>
<!-- 传统的tomcat（需要注意的是：传统的tomcat这种jar是不需要你手动导入的，tomcat自带的） -->
<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-jasper-el</artifactId>
    <version>9.0.22</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.17.Final</version>
</dependency>
<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-el</artifactId>
    <version>9.0.22</version>
</dependency>

name名字不能为null: null //  此处错误消息是自己的自定义内容
age必须是正数: -1
emails[2].<list element>不是一个合法的电子邮件地址: aaa.com

Configuration configuration = Validation.byDefaultProvider()
        .providerResolver(new MyResolverStrategy()) // 自定义一个ValidationProviderResolver的实现类
        .configure();
ValidatorFactory factory = configuration.buildValidatorFactory();

HibernateValidatorConfiguration configuration = Validation.byProvider(HibernateValidator.class)
        // .providerResolver( ... ) // 因为制定了Provider，这个参数就可选了
        .configure()
        .failFast(false);
ValidatorFactory validatorFactory = configuration.buildValidatorFactory();

public class Validation {

	// 方式一
	public static ValidatorFactory buildDefaultValidatorFactory() {
		return byDefaultProvider().configure().buildValidatorFactory();
	}
	// 方式二
	public static GenericBootstrap byDefaultProvider() {
		return new GenericBootstrapImpl();
	}
	// 方式三
	public static <T extends Configuration<T>, U extends ValidationProvider<T>> ProviderSpecificBootstrap<T> byProvider(Class<U> providerType) {
		return new ProviderSpecificBootstrapImpl<>( providerType );
	}
	...
}

public interface Configuration<T extends Configuration<T>> {
	// 该方法调用后就不会再去找META-INF/validation.xml了
	T ignoreXmlConfiguration();
	// 消息内插器  它是个狠角色，关于它的使用场景，后续会有详解（包括Spring都实现了它来做事）
	// 它的作用是：插入给定的约束冲突消息
	T messageInterpolator(MessageInterpolator interpolator);
	// 确定bean验证提供程序是否可以访问属性的协定。对每个正在验证或级联的属性调用此约定。（Spring木有实现它）
	// 对每个正在验证或级联的属性都会调用此约定
	// Traversable： 可移动的
	T traversableResolver(TraversableResolver resolver);
	// 创建ConstraintValidator的工厂
	// ConstraintValidator：定义逻辑以验证给定对象类型T的给定约束A。(A是个注解类型)
	T constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory);
	// ParameterNameProvider：提供Constructor/Method的方法名们
	T parameterNameProvider(ParameterNameProvider parameterNameProvider);
	// java.time.Clock 用作判定@Future和@Past（默认取值当前时间）
	// 若你希望他是个逻辑实现，提供一个它即可
	// @since 2.0
	T clockProvider(ClockProvider clockProvider);
	// 值提取器。这是add哦~ 负责从Optional、List等这种容器里提取值~
	// @since 2.0
	T addValueExtractor(ValueExtractor<?> extractor);
	// 加载xml文件
	T addMapping(InputStream stream);
	// 添加特定的属性给Provider用的。此属性等效于XML配置属性。
	// 此方法通常是框架自己分析xml文件得到属性值然后放进去，调用者一般不使用（当然也可以用）
	T addProperty(String name, String value);
	
	// 下面都是get方法喽
	MessageInterpolator getDefaultMessageInterpolator();
	TraversableResolver getDefaultTraversableResolver();
	ConstraintValidatorFactory getDefaultConstraintValidatorFactory();
	ParameterNameProvider getDefaultParameterNameProvider();
	ClockProvider getDefaultClockProvider();
	BootstrapConfiguration getBootstrapConfiguration(); // 整个配置也可返回出去

	// 上面都是工作，这个方法才是最终需要调用的：得到一个ValidatorFactory
	ValidatorFactory buildValidatorFactory();
}

public interface HibernateValidatorConfiguration extends Configuration<HibernateValidatorConfiguration> {

	// 这批属性，证明直接可以通过System属性值来控制，大大地方便~
	// 这个机制快速失败机制：true检查完一个有错误就返回，false全部检查完把错误消息一起返回   默认false
	String FAIL_FAST = "hibernate.validator.fail_fast"; 
	String ALLOW_PARAMETER_CONSTRAINT_OVERRIDE = "hibernate.validator.allow_parameter_constraint_override";
	String ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RESULT = "hibernate.validator.allow_multiple_cascaded_validation_on_result";
	String ALLOW_PARALLEL_METHODS_DEFINE_PARAMETER_CONSTRAINTS = "hibernate.validator.allow_parallel_method_parameter_constraint";
	// @since 5.2
	@Deprecated
	String CONSTRAINT_MAPPING_CONTRIBUTOR = "hibernate.validator.constraint_mapping_contributor";
	// @since 5.3
	String CONSTRAINT_MAPPING_CONTRIBUTORS = "hibernate.validator.constraint_mapping_contributors";
	// @since 6.0.3
	String ENABLE_TRAVERSABLE_RESOLVER_RESULT_CACHE = "hibernate.validator.enable_traversable_resolver_result_cache";
	// @since 6.0.3  ScriptEvaluatorFactory：执行脚本
	@Incubating
	String SCRIPT_EVALUATOR_FACTORY_CLASSNAME = "hibernate.validator.script_evaluator_factory";
	// @since 6.0.5 comparing date/time in temporal constraints. In milliseconds.
	@Incubating
	String TEMPORAL_VALIDATION_TOLERANCE = "hibernate.validator.temporal_validation_tolerance";

	// ResourceBundleMessageInterpolator用于 load resource bundles
	ResourceBundleLocator getDefaultResourceBundleLocator();
	// 创建一个ConstraintMapping：通过编程API配置的约束映射
	// 设置映射后，必须通过addMapping（constraintmapping）将其添加到此配置中。
	ConstraintMapping createConstraintMapping();
	// 拿到所有的值提取器  @since 6.0
	@Incubating
	Set<ValueExtractor<?>> getDefaultValueExtractors();

	// 往下就开始配置了~~~~~~~~~~
	HibernateValidatorConfiguration addMapping(ConstraintMapping mapping);
	HibernateValidatorConfiguration failFast(boolean failFast);
	// used for loading user-provided resources:
	HibernateValidatorConfiguration externalClassLoader(ClassLoader externalClassLoader);
	// true：表示允许覆盖约束的方法。false表示不予许（抛出异常）  默认值是false
	HibernateValidatorConfiguration allowOverridingMethodAlterParameterConstraint(boolean allow);
	// 定义是否允许对返回值标记多个约束以进行级联验证。  默认是false
	HibernateValidatorConfiguration allowMultipleCascadedValidationOnReturnValues(boolean allow);
	// 定义约束的**并行方法**是否应引发ConstraintDefinitionException
	HibernateValidatorConfiguration allowParallelMethodsDefineParameterConstraints(boolean allow);
	// 是否允许缓存TraversableResolver  默认值是true
	HibernateValidatorConfiguration enableTraversableResolverResultCache(boolean enabled);
	// 设置一个脚本执行器
	@Incubating
	HibernateValidatorConfiguration scriptEvaluatorFactory(ScriptEvaluatorFactory scriptEvaluatorFactory);
	// 允许在时间约束中比较日期/时间时设置可接受的误差范围
	// 比如@Past @PastOrPresent @Future @FutureOrPresent
	@Incubating
	HibernateValidatorConfiguration temporalValidationTolerance(Duration temporalValidationTolerance);
	// 允许设置将传递给约束验证器的有效负载。如果多次调用该方法，则只传播最后传递的有效负载。
	@Incubating
	HibernateValidatorConfiguration constraintValidatorPayload(Object constraintValidatorPayload);
}