Annotation Interface Alphanumeric

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE}) @Retention(RUNTIME) @Documented @Constraint(validatedBy=io.github.xezzon.zeroweb.common.validator.AlphanumericValidator.class) public @interface Alphanumeric

自定义校验注解，用于检查字符串是否仅包含字母、数字、下划线以及可选的其他字符。 默认情况下，允许大写字母 (A-Z)、小写字母 (a-z)、数字 (0-9)、下划线 (_)、短横线 (-) 和点 (.)。 可以通过 includes() 和 excludes() 属性来定制允许或禁止的字符集。

示例用法：

public class MyDto {
    @Alphanumeric(includes = {Alphanumeric.ASCII_UPPER_CASE, Alphanumeric.DIGIT})
    private String username;

    @Alphanumeric(excludes = {Alphanumeric.UNDERSCORE})
    private String tagName;
}
Author:
xezzon

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ASCII_LOWER_CASE
    小写字母 字符集范围：a-z。
    static final String
    ASCII_UPPER_CASE
    大写字母 字符集范围：A-Z。
    static final String
    DIGIT
    数字 字符集范围：0-9。
    static final String
    DOT
    特殊字符：点 `.`。
    static final String
    HYPHEN
    特殊字符：短横线 `-`。
    static final String
    UNDERSCORE
    特殊字符：下划线 `_`。

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    excludes
    指定校验不允许包含的字符集。
    Class<?>[]
    groups
    校验组，允许将约束注解应用于不同的验证场景。
    String[]
    includes
    指定校验允许包含的字符集。
    String
    message
    校验失败时返回的默认错误信息。
    Class<? extends jakarta.validation.Payload>[]
    payload
    负载信息，允许在校验失败时携带额外的信息。

  • Field Details

  • Element Details

    • includes

      String[] includes
      指定校验允许包含的字符集。 默认包含大写字母、小写字母、数字、下划线、短横线和点。
      Returns:
      允许包含的字符集数组。
      Default:
      {"A-Z", "a-z", "0-9", "_", "\\-", "\\."}

    • excludes

      String[] excludes
      指定校验不允许包含的字符集。 此属性优先级高于 includes()，即如果一个字符既在 includes 又在 excludes 中，则该字符将被排除。
      Returns:
      不允许包含的字符集数组。
      Default:
      {}

    • message

      String message
      校验失败时返回的默认错误信息。
      Returns:
      错误信息模板键。
      Default:
      "{io.github.xezzon.zeroweb.common.validator.Alphanumeric.message}"

    • groups

      Class<?>[] groups
      校验组，允许将约束注解应用于不同的验证场景。
      Returns:
      校验组数组。
      Default:
      {}

    • payload

      Class<? extends jakarta.validation.Payload>[] payload
      负载信息，允许在校验失败时携带额外的信息。
      Returns:
      负载类型数组。
      Default:
      {}