@Pattern 正则表达式验证

该注解是用于验证字符串格式的注解之一。它用于验证一个字符串是否符合指定的正则表达式模式。

@Pattern 注解可以用于验证 String 类型的属性或字段，确保其值符合指定的正则表达式模式。

注意，注解接受 CharSequence，null 元素被视为有效。

@Pattern 注解的源码如下：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = { })
public @interface Pattern {
    // 匹配的正则表达式
    String regexp();
    
    // 解析正则表达式时考虑的标记（Flag）数组
    Flag[] flags() default { };
    String message() default "{javax.validation.constraints.Pattern.message}";
    Class<?>[] groups() default { };
    Class<? extends Payload>[] payload() default { };
    
    /**
     * 可能使用的 Regexp 标志
     */
    public static enum Flag {
    
        /**
         * 启用 Unix 行模式。
         *
         * @see java.util.regex.Pattern#UNIX_LINES
         */
        UNIX_LINES( java.util.regex.Pattern.UNIX_LINES ),
        
        /**
         * 启用不区分大小写的匹配。
         *
         * @see java.util.regex.Pattern#CASE_INSENSITIVE
         */
        CASE_INSENSITIVE( java.util.regex.Pattern.CASE_INSENSITIVE ),
        
        /**
         * 允许在模式中使用空白和注释。
         *
         * @see java.util.regex.Pattern#COMMENTS
         */
        COMMENTS( java.util.regex.Pattern.COMMENTS ),
        
        /**
         * 启用多行模式。
         *
         * @see java.util.regex.Pattern#MULTILINE
         */
        MULTILINE( java.util.regex.Pattern.MULTILINE ),
        
        /**
         * 启用 dotall 模式。
         *
         * @see java.util.regex.Pattern#DOTALL
         */
        DOTALL( java.util.regex.Pattern.DOTALL ),
        
        /**
         * 启用 Unicode 识别的大小写折叠。
         *
         * @see java.util.regex.Pattern#UNICODE_CASE
         */
        UNICODE_CASE( java.util.regex.Pattern.UNICODE_CASE ),
        
        /**
         * 启用规范等价
         *
         * @see java.util.regex.Pattern#CANON_EQ
         */
        CANON_EQ( java.util.regex.Pattern.CANON_EQ );
        
        // JDK flag value
        private final int value;
        
        private Flag(int value) {
            this.value = value;
        }
        
        /**
         * @return java.util.regex.Pattern 中定义的标志值。
         */
        public int getValue() {
            return value;
        }
    }
    
    /**
     * 在同一元素上定义多个 @Pattern 注释。
     * @see Pattern
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })
    @Retention(RUNTIME)
    @Documented
    @interface List {
        Pattern[] value();
    }
}

注意：message、groups、payload 属性用法参考 @NotNull 注解。

java 广告位

示例：

package com.hxstrive.validation;

import lombok.Builder;
import lombok.Data;
import org.hibernate.validator.HibernateValidator;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import javax.validation.constraints.Pattern;
import java.util.Set;

/**
 * 验证 String 对象是否符合正则表达式的规则
 * @author HuangXin
 * @since 1.0.0  2024/1/10 9:13
 */
@Data
@Builder
public class PatternDemo {

   @Pattern(regexp = "\\d{2}\\-\\d{2}\\-\\d{2}", message = "日期格式不正确")
   private String date;

   public static void main(String[] args) {
       PatternDemo.builder().date(null).build().validator("case1"); // OK
       PatternDemo.builder().date("24-01-11").build().validator("case2"); // OK
       PatternDemo.builder().date("2024-01-11").build().validator("case3"); // Fail
       PatternDemo.builder().date("2024-01-11 ").build().validator("case4"); // Fail
   }

   private void validator(String caseName) {
       validator(caseName, this);
   }

   private <T> void validator(String caseName, T obj) {
       // 手动调用 API 对定义了注解的字段进行校验
       Validator validator = Validation.byProvider(HibernateValidator.class).configure()
               .failFast(true).buildValidatorFactory().getValidator();
       Set<ConstraintViolation<T>> set = validator.validate(obj);
       if (set.size() > 0) {
           // 校验失败
           System.out.println(caseName + " :: Fail :: " + set.iterator().next().getMessage());
       } else {
           // 校验通过
           System.out.println(caseName + " :: Succeed");
       }
   }

}

运行示例，输出如下：

case1 :: Succeed
case2 :: Succeed
case3 :: Fail :: 日期格式不正确
case4 :: Fail :: 日期格式不正确