SpringBoot基础教程2-1-8 数据验证-自定义日期格式验证

时间 2019-11-10

标签 springboot 基础教程数据验证自定义日期格式栏目 Spring 繁體版

原文原文链接

1 概述

javax.validation包与hibernate-validator包中注解能知足大部分需求，可是仍是有必要熟悉下自定义数据验证注解，如日期格式验证。java

2 添加依赖

<dependencies>
        <!-- 惟一须要依赖，默认就内嵌了Tomcat容器，如须要更换容器Jetty、Undertow也极其简单-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--该依赖只会在编译时调用-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>

3 自定义注解

定义一个@DateTime注解git

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

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

    String format() default "yyyyMM";

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

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

@Constraint，指定校验类
message，失败提示信息
groups，分组验证（后面介绍）
payload，不知道，欢迎留言探讨

4 实现具体验证类

public class DateTimeValidator implements ConstraintValidator<DateTime, String> {
    private DateTime dateTime;

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

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 若是 value 为空则不进行格式验证，为空验证能够使用 @NotBlank @NotNull @NotEmpty 等注解来进行控制，职责分离
        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 (Exception e){
            return false;
        }
        return true;
    }
}

实现ConstraintValidator接口，定义initialize和isValid方法。github

initialize，主要用于初始化，它能够得到当前注解的全部属性
isValid，进行约束验证的主体方法，其中 value 就是验证参数的具体实例，context 表明约束执行的上下文环境。

5 实体类

@Data
public class User {

    @NotNull(message = "名字不能为空")
    @Length(min = 4, max = 10, message = "name 长度必须在 {min} - {max} 之间")
    private String name;

    @NotNull(message = "生日不能为空")
    @DateTime(format = "yyyyMMdd", message = "格式错误，正确格式为：yyyyMMdd")
    private String birthday;
}

6 控制层

@RestController
public class UserController {

    @PostMapping("/user")
    public R addUser(@Validated @RequestBody User user, BindingResult br) {

        if (br.hasErrors()) {
            return R.isFail().msg(br.getFieldError().getDefaultMessage());
        } else {

            return R.isOk().data(user);
        }
    }
}