导入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

JSR-303

这里只列举了 javax.validation 包下的注解,同理在 spring-boot-starter-web 包中也存在 hibernate-validator 验证包,里面包含了一些 javax.validation 没有的注解.

注解说明
@NotNull限制必须不为null
@NotEmpty验证注解的元素值不为 null 且不为空(字符串长度不为0、集合大小不为0)
@NotBlank验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Pattern(value)限制必须符合指定的正则表达式
@Size(max,min)限制字符长度必须在 min 到 max 之间(也可以用在集合上)
@Email验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
@Max(value)限制必须为一个不大于指定值的数字
@Min(value)限制必须为一个不小于指定值的数字
@DecimalMax(value)限制必须为一个不大于指定值的数字
@DecimalMin(value)限制必须为一个不小于指定值的数字
@Null限制只能为null(很少用)
@AssertFalse限制必须为false (很少用)
@AssertTrue限制必须为true (很少用)
@Past限制必须是一个过去的日期
@Future限制必须是一个将来的日期
@Digits(integer,fraction)限制必须为一个小数,且整数部分的位数不能超过 integer,小数部分的位数不能超过 fraction (很少用)
@CreditCardNumber信用卡号进行一个大致的验证
@Length(min,max)检查字段的长度是否在min和max之间,只限于字符串
@URL(protocol,host,port检查是否为一个有效的URL,如果提供了protocol,host等,则该URL满足条件

hibernate-validator

other

注解介绍

  • @Validated: 开启数据有效性校验,添加在类上即为验证方法,添加在方法参数中即为验证参数对象。(添加在方法上无效)
  • @NotBlank: 被注释的字符串不允许为空(value.trim() > 0 ? true : false)
  • @Length: 被注释的字符串的大小必须在指定的范围内
  • @NotNull: 被注释的字段不允许为空(value != null ? true : false)
  • @DecimalMin: 被注释的字段必须大于或等于指定的数值

自定义校验

注解

@Target({FIELD, PARAMETER})
@Retention(RUNTIME)
@Constraint(validatedBy = DateTimeValidator.class)
public @interface DateTime {

    String message() default "格式错误";

    String format() default "yyyy-MM-dd";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

校验器

定义校验器类 DateTimeValidator 实现 ConstraintValidator 接口,实现接口后需要实现它里面的 initialize: 与 isValid: 方法。

  • initialize: 主要用于初始化,它可以获得当前注解的所有属性
  • isValid: 进行约束验证的主体方法,其中 value 就是验证参数的具体实例,context 代表约束执行的上下文环境。

这里的验证方式虽然简单,但职责明确;为空验证可以使用 @NotBlank@NotNull@NotEmpty 等注解来进行控制,而不是在一个注解中做各种各样的规则判断,应该职责分离

public class DateTimeValidator implements ConstraintValidator<DateTime, String> {

    private DateTime dateTime;

    @Override
    public void initialize(DateTime dateTime) {
        this.dateTime = dateTime;
    }

    /**
     *  如果 value 为空则不进行格式验证,为空验证可以使用 @NotBlank
     *   @NotNull @NotEmpty 等注解来进行控制,职责分离
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {

        if (value == null) {
            return true;
        }
        String format = dateTime.format();
        if (value.length() != format.length()) {
            return false;
        }
        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(format);
        try {
            simpleDateFormat.parse(value);
        } catch (ParseException e) {
            return false;
        }
        return true;
    }
}
Copyright © wswzms.top 2019 all right reserved,powered by Gitbook该文件修订时间: 2019-04-17 18:26:31

results matching ""

    No results matching ""