SpringBoot自定义校验注解校验日期时间格式字符串

最新推荐文章于 2025-04-22 20:40:47 发布

左边有只汪

最新推荐文章于 2025-04-22 20:40:47 发布

阅读量4k

点赞数 2

分类专栏： springboot

本文链接：https://blog.youkuaiyun.com/weixin_43744059/article/details/119416201

版权

springboot 专栏收录该内容

8 篇文章

订阅专栏

该博客介绍了如何在Java中自定义注解`DateTimeStr`进行日期时间字符串的格式校验，包括注解的定义、校验类的实现以及在实体类和Controller层的使用。通过注解`@DateTimeStr`，可以确保输入的日期时间字符串符合指定的格式，如'yyyy-MM-dd HH:mm:ss'。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

先定义一个注解

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = DateTimeStrValidator.class)
public @interface DateTimeStr {
 
    String message() default "format incorrect";
 
    String format() default "yyyy-MM-dd HH:mm:ss";
 
    Class<?>[] groups() default {};
 
    Class<? extends Payload>[] payload() default {};
}

编写校验类

package com.aerosatlink.serviceagent.config;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.text.SimpleDateFormat;

/**
 * 日期时间字符串校验器
 *
 * @author 杨君屹
 * @date 2021/08/05
 */
public class DateTimeStrValidator implements ConstraintValidator<DateTimeStr, String> {
    
    private DateTimeStr dateTimeStr;

    @Override
    public void initialize(DateTimeStr dateTimeStr) {
        this.dateTimeStr = dateTimeStr;
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        // 如果 value 为空则不进行格式验证，为空验证可以使用 @NotBlank @NotNull @NotEmpty 等注解来进行控制，职责分离
        if (value == null) {
            return true;
        }
        String format = dateTimeStr.format();

        if (value.length() != format.length()) {
            return false;
        }

        SimpleDateFormat simpleDateFormat = new SimpleDateFormat(format);

        try {
            simpleDateFormat.parse(value);
        } catch (Exception e){
            return false;
        }
        return true;
    }
}

在实体类上使用注解

    @DateTimeStr(message = "sessionBegin not satisfied with format yyyy-MM-dd HH:mm:ss ")
    private String sessionBegin;

在controller层接口位置使用@Valid注解,开启校验