Java 怎么编写自定义注解校验字符串长度是否合规

陌婷吖_6374

陌婷吖_6374

2026-09-08

158人浏览

原创

java中可通过自定义注解@stringlength结合constraintvalidator实现字符串长度校验,需定义注解(声明作用范围、保留策略、min/max默认值)并实现校验逻辑,在实体类字段上使用。

java 怎么编写自定义注解校验字符串长度是否合规

Java 中可以通过自定义注解 + ConstraintValidator 实现字符串长度校验,核心是定义注解、实现校验逻辑、并在实体类字段上使用。

定义自定义注解 @StringLength

注解需声明作用范围(如字段)、保留策略(运行时可用),并指定最小和最大长度,默认值可设为 0 和 Integer.MAX_VALUE,便于灵活使用:

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = StringLengthValidator.class)
public @interface StringLength {
    String message() default "字符串长度不合法";
    int min() default 0;
    int max() default Integer.MAX_VALUE;
    Class>[] groups() default {};
    Class extends Payload>[] payload() default {};
}

实现 ConstraintValidator 接口

创建校验器类,泛型指定为 StringLength 和 String,重写 isValid 方法,对 null 值按需处理(通常允许 null,仅校验非 null 字符串):

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
public class StringLengthValidator implements ConstraintValidator<stringlength string> {
    private int min;
    private int max;

    @Override
    public void initialize(StringLength constraintAnnotation) {
        this.min = constraintAnnotation.min();
        this.max = constraintAnnotation.max();
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 或 return false,根据业务决定是否允许 null
        }
        int len = value.length();
        if (len  max) {
            // 可选:自定义错误信息
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate(context.getDefaultConstraintMessageTemplate())
                   .addConstraintViolation();
            return false;
        }
        return true;
    }
}</stringlength>

在实体类中使用注解

直接加在 String 类型字段上,支持单独设 min/max,也支持只设其一(如只要求不超过 20 字符):

public class User {
    @StringLength(min = 2, max = 10, message = "用户名长度必须在 2~10 个字符之间")
    private String username;

    @StringLength(max = 20)
    private String email;

    // getter/setter...
}

触发校验(如 Spring Boot 场景)

Controller 方法参数添加 @Valid,配合 @RequestBody 或表单对象即可自动触发校验;校验失败会抛出 MethodArgumentNotValidException,建议统一异常处理返回友好提示:

@PostMapping("/user")
public Result createUser(@Valid @RequestBody User user) {
    return Result.success(userService.save(user));
}

不复杂但容易忽略细节:确保项目引入了 spring-boot-starter-validation(Spring Boot 2.3+ 默认不包含,需显式添加);自定义注解类和校验器类要在 Spring 扫描路径下;message 支持 EL 表达式(如 message = "长度应在 {min} 到 {max} 之间")。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9997

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7142

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6292

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1084

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

908

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1316

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2629

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19951

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1175

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习