Spring表单验证

1. 内置表单验证

1.1 Bean Validator内置的注解

Annotation	支持的数据类型	作用	Hibernate metadata impact
@AssertFalse	Boolean, boolean	判断关联属性是否为布尔值false	没有@AssertTrue
@DecimalMax	BigDecimal, BigInteger, String, byte, short, int,long and the respective wrappers of the primitive types. Additionally supported by HV: any sub-type of Number.	被注解的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.	没有
@DecimalMin	BigDecimal, BigInteger, String, byte, short, int,long and the respective wrappers of the primitive types. Additionally supported by HV: any sub-type of Number.	被注解的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.	没有
@Digits(integer=, fraction=)	BigDecimal, BigInteger, String, byte, short, int,long and the respective wrappers of the primitive types. Additionally supported by HV: any sub-type of Number.	校验整数位数和小数位数	对应的数据库表字段会被设置精度(precision)和准度(scale).
@Future	java.util.Date, java.util.Calendar; Additionally supported by HV, if the Joda Time date/time API is on the class path: any implementations of ReadablePartial and ReadableInstant.	检查给定的日期是否比现在晚.	没有
@Max	BigDecimal, BigInteger, byte, short, int, longand the respective wrappers of the primitive types. Additionally supported by HV: String(the numeric value represented by a String is evaluated), any sub-type of Number.	检查该值是否小于或等于约束条件中指定的最大值.	会给对应的数据库表字段添加一个check的约束条件.
@Min	BigDecimal, BigInteger, byte, short, int, longand the respective wrappers of the primitive types. Additionally supported by HV: String(the numeric value represented by a String is evaluated), any sub-type of Number.	检查该值是否大于或等于约束条件中规定的最小值.	会给对应的数据库表字段添加一个check的约束条件.
@NotNull	Any type	Checks that the annotated value is notnull.	对应的表字段不允许为null.
@Null	Any type	Checks that the annotated value is null.	没有
@Past	java.util.Date, java.util.Calendar; Additionally supported by HV, if the Joda Time date/time API is on the class path: any implementations of ReadablePartial and ReadableInstant.	检查注解对象中的值表示的日期比当前早.	没有
@Pattern(regex=, flag=)	String	检查该字符串是否能够在match指定的情况下被regex定义的正则表达式匹配.	没有
@Size(min=, max=)	String, Collection, Map and arrays	校验对象的size。本文作者认为前提是该对象有size()方法，String除外。	对应的数据库表字段的长度会被设置成约束中定义的最大值.
@Valid	Any non-primitive type	递归的对关联对象进行校验, 如果关联对象是个集合或者数组, 那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.	没有

1.2 Hibernate Validator拓展的注解

Annotation	支持的数据类型	作用	Hibernate metadata impact
@CreditCardNumber	String	校验信用卡号码	没有
@Email	String	校验邮件地址	没有
@Length(min=, max=)	String	功能同@Size，但是只支持String类型	对应的数据库表字段的长度会被设置成约束中定义的最大值.
@NotBlank	String	不为null，不为空值，不为全空格。功能强大于@NotEmpty	没有
@NotEmpty	String,Collection,Map and arrays	校验是否为null或者为空值。功能强于@NotNull	没有
@Range(min=, max=)	BigDecimal,BigInteger,String, byte,short, int,long and the respective wrappers of the primitive types	判断数值的范围，不仅支持数值类型，还支持字符串、字节等等类型	没有
@SafeHtml(whitelistType=, additionalTags=)	CharSequence	无使用价值	没有
@ScriptAssert(lang=, script=, alias=)	Any type	无使用价值	没有
@URL(protocol=, host=, port=, regexp=, flags=)	String	Checks if the annotated string is a valid URL according to RFC2396. If any of the optional parameters protocol, host or port are specified, the corresponding URL fragments must match the specified values. The optional parametersregexp and flags allow to specify an additional regular expression (including regular expression flags) which the URL must match.	没有

1.3. Validator框架拓展注解

Annotation	支持的数据类型	作用
@NotEmptyPattern	String	在字符串不为空的情况下，验证是否匹配正则表达式
@ListStringPattern	List	验证集合中的字符串是否满足正则表达式
@DateValidator	String	验证日期格式是否满足正则表达式，Local为ENGLISH
@DateFormatCheckPattern	String	验证日期格式是否满足正则表达式，Local为自己手动指定

---

参考：Hibernate-validator校验框架

---

2. 自定义表单验证

例如在新增人员时，需要判断身份证号是否重复，若重复则提示已存在。

Validator提供了6个校验接口供开发人员使用：

1. void validate(T object) throws Exception
   用途：校验一个对象的默认校验组的属性。
2. void validate(T object, Class<?>… groups) throws Exception
   用途：校验一个对象的指定的一个或多个校验组的属性。
3. void validateProperty(T object, String propertyName) throws Exception
   用途：校验一个对象的默认校验组的一个指定的属性值。
4. void validateProperty(T object, String propertyName, Class<?>… groups) throws Exception
   用途：校验一个对象指定校验组中的一个指定的属性值。
5. void validateValue(Class beanType, String propertyName, Object value) throws Exception
   用途：校验一个value是否符合指定类的默认校验组下的某一个属性值。
6. void validateValue(Class beanType, String propertyName, Object value, Class<?>… groups) throws Exception
   用途：校验一个value是否符合指定类的指定校验组下的某一个属性值。

2.1 定义验证

package com.snt.dms.validator;

import com.snt.dms.validator.impl.PersonNoExistsValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;


@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER,ElementType.FIELD})
@Constraint(validatedBy = PersonNoExistsValidator.class)
public @interface PersonNoExists {

    //提示内容
    String message() default "身份证号已存在";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

2.2 实现验证

package com.snt.dms.validator.impl;

import com.snt.dms.service.PersonService;
import com.snt.dms.validator.PersonNoExists;
import org.springframework.beans.factory.annotation.Autowired;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class PersonNoExistsValidator implements ConstraintValidator<PersonNoExists, String> {

    @Autowired
    PersonService personService;

    @Override
    public void initialize(PersonNoExists constraintAnnotation) {

    }

    @Override
    public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
        if (null == personService.getPersonIdByPersonNo(s)) {
            return true;
        }
        return false;
    }
}

2.3 使用验证

package com.snt.dms.web.vo;

import com.snt.dms.validator.PersonNoExists;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
import java.util.Date;

public class PersonVO {
    private Integer id;

    @NotBlank
    private String name;

    @NotBlank
    @PersonNoExists
    private String no;

    @Range(min = 1, max = 2, message = "请选择性别")
    private Byte gender;
}